Update Vouchers' Metadata in Bulk

curl --request POST \
  --url https://{cluster}.voucherify.io/v1/vouchers/metadata/async \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>' \
  --data '{
  "codes": [
    "PROMO-CODE810",
    "PROMO-CODE726"
  ],
  "metadata": {
    "lang": "en",
    "authorized_internally": true
  }
}'

{
  "async_action_id": "aa_0ab2df092385be5ca5"
}

Update Vouchers' Metadata in Bulk

Updates metadata parameters for a list of codes. Every resource in the list will receive the metadata defined in the request.

The request can include up to 10 MB of data.

Upserts are not supported.

The response returns a unique asynchronous action ID. Use this ID in the query paramater of the GET Async Action endpoint to check, e.g.:

The status of your request (in queue, in progress, done, or failed)
Resources that failed to be updated
The report file with details about the update

This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished.

POST

vouchers

metadata

async

Update Vouchers' Metadata in Bulk

curl --request POST \
  --url https://{cluster}.voucherify.io/v1/vouchers/metadata/async \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>' \
  --data '{
  "codes": [
    "PROMO-CODE810",
    "PROMO-CODE726"
  ],
  "metadata": {
    "lang": "en",
    "authorized_internally": true
  }
}'

{
  "async_action_id": "aa_0ab2df092385be5ca5"
}

Authorizations

X-App-Id

string

header

required

X-App-Token

string

header

required

Authorization

string

header

required

Body

application/json

codes

string[]

required

metadata

object

required

Example:

Response

async_action_id

string

required

Example:

Update Vouchers in Bulk Release Validation Session

⌘I

Introduction

Endpoints

Events

Update Vouchers' Metadata in Bulk

Authorizations

Body

Response