Create a loyalty reward

Add a reward to a program's catalog.

Endpoint

POST
/loyalty-rewards

Body parameters

NameTypeRequiredDescription
organization_idintegerYesYour organization ID. Must be the program's organization.
program_idintegerYesID of the loyalty program.
namestringYesReward name (1 to 160 characters).
costnumberYesBalance needed, greater than 0.
reward_typestringNofree_item, discount_fixed, discount_percent or custom (default).
discount_valuenumberFor discount typesAmount (discount_fixed) or percentage up to 100 (discount_percent).
descriptionstring | nullNoDescription.
image_urlstring | nullNoImage URL.
product_idinteger | nullNoRelated product.
min_tier_idinteger | nullNoMinimum tier, from the same program.
stockinteger | nullNoTotal units available. null = unlimited.
code_validity_daysinteger | nullNoDays a reward code stays valid. null = no expiry.
statusstringNoactive (default) or inactive.
sort_orderintegerNoDisplay order. Default 0.

Request

Response

json

Errors

All are 400 Bad Request:

MessageCause
Program not found in this organizationprogram_id is not a program of organization_id.
A discount reward needs a discount valuediscount_fixed / discount_percent without a positive discount_value.
A percentage discount cannot exceed 100discount_percent with discount_value above 100.
The minimum tier must belong to the same programmin_tier_id is not a tier of the program.

Report an issue with this documentation

Please log in to report issues with our documentation.