Programs

Batch assign/unassign rewards

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 rewards to/from a program in a single batch. Unassign operations are processed before assign operations. Each reward to assign must include its stock configuration. In strict mode (default) missing rewards or missing assignments cause the whole batch to fail (404 Not Found).

post/v2/loyalties/programs/{programId}/rewards/batch

Request

  • Base URL
    https://api.voucherify.io
  • URL
    https://api.voucherify.io/v2/loyalties/programs/{programId}/rewards/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

    • breaking

      added to the request body allOf list

    • warning

      deleted the path request parameter programId

    • 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 to the response body allOf list for the response status

    • breaking

      added the new path request parameter programId

    • warning

      removed from the request body allOf list

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      removed from the response body allOf list for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status