Update Vouchers in Bulk

curl --request POST \
  --url https://{cluster}.voucherify.io/v1/vouchers/bulk/async \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>' \
  --data '[
  {
    "code": "example_code",
    "metadata": {
      "lang": "en",
      "test": false,
      "MetadataTest": "Update metadata",
      "update_value": 1,
      "next_update_date": "2022-11-11T09:00:00.000Z"
    }
  },
  {
    "code": "example_code2",
    "metadata": {
      "lang": "pl",
      "test": false,
      "MetadataTest": "Update metadata",
      "update_value": 2
    }
  }
]'

{
  "async_action_id": "aa_0ab2df092385be5ca5"
}

Update Vouchers in Bulk

Updates specific metadata parameters for each code, respectively, in one asynchronous operation.

The request can include up to 10 MB of data.

Upserts are not supported.

🚧 Currently, only metadata updates are 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

bulk

async

Update Vouchers in Bulk

curl --request POST \
  --url https://{cluster}.voucherify.io/v1/vouchers/bulk/async \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>' \
  --data null

{
  "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 · Vouchers Update In Bulk Request Body Item · object[]

code

string

required

metadata

object

required

Response

async_action_id

string

required

Example:

Import Vouchers using CSV Update Vouchers' Metadata in Bulk

⌘I

Introduction

Endpoints

Events

Update Vouchers in Bulk

Authorizations

Body

Response