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.

PUT /v2/loyalties/tier-structures/{id}/tiers/{tierId}

Update Tier

cURL

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": {
    "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>"
}

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.

tierId · string · required

Unique tier identifier.

Body

application/json

All fields optional. Omitted fields retain their current values.

name · string

Display name.

Required string length: 1 - 200

qualification_rules · object | null

Qualification rules.

Show child attributes

downgrade · object | null

Downgrade override.

Show child attributes

metadata · object | null

Custom key-value metadata.

Response

200

application/json

Updated 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.