> ## Documentation Index
> Fetch the complete documentation index at: https://docs.voucherify.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Move tier structure to draft

> ⚠️ **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.

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




## OpenAPI

````yaml /openapi/loyalties-v2.json post /v2/loyalties/tier-structures/{tierStructureId}/draft
openapi: 3.1.0
info:
  title: Voucherify Loyalty v2 API
  version: 2.0.0
  description: >-
    Complete OpenAPI specification for the Voucherify Loyalty v2 API.

    All endpoints require the LOYALTY_V2 feature flag.


    Combined from per-domain specs: programs.yaml, members.yaml,
    program-operations.yaml, card-definitions.yaml, earning-rules.yaml,
    tier-structures.yaml, benefits.yaml, rewards.yaml, examine.yaml
servers:
  - url: '{protocol}://{host}'
    variables:
      protocol:
        default: https
        enum:
          - https
          - http
      host:
        default: api.voucherify.io
security:
  - bearerAuth: []
    X-App-Id: []
    X-App-Token: []
tags:
  - name: Programs
    description: >-
      Loyalty program CRUD, lifecycle management, program-scoped resource
      assignments (card definitions, earning rules, rewards, tier structures),
      member management (create, list, get, activate, deactivate, delete), card
      operations (points adjustment, pending points, expiring points,
      transactions), reward purchases, and activity history.
  - name: Card Definitions
    description: >-
      CRUD operations, lifecycle management, and activity history for card
      definitions. Card definitions describe the configuration for loyalty
      cards, including code generation, points expiration, earning/spending
      limits, pending points, refunds, and balance settings.
  - name: Earning Rules
    description: >-
      Manage earning rules that define how customers earn points or receive
      incentives based on triggers (events, segments, custom events). Includes
      CRUD, lifecycle, and activity history.
  - name: Tier Structures
    description: >-
      CRUD operations, lifecycle management, and activity history for tier
      structures. Includes nested tier definitions (create, list, update,
      delete) within tier structures. Tier structures define the tiering model
      for loyalty programs — how members qualify for and move between tiers.
  - name: Benefits
    description: >-
      Manage benefit definitions (fixed points, proportional points, material,
      digital). Includes CRUD, lifecycle transitions, and activity history.
  - name: Rewards
    description: >-
      CRUD, lifecycle operations, and activity history for reward definitions.
      Rewards can be material (product/SKU) or digital (discount coupons, gift
      vouchers).
  - name: Examine
    description: >-
      Evaluation endpoints that estimate earning opportunities and reward
      availability for a customer across their loyalty program memberships,
      without side effects.
