Tier Structures

Update tier structure

Changed on
<Info>

<Badge color="gray">Documentation in progress</Badge>

This documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact Voucherify support or your Technical Account Manager.

</Info>

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}

Request

  • Base URL
    https://api.voucherify.io
  • URL
    https://api.voucherify.io/v2/loyalties/tier-structures/{tierStructureId}
  • Auth
    • API key in header X-App-Id and API key in header X-App-Token
    • or HTTP bearer

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.

metadataobject required

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

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.

idstring required

Unique tier structure identifier.

namestring required

Display name of the tier structure.

type'POINT_BALANCE' | 'POINT_EARNED' required

Tier qualification tracking model.

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

Current lifecycle status of the tier structure.

object'tier_structure' required

Object type discriminator. Always tier_structure.

Changes

  • v2d29b33490051Revision changes
    • breaking

      added subschema #2 to the /////////// request property allOf list

    • breaking

      added subschema #2 to the ///////////// request property allOf list

    • breaking

      the /////////// request property type changed from object to no type

    • breaking

      the ///////////// request property type changed from object to no type

    • breaking

      the /// response's property type changed from object to no type for status

    • breaking

      removed the required property //// from the response with the status

    • breaking

      removed the required property //// from the response with the status

    • breaking

      removed the required property //// from the response with the status

    • breaking

      removed the required property //// from the response with the status

    • breaking

      removed the required property //// from the response with the status

    • breaking

      removed the required property //// from the response with the status

    • breaking

      removed the required property //// from the response with the status

    • breaking

      removed the required property //// from the response with the status

    • breaking

      removed the required property //// from the response with the status

    • breaking

      removed the required property //// from the response with the status

    • warning

      removed the request property ////////////

    • warning

      removed the request property ////////////

    • warning

      removed the request property ////////////

    • warning

      removed the request property ////////////

    • warning

      removed the request property ////////////

    • warning

      removed the request property //////////////

    • warning

      removed the request property //////////////

    • warning

      removed the request property //////////////

    • warning

      removed the request property //////////////

    • warning

      removed the request property //////////////

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • info

      added subschema #2 to the /// response property allOf list for the response status

  • v2be14b3318eb3Revision changes
    • breaking

      added the new required request property ////////////

    • breaking

      added the new required request property //////////////

    • breaking

      the /////////// request property type changed from no type to object

    • breaking

      the ///////////// request property type changed from no type to object

    • breaking

      the /// response's property type changed from no type to object for status

    • warning

      removed subschema #2 from the /////////// request property allOf list

    • warning

      removed subschema #2 from the ///////////// request property allOf list

    • info

      added the new optional request property ////////////

    • info

      added the new optional request property ////////////

    • info

      added the new optional request property ////////////

    • info

      added the new optional request property ////////////

    • info

      added the new optional request property //////////////

    • info

      added the new optional request property //////////////

    • info

      added the new optional request property //////////////

    • info

      added the new optional request property //////////////

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      removed subschema #2 from the /// response property allOf list for the response status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status