curl --request POST \
--url {protocol}://{host}/v2/loyalties/tier-structures/{tierStructureId}/tiers \
--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": {
"points": {
"min_value": 500000000,
"max_value": 500000000
},
"segment": {
"id": "<string>"
}
},
"downgrade": {},
"metadata": {}
}
'{
"id": "<string>",
"tier_structure_id": "<string>",
"name": "<string>",
"downgrade": {},
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"object": "<string>",
"qualification_rules": {
"points": {
"min_value": 123,
"max_value": 123
},
"segment": {
"id": "<string>"
}
}
}{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>"
}{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>"
}{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>"
}{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>"
}Create 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.
Creates a tier within the tier structure. If downgrade is omitted it defaults to
{ "type": "INHERIT" }. A tier structure can hold at most 10 tiers.
A valid request URL is required to generate request examples{
"id": "<string>",
"tier_structure_id": "<string>",
"name": "<string>",
"downgrade": {},
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"object": "<string>",
"qualification_rules": {
"points": {
"min_value": 123,
"max_value": 123
},
"segment": {
"id": "<string>"
}
}
}{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>"
}{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>"
}{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>"
}{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Unique tier structure identifier.
^lts_[a-f0-9]+$Body
Request body for creating a tier. No additional properties are allowed.
Display name of the tier. Required.
1 - 200Rules determining which members qualify for this tier. Required.
Show child attributes
Show child attributes
Tier-level downgrade behavior. If omitted, defaults to { "type": "INHERIT" }
(inherits the tier structure downgrade settings).
Show child attributes
Show child attributes
Free-form key/value object holding custom attributes.
Response
The created tier.
Tier resource.
Unique tier identifier.
^lt_[a-f0-9]+$Identifier of the parent tier structure.
^lts_[a-f0-9]+$Display name of the tier.
Tier-level downgrade behavior. Always present; when the tier has no downgrade
configured, an empty object (no type) is returned.
Show child attributes
Show child attributes
Free-form key/value object holding custom attributes. Defaults to {}.
Creation timestamp (ISO 8601).
Last update timestamp (ISO 8601), or null if never updated.
Object type discriminator. Always tier.
"tier"Rules determining which members qualify for this tier.
Show child attributes
Show child attributes
Was this page helpful?