Vincent is here! Just say the word, and Vincent will build the campaigns for you! Get early access.
Card Definitions
Programs
- GETList loyalty programs
- POSTCreate a loyalty program
- GETGet a loyalty program
- PUTUpdate a loyalty program
- DELDelete a loyalty program
- POSTActivate a loyalty program
- POSTDeactivate a loyalty program
- GETList program activities
- GETList card definition assignments for a program
- POSTBatch assign/unassign card definitions
- GETList earning rule assignments for a program
- POSTBatch assign/unassign earning rules
- GETList tier structure assignments for a program
- POSTBatch assign/unassign tier structures
- GETList reward assignments for a program
- POSTBatch assign/unassign rewards
Members
- GETList members
- POSTCreate member
- GETGet member
- DELDelete member
- POSTActivate member
- POSTDeactivate member
- GETList member activities
- POSTAdjust card points
- GETList card activities
- GETList pending points buckets
- POSTActivate pending points
- POSTCancel pending points
- GETList expiring points buckets
- POSTExpire points
- GETList card transactions
- GETList reward purchases
- POSTPurchase reward
Examine
Earning Rules
Tier Structures
Incentives
curl --request PUT \
--url https://api.voucherify.io/v2/loyalties/programs/{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>",
"start_date": "2023-11-07T05:31:56Z",
"end_date": "2023-11-07T05:31:56Z",
"metadata": {}
}
'{
"id": "<string>",
"name": "<string>",
"status": "DRAFT",
"start_date": "2023-11-07T05:31:56Z",
"end_date": "2023-11-07T05:31:56Z",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"object": "<string>"
}Update a loyalty program
⚠️ 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 program properties. When the program is not in DRAFT status,
only name and metadata can be updated.
curl --request PUT \
--url https://api.voucherify.io/v2/loyalties/programs/{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>",
"start_date": "2023-11-07T05:31:56Z",
"end_date": "2023-11-07T05:31:56Z",
"metadata": {}
}
'{
"id": "<string>",
"name": "<string>",
"status": "DRAFT",
"start_date": "2023-11-07T05:31:56Z",
"end_date": "2023-11-07T05:31:56Z",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"object": "<string>"
}Documentation Index
Fetch the complete documentation index at: https://docs.voucherify.io/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Unique program identifier
^lprg_[a-f0-9]+$Body
Program name
1 - 200Program start date (ISO 8601). Only updatable in DRAFT status.
Program end date (ISO 8601). Only updatable in DRAFT status.
Custom metadata (merged with existing on update)
Response
Program updated successfully
Program DTO returned by toDTO()
Unique program identifier
^lprg_[a-f0-9]+$Program name
DRAFT, ACTIVE, INACTIVE, DELETED Program start date
Program end date
Custom key-value metadata.
Creation timestamp (ISO 8601)
Last update timestamp (ISO 8601)
"program"Was this page helpful?