Sign in

v18

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01934981.1 MB
Tier Structures

Update tier structure

<Warning>

<Badge color="yellow">BETA endpoint</Badge>

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.

</Warning>

Updates a tier structure. All properties are optional; provided values are merged with the existing tier structure. When type is provided as POINT_EARNED, point_earned is required and point_balance must be null; when type is POINT_BALANCE, point_balance is required and point_earned must be null. When the tier structure is not in DRAFT status, only name and metadata may be updated; attempting to update other properties results in a validation error.

put/v2/loyalties/tier-structures/{tierStructureId}

Path parameters

idstring required

Unique tier structure identifier.

Request body

namestring

Display name of the tier structure.

type'POINT_BALANCE' | 'POINT_EARNED'

Tier qualification tracking model. If provided, the matching tracking settings object (point_balance or point_earned) becomes required.

metadataobject nullable

Free-form key/value object holding custom attributes.

Response

The updated tier structure.

idstring required

Unique tier structure identifier.

namestring required

Display name of the tier structure.

type'POINT_BALANCE' | 'POINT_EARNED' required

Tier qualification tracking model.

metadataobject required

Free-form key/value object holding custom attributes. Defaults to {}.

status'DRAFT' | 'ACTIVE' | 'INACTIVE' | 'DELETED' required

Current lifecycle status of the tier structure.

created_atstring date-time required

Creation timestamp (ISO 8601).

updated_atstring date-time nullable required

Last update timestamp (ISO 8601), or null if never updated.

object'tier_structure' required

Object type discriminator. Always tier_structure.