Sign in
Tier Structures

Deactivate tier structure

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

Moves the tier structure to the INACTIVE status. Allowed state transition: ACTIVE -> INACTIVE. No request body.

post/v2/loyalties/tier-structures/{tierStructureId}/deactivate

Path parameters

idstring required

Unique tier structure identifier.

Response

The deactivated 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.

Changes

Changed in 2 of the 62 revisions of this API.19

  • v2703a0a42ea4311See the full diff
    • ●

      added the new NO_RETENTION enum value to the / response property for the response status

      response-property-enum-value-added

    • ○

      removed the NO_EXPIRATION enum value from the / response property for the response status

      response-property-enum-value-removed

    This revision also has 10 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v24cbaee5a82d58See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added