Update a reward

curl --request PUT \
  --url https://api.voucherify.io/v2/loyalties/rewards/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>' \
  --data '
{
  "name": "<string>",
  "material": {
    "product": {
      "id": "<string>"
    },
    "sku": {
      "product_id": "<string>",
      "id": "<string>"
    }
  },
  "digital": {
    "discount_coupons": {
      "campaign_id": "<string>"
    },
    "gift_vouchers": {
      "campaign_id": "<string>",
      "balance": 1
    }
  },
  "metadata": {}
}
'

{
  "id": "<string>",
  "name": "<string>",
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "object": "<string>",
  "material": {
    "product": {
      "id": "<string>"
    },
    "sku": {
      "product_id": "<string>",
      "id": "<string>"
    }
  },
  "digital": {
    "discount_coupons": {
      "campaign_id": "<string>"
    },
    "gift_vouchers": {
      "campaign_id": "<string>",
      "balance": 1
    }
  }
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

Update a reward

⚠️ BETA endpoint

This is a work-in-progress documentation of a BETA endpoint. The parameters, fields, request and response bodies, and other data may subject to change. If you want to share feedback or improvements, contact Voucherify support or your Technical Account Manager.

Updates an existing reward. All properties are optional. In DRAFT status all properties can be updated. In ACTIVE or INACTIVE status only name and metadata are allowed. When changing type, the matching sub-configuration must be supplied and the previous one is reset to null.

PUT

loyalties

rewards

{id}

Update a reward

curl --request PUT \
  --url https://api.voucherify.io/v2/loyalties/rewards/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>' \
  --data '
{
  "name": "<string>",
  "material": {
    "product": {
      "id": "<string>"
    },
    "sku": {
      "product_id": "<string>",
      "id": "<string>"
    }
  },
  "digital": {
    "discount_coupons": {
      "campaign_id": "<string>"
    },
    "gift_vouchers": {
      "campaign_id": "<string>",
      "balance": 1
    }
  },
  "metadata": {}
}
'

{
  "id": "<string>",
  "name": "<string>",
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "object": "<string>",
  "material": {
    "product": {
      "id": "<string>"
    },
    "sku": {
      "product_id": "<string>",
      "id": "<string>"
    }
  },
  "digital": {
    "discount_coupons": {
      "campaign_id": "<string>"
    },
    "gift_vouchers": {
      "campaign_id": "<string>",
      "balance": 1
    }
  }
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

X-App-Id

string

header

required

X-App-Token

string

header

required

Path Parameters

string

required

Unique reward identifier.

Body

application/json

Payload for updating a reward. All fields are optional. In ACTIVE/INACTIVE status only name and metadata may be updated. Supplying type resets the non-matching sub-configuration to null.

name

string

Reward display name.

Required string length: 1 - 200

type

enum<string>

Reward type.

Available options:

MATERIAL,

DIGITAL

material

object | null

Required when type is MATERIAL.

Show child attributes

digital

object | null

Required when type is DIGITAL.

Show child attributes

metadata

object | null

Key-value metadata. Merged with existing metadata on update.

Response

Updated reward.

Reward resource representation.

string

required

Unique reward identifier.

name

string

required

Reward display name.

type

enum<string>

required

Reward type.

Available options:

MATERIAL,

DIGITAL

status

enum<string>

required

Current lifecycle status.

Available options:

ACTIVE,

DRAFT,

INACTIVE,

DELETED

metadata

object

required

Key-value metadata.

created_at

string<date-time>

required

ISO 8601 creation timestamp.

updated_at

string<date-time> | null

required

ISO 8601 last-update timestamp. Null if never updated.

object

string

required

Allowed value: "reward"

material

object

Material configuration. Present only when type is MATERIAL.

Show child attributes

digital

object

Digital configuration. Present only when type is DIGITAL.

Show child attributes

Last modified on July 7, 2026

⌘I

Introduction

Endpoints

Events

Update a reward

Authorizations

Path Parameters

Body

Response