Skip to main content
POST
/
v1
/
campaigns
/
{campaignId}
/
importCSV
Import Vouchers to Campaign by CSV
curl --request POST \
  --url https://{cluster}.voucherify.io/v1/campaigns/{campaignId}/importCSV \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>' \
  --form file=@example-file
{
  "async_action_id": "aa_0ab2df092385be5ca5"
}

Authorizations

​
X-App-Id
string
header
required
​
X-App-Token
string
header
required
​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
campaignId
string
required

The campaign ID or name of the campaign being enabled. You can either pass the campaign ID, which was assigned by Voucherify or the name of the campaign as the path parameter value.

Example:

"camp_rRsfatlwN7unSeUIJDCYedal"

Body

multipart/form-data

The file path is stored in the form file header.

Request body schema for POST v1/campaigns/{campaignId}/importCSV. Request body schema for importing data using a CSV file.

​
file
file
required

File path.

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](OpenAPI.json/paths/~1async-actions~1{asyncActionId}/get) -->Get Async Action endpoint.

Response body schema for POST v1/campaigns/{campaignId}/importCSV. Response to requests that are processed asynchronously.

​
async_action_id
string
required

The ID of the scheduled asynchronous action.

Example:

"aa_0a875d56c805df6601"

⌘I