Programs

Batch assign/unassign tier structures

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>

Assigns and/or unassigns tier structures to/from a program in a single batch. Unassign operations are processed before assign operations. Unassigning is only allowed while the program is in DRAFT status - otherwise the request is rejected with 423 Locked (key non_draft_program). A program can have at most one tier structure assigned. In strict mode (default) missing tier structures, inactive tier structures or missing assignments cause the whole batch to fail.

post/v2/loyalties/programs/{programId}/tier-structures/batch

Request

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

Request body

Response

Batch processing result.

Changes

  • v2d29b33490051Revision changes
    • breaking

      added to the ////// request property allOf list

    • breaking

      added 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

    • warning

      removed the request property ///////

    • warning

      removed the request property ///////

  • 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

    • warning

      removed from the ////// request property allOf list

    • warning

      removed from the ////// request property allOf list