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.
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Body
List the codes of the vouchers you would like to update with the metadata key/value pairs.
Request body schema for vouchers/metadata/async.
An array of voucher codes.
The metadata object stores all custom attributes assigned to the code. A set of key/value pairs that you can attach to a voucher object. It can be useful for storing additional information about the voucher in a structured format.
{
"lang": "en",
"authorized_internally": true
}Response
Returns the ID of the scheduled asynchronous action. The response informs you that the request has been accepted and the resources will be updated in the repository asynchronously. To check the status and result, copy the async_action_id from the response and use it as a query parameter in the GET Async Action endpoint.
Response body schema for POST v1/vouchers/metadata/async.
The ID of the scheduled asynchronous action.
"aa_0a875d56c805df6601"