paths:
  /v2/loyalties/tier-structures/{tierStructureId}/draft:
    post:
      tags:
        - Tier Structures
      summary: Move tier structure to draft
      description: >
        ⚠️ **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.


        Moves the tier structure back to the `DRAFT` status. Allowed state
        transition:

        `ACTIVE` -> `DRAFT`. No request body.
      operationId: draftTierStructure
      parameters:
        - name: id
          in: path
          required: true
          description: Unique tier structure identifier.
          schema:
            type: string
            pattern: ^lts_[a-f0-9]+$
      responses:
        '200':
          description: The drafted tier structure.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TierStructure'
        '400':
          description: >-
            Validation error - request body or query parameters failed
            validation, or the operation is not allowed in the current resource
            state.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Resource not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Conflict - e.g. duplicate resource or invalid state transition.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    TierStructure:
      type: object
      description: Tier structure resource.
      properties:
        id:
          type: string
          description: Unique tier structure identifier.
          pattern: ^lts_[a-f0-9]+$
        name:
          type: string
          description: Display name of the tier structure.
        type:
          type: string
          enum:
            - POINT_BALANCE
            - POINT_EARNED
          description: Tier qualification tracking model.
        point_balance:
          $ref: '#/components/schemas/TierStructurePointBalance'
          description: >
            Point balance tracking settings. Present only when `type` is
            `POINT_BALANCE`;

            omitted otherwise.
        point_earned:
          $ref: '#/components/schemas/TierStructurePointEarned'
          description: >
            Points earned tracking settings. Present only when `type` is
            `POINT_EARNED`;

            omitted otherwise.
        expiration:
          $ref: '#/components/schemas/TierStructureExpiration'
          description: Tier membership expiration settings.
        downgrade:
          $ref: '#/components/schemas/TierStructureDowngrade'
          description: Downgrade behavior applied when tier membership expires.
        metadata:
          type: object
          description: >-
            Free-form key/value object holding custom attributes. Defaults to
            `{}`.
        status:
          type: string
          enum:
            - DRAFT
            - ACTIVE
            - INACTIVE
            - DELETED
          description: Current lifecycle status of the tier structure.
        created_at:
          type: string
          format: date-time
          description: Creation timestamp (ISO 8601).
        updated_at:
          type:
            - string
            - 'null'
          format: date-time
          description: Last update timestamp (ISO 8601), or null if never updated.
        object:
          type: string
          const: tier_structure
          description: Object type discriminator. Always `tier_structure`.
      required:
        - id
        - name
        - type
        - expiration
        - downgrade
        - metadata
        - status
        - created_at
        - updated_at
        - object
    ErrorResponse:
      type: object
      description: Standard error response returned by all Loyalty v2 endpoints.
      properties:
        code:
          type: integer
          description: HTTP status code of the error.
        key:
          type: string
          description: Machine-readable error key.
        message:
          type: string
          description: Human-readable error message.
        details:
          type: string
          description: Additional details about the error.
        request_id:
          type: string
          description: Identifier of the request that produced the error.
    TierStructurePointBalance:
      type: object
      description: Point balance tracking settings.
      properties:
        card_definition_id:
          type: string
          pattern: ^lcdef_[a-f0-9]+$
          description: Identifier of the card definition whose point balance is tracked.
    TierStructurePointEarned:
      type: object
      description: Points earned tracking settings.
      properties:
        card_definition_id:
          type: string
          pattern: ^lcdef_[a-f0-9]+$
          description: Identifier of the card definition whose earned points are tracked.
        period:
          $ref: '#/components/schemas/TierStructurePointEarnedPeriod'
          description: Tracking period during which earned points are accumulated.
        type:
          type: string
          enum:
            - IMMEDIATELY
            - NEXT_TRACKING_PERIOD
          description: When a tier change resulting from earned points takes effect.
    TierStructureExpiration:
      type: object
      description: >
        Tier membership expiration settings. Only the sub-object matching `type`
        is

        present; the others are omitted.
      properties:
        type:
          type: string
          enum:
            - NO_EXPIRATION
            - SLIDING_EXPIRATION
            - FIXED_DURATION
            - CALENDAR_EXPIRATION
          description: Expiration model for tier membership.
        fixed_duration:
          $ref: '#/components/schemas/TierStructureExpirationFixedDuration'
          description: >-
            Fixed duration settings. Present only when `type` is
            `FIXED_DURATION`.
        calendar_expiration:
          $ref: '#/components/schemas/TierStructureExpirationCalendarExpiration'
          description: >-
            Calendar expiration settings. Present only when `type` is
            `CALENDAR_EXPIRATION`.
        sliding_expiration:
          $ref: '#/components/schemas/TierStructureExpirationSlidingExpiration'
          description: >-
            Sliding expiration settings. Present only when `type` is
            `SLIDING_EXPIRATION`.
    TierStructureDowngrade:
      type: object
      description: Downgrade settings.
      properties:
        type:
          type: string
          enum:
            - MULTI_LEVEL
            - SINGLE_LEVEL
            - NO_DOWNGRADE
          description: Downgrade model.
        grace_period:
          $ref: '#/components/schemas/TierStructureDowngradeGracePeriod'
          description: >-
            Grace period before the downgrade takes effect. Omitted when not
            configured.
    TierStructurePointEarnedPeriod:
      type: object
      description: Points earned tracking period.
      properties:
        value:
          type: integer
          description: Length of the tracking period, expressed in `unit` units.
        unit:
          type: string
          enum:
            - DAY
            - WEEK
            - MONTH
            - YEAR
          description: Unit of the tracking period.
    TierStructureExpirationFixedDuration:
      type: object
      description: Fixed duration expiration settings.
      properties:
        period:
          $ref: '#/components/schemas/TierStructureExpirationPeriod'
          description: Duration after which the tier membership expires.
    TierStructureExpirationCalendarExpiration:
      type: object
      description: Calendar expiration settings.
      properties:
        calendar_dates:
          type: array
          description: Calendar dates on which tier membership expires.
          items:
            $ref: '#/components/schemas/TierStructureExpirationCalendarDate'
    TierStructureExpirationSlidingExpiration:
      type: object
      description: Sliding expiration settings.
      properties:
        earning_activity:
          type: boolean
          description: Whether point earning activity extends the tier membership.
        spending_activity:
          type: boolean
          description: Whether point spending activity extends the tier membership.
        custom_activity:
          type: boolean
          description: Whether custom activities extend the tier membership.
        custom_activity_types:
          type: array
          description: Custom activity type names that extend the tier membership.
          items:
            type: string
            description: Custom activity type name.
        period:
          $ref: '#/components/schemas/TierStructureExpirationPeriod'
          description: Sliding period after the last qualifying activity.
    TierStructureDowngradeGracePeriod:
      type: object
      description: Downgrade grace period.
      properties:
        value:
          type: integer
          description: Length of the grace period, expressed in `unit` units.
        unit:
          type: string
          enum:
            - DAY
            - MONTH
            - YEAR
          description: Unit of the grace period.
        round_up:
          type: boolean
          description: Whether the grace period end is rounded up to the end of the unit.
    TierStructureExpirationPeriod:
      type: object
      description: |
        Expiration period. The same shape is used for fixed duration and sliding
        expiration periods.
      properties:
        value:
          type: integer
          description: Length of the period, expressed in `unit` units.
        unit:
          type: string
          enum:
            - DAY
            - MONTH
            - YEAR
          description: Unit of the period.
    TierStructureExpirationCalendarDate:
      type: object
      description: A recurring calendar date.
      properties:
        day:
          type: integer
          minimum: 1
          maximum: 31
          description: Day of the month (1-31).
        month:
          type: integer
          minimum: 1
          maximum: 12
          description: Month of the year (1-12).
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    X-App-Id:
      type: apiKey
      name: X-App-Id
      in: header
    X-App-Token:
      type: apiKey
      name: X-App-Token
      in: header

````