A loyalty program is a container for one or more Promotions API , which is a mechanism to reward accounts for completing certain actions.
/api/loyalty-programs
This endpoint allows you to create a Loyalty Program .
Attributes
name
accountId
description
mediaUploadId
Errors
INVALID_ACCOUNT_TYPE
Request
curl -X POST \
https://service.centrapay.com/api/loyalty-programs \
-H 'content-type: application/json' \
-H 'x-api-key: <TOKEN>' \
-d '
{
"name": "Centrapay Cafe Loyalty Program",
"description": "Centrapay Cafe Loyalty: Earn rewards, enjoy perks! Join now!",
"mediaUploadId": "8aoMfscvtuewsuJzmzBzAs",
"accountId": "Jaim1Cu1Q55uooxSens6yk"
}
'
Response
{
"id": "WRhAxxWpTKb5U7pXyxQjjY",
"name": "Centrapay Cafe Loyalty Program",
"description": "Centrapay Cafe Loyalty: Earn rewards, enjoy perks! Join now!",
"mediaUploadId": "8aoMfscvtuewsuJzmzBzAs",
"img": "https://media-upload.centrapay.com/image.png?jhbdsfau67ewejshb=487hsdjhbdgs743",
"accountId": "Jaim1Cu1Q55uooxSens6yk",
"createdAt": "2021-08-25T00:02:49.488Z",
"createdBy": "crn::user:b657195e-dc2f-11ea-8566-e7710d592c99",
"test": true
}
/api/accounts/{accountId}/loyalty-programs
Returns a paginated API list of Loyalty Programs for an Account.
Request
curl -X GET \
https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk/loyalty-programs \
-H 'x-api-key: <TOKEN>'
Response
{
"items": [
{
"id": "WRhAxxWpTKb5U7pXyxQjjY",
"name": "Centrapay Cafe Loyalty Program",
"description": "Centrapay Cafe Loyalty: Earn rewards, enjoy perks! Join now!",
"mediaUploadId": "8aoMfscvtuewsuJzmzBzAs",
"img": "https://media-upload.centrapay.com/image.png?jhbdsfau67ewejshb=487hsdjhbdgs743",
"accountId": "Jaim1Cu1Q55uooxSens6yk",
"createdAt": "2021-08-25T00:02:49.488Z",
"createdBy": "crn::user:b657195e-dc2f-11ea-8566-e7710d592c99",
"test": true
},
{
"id": "DKTs3U38hdhfEqwF1JKoT2",
"name": "Centra Tea Warehouse Loyalty Program",
"description": "Centra Tea Warehouse Loyalty: Earn rewards, enjoy perks! Join now!",
"mediaUploadId": "Hopo4g34sLVdjEMBs2p19F",
"img": "https://media-upload.centrapay.com/image.png?jhbdsfau67ewejshb=487hsdjhbdgs743",
"accountId": "Jaim1Cu1Q55uooxSens6yk",
"createdAt": "2021-08-25T00:02:49.488Z",
"createdBy": "crn::user:b657195e-dc2f-11ea-8566-e7710d592c99",
"test": true
}
]
}