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 new tier within the specified tier structure.

Maximum of 10 tiers per tier structure.

When qualification_rules.type is POINTS, min_value is required and point ranges must not overlap with existing tiers. When qualification_rules.type is SEGMENT, segment.id is required and must reference a valid segment.

downgrade.type defaults to INHERIT if omitted.

POST /v2/loyalties/tier-structures/{id}/tiers

Create Tier

cURL

curl --request POST \
  --url https://api.voucherify.io/v2/loyalties/tier-structures/{id}/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": {
    "min_value": 1,
    "max_value": 1,
    "segment": {
      "id": "<string>"
    }
  },
  "downgrade": {},
  "metadata": {}
}
'

200

{
  "id": "<string>",
  "tier_structure_id": "<string>",
  "name": "<string>",
  "downgrade": {},
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "object": "tier",
  "qualification_rules": {
    "min_value": 1,
    "max_value": 1,
    "segment": {
      "id": "<string>"
    }
  },
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

X-App-Id · string · header · required

X-App-Token · string · header · required

Path Parameters

id · string · required

Unique tier structure identifier.

Body

application/json

name · string · required

Display name.

Required string length: 1 - 200

qualification_rules · object · required

When type is POINTS, min_value is required. max_value is optional but if provided must be >= min_value. Cannot have max_value without min_value. When type is SEGMENT, segment is required and min_value/max_value are not allowed.

Show child attributes

downgrade · object | null

Downgrade override. Default: INHERIT.

Show child attributes

metadata · object | null

Custom key-value metadata.

Response

200

application/json

Created tier

A tier resource as returned by the API.

id · string · required

Unique tier identifier.

tier_structure_id · string · required

ID of the parent tier structure.

name · string · required

Display name.

Maximum string length: 200

downgrade · object · required

Show child attributes

metadata · object · required

Custom key-value metadata.

created_at · string<date-time> · required

ISO 8601 creation timestamp.

object · enum<string> · required

Object type discriminator.

Available options: tier

qualification_rules · object | null

Rules determining how members qualify for this tier.

Show child attributes

updated_at · string<date-time> | null

ISO 8601 last-update timestamp.