Batch assign/unassign rewards

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

Assigns and/or unassigns rewards to/from a program in a single batch.

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

Batch assign/unassign rewards

cURL

curl --request POST \
  --url https://api.voucherify.io/v2/loyalties/programs/{programId}/rewards/batch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>' \
  --data '
{
  "assign": [
    {
      "id": "<string>",
      "costs": [
        {
          "spending": [
            {
              "points": 1073741824,
              "card_definition_id": "<string>"
            }
          ]
        }
      ],
      "stock": 1073741823
    }
  ],
  "unassign": [
    {
      "id": "<string>"
    }
  ]
}
'

200

{
  "assigned": [
    {
      "reward_id": "<string>",
      "costs": [
        {
          "rules": "<unknown>",
          "spending": [
            {
              "points": 123,
              "card_definition_id": "<string>"
            }
          ]
        }
      ],
      "stock": 123,
      "redeemed": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "object": "<string>"
    }
  ],
  "unassigned": [
    {
      "reward_id": "<string>",
      "costs": [
        {
          "rules": "<unknown>",
          "spending": [
            {
              "points": 123,
              "card_definition_id": "<string>"
            }
          ]
        }
      ],
      "stock": 123,
      "redeemed": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "object": "<string>"
    }
  ]
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

X-App-Id · string · header · required

X-App-Token · string · header · required

Path Parameters

programId · string · required

Unique program identifier

Pattern: ^lprg_[a-f0-9]+$

Body

application/json

assign · object[] | null

Rewards to assign

Maximum array length: 10

Show child attributes

unassign · object[] | null

Rewards to unassign

Maximum array length: 10

Show child attributes

Response

200

application/json

Batch processing result

assigned · object[] | null

Successfully assigned rewards (null if no assign operations)

Show child attributes

unassigned · object[] | null

Successfully unassigned rewards (null if no unassign operations)

Show child attributes