curl --request PUT \
--url https://{cluster}.voucherify.io/v2/loyalties/programs/{programId}/rewards/{rewardId} \
--header 'Content-Type: application/json' \
--header 'X-App-Id: <api-key>' \
--header 'X-App-Token: <api-key>' \
--data '{
"stock": {}
}'{
"reward_id": "<string>",
"stock": {
"type": "UNLIMITED",
"limited": {
"quantity": 4503599627370495
}
},
"redeemed": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"object": "program_reward"
}{
"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>"
}{
"code": 500,
"key": "api_error",
"message": "Something went wrong. Don't worry, your campaigns are still safe and the Voucherify Team has been notified. Check out our Help Center and forums for help, or head back to home."
}Update program reward assignment
This documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact Voucherify support or your Technical Account Manager.
Updates the stock configuration of a reward assigned to a program. Returns the updated reward assignment.
curl --request PUT \
--url https://{cluster}.voucherify.io/v2/loyalties/programs/{programId}/rewards/{rewardId} \
--header 'Content-Type: application/json' \
--header 'X-App-Id: <api-key>' \
--header 'X-App-Token: <api-key>' \
--data '{
"stock": {}
}'{
"reward_id": "<string>",
"stock": {
"type": "UNLIMITED",
"limited": {
"quantity": 4503599627370495
}
},
"redeemed": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"object": "program_reward"
}{
"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>"
}{
"code": 500,
"key": "api_error",
"message": "Something went wrong. Don't worry, your campaigns are still safe and the Voucherify Team has been notified. Check out our Help Center and forums for help, or head back to home."
}Authorizations
Path Parameters
Identifies the loyalty program. Format lprg_[a-f0-9]+.
^lprg_[a-f0-9]+$Identifies the reward. Format lrew_[a-f0-9]+.
^lrew_[a-f0-9]+$Body
Request body schema for PUT /v2/loyalties/programs/{programId}/rewards/{rewardId}.
Reward stock configuration. When type is UNLIMITED, limited must not be provided. When type is LIMITED, limited is required.
Show child attributes
Show child attributes
Response
The updated reward assignment.
Response body schema for PUT /v2/loyalties/programs/{programId}/rewards/{rewardId}.
Unique reward identifier.
^lrew_[a-f0-9]+$Stock configuration of the assignment.
Show child attributes
Show child attributes
Number of times the reward has been redeemed within the program. Defaults to 0.
Assignment creation timestamp (ISO 8601).
Last update timestamp (ISO 8601), or null when never updated.
Object type marker. Always program_reward.
"program_reward"