Update Reward Assignment

Update the number of points needed to successfully redeem the reward.

PUT /v1/rewards/{rewardId}/assignments/{assignmentId}

Update Reward Assignment

cURL

curl --request PUT \
  --url https://{cluster}.voucherify.io/v1/rewards/{rewardId}/assignments/{assignmentId} \
  --header 'Content-Type: application/json' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>' \
  --data '
{
  "parameters": {
    "loyalty": {
      "points": 35
    }
  }
}
'

200

{
  "id": "rewa_pJYQBXSitK2OVPK3XMXZK76X",
  "reward_id": "rew_C7wS9eHFDN4CIbXI5PpLSkGY",
  "related_object_id": "camp_jcErmtGAOmHUAy0oUgkwKnPZ",
  "related_object_type": "campaign",
  "parameters": {
    "loyalty": {
      "points": 35
    }
  },
  "created_at": "2022-08-24T11:40:22.418Z",
  "updated_at": "2022-08-24T13:02:32.262Z",
  "object": "reward_assignment"
}

Authorizations

X-App-Id & X-App-TokenX-Voucherify-OAuth

X-App-Id · string · header · required

X-App-Token · string · header · required

Path Parameters

rewardId · string · required

A unique reward ID.

Example:

"rew_2erjvECLs92GYzKbak3QkyTV"

assignmentId · string · required

A unique reward assignment ID.

Example:

"rewa_m9hEAu10KsPcLhGXiHG85aY0"

Body

application/json

Define the number of points required to exchange for the reward.

Request body schema for PUT v1/rewards/{rewardId}/assignments/{assignmentId}.

parameters · object

An object that defines the price of the reward in loyalty points.

Show child attributes

Response

200

application/json

Returns the updated reward assignment object.

Response body schema for PUT v1/rewards/{rewardId}/assignments/{assignmentId}.

id · string · required

Unique reward assignment ID, assigned by Voucherify.

Example:

"rewa_PbIRoMXpwe5QhobW4JKu0VjH"

reward_id · string · required

Associated reward ID.

Example:

"rew_C7wS9eHFDN4CIbXI5PpLSkGY"

created_at · string<date-time> · required

Timestamp representing the date and time when the reward assignment was created. The value is shown in the ISO 8601 format.

Example:

"2022-08-11T14:49:22.586Z"

updated_at · string<date-time> | null · required

Timestamp representing the date and time when the reward assignment was updated. The value is shown in the ISO 8601 format.

Example:

"2022-08-11T16:01:34.885Z"

object · enum<string> · default: reward_assignment · required

The type of the object represented by the JSON. This object stores information about the reward assignment.

Available options: reward_assignment

related_object_id · string · required

Related object ID to which the reward was assigned.

Example:

"camp_wciTvaOfYmAa3EmIIW3QpXXZ"

related_object_type · enum<string> · default: campaign · required

Related object type to which the reward was assigned.

Available options: campaign

parameters · object

Defines the cost of the reward.

Show child attributes