v1

latestOpenAPI 3.0.1MIT2026-07-263151,3912.3 MB
Campaigns

Import Vouchers to Campaign

Imports vouchers to an existing campaign.

This API request starts a process that affects Voucherify data in bulk.

In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window.

The result will return the async ID. You can verify the status of your request via this API request.

post/v1/campaigns/{campaignId}/import

Request body

Example request

[
  {
    "redemption": {
      "quantity": 10
    },
    "start_date": "2020-12-28T12:49:16.272Z",
    "expiration_date": "2053-12-28T12:49:16.272Z",
    "validity_timeframe": {
      "duration": "PT1H",
      "interval": "P2D"
    }
  }
]

Response

Returns the ID of the scheduled asynchronous action, informing you that your request has been accepted and the vouchers will be imported to the repository asynchronously. To check the status and result, copy the async_action_id from the response and pass it using Get Async Action endpoint.

async_action_idstring required

The ID of the scheduled asynchronous action.

Example response

{
  "async_action_id": "aa_0a875d56c805df6601"
}