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/tier-structures/{id}/tiers/{tierId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-App-Id: <api-key>' \
--header 'X-App-Token: <api-key>' \
--data '
{
"name": "<string>",
"qualification_rules": {
"type": "POINTS",
"min_value": 1,
"max_value": 1,
"segment": {
"id": "<string>"
}
},
"downgrade": {
"type": "INHERIT"
},
"metadata": {}
}
'{
"id": "<string>",
"tier_structure_id": "<string>",
"name": "<string>",
"downgrade": {
"type": "INHERIT"
},
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"object": "tier",
"qualification_rules": {
"type": "POINTS",
"min_value": 1,
"max_value": 1,
"segment": {
"id": "<string>"
}
},
"updated_at": "2023-11-07T05:31:56Z"
}Update Tier
⚠️ 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 an existing tier. All fields are optional; omitted fields retain their current values.
The tier must belong to the specified tier structure.
When changing qualification_rules.type to POINTS, min_value is required and
the new point range must not overlap with other tiers.
When changing to SEGMENT, segment.id is required.
curl --request PUT \
--url https://api.voucherify.io/v2/loyalties/tier-structures/{id}/tiers/{tierId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-App-Id: <api-key>' \
--header 'X-App-Token: <api-key>' \
--data '
{
"name": "<string>",
"qualification_rules": {
"type": "POINTS",
"min_value": 1,
"max_value": 1,
"segment": {
"id": "<string>"
}
},
"downgrade": {
"type": "INHERIT"
},
"metadata": {}
}
'{
"id": "<string>",
"tier_structure_id": "<string>",
"name": "<string>",
"downgrade": {
"type": "INHERIT"
},
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"object": "tier",
"qualification_rules": {
"type": "POINTS",
"min_value": 1,
"max_value": 1,
"segment": {
"id": "<string>"
}
},
"updated_at": "2023-11-07T05:31:56Z"
}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 tier structure identifier.
Unique tier identifier.
Body
Response
Updated tier
A tier resource as returned by the API.
Unique tier identifier.
ID of the parent tier structure.
Display name.
200Show child attributes
Show child attributes
Custom key-value metadata.
ISO 8601 creation timestamp.
Object type discriminator.
tier Rules determining how members qualify for this tier.
Show child attributes
Show child attributes
ISO 8601 last-update timestamp.
Was this page helpful?