curl --request POST \
  --url https://{cluster}.voucherify.io/v1/campaigns/{campaignId}/import \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>' \
  --data '
[
  {
    "code": "CODE7",
    "category": "First",
    "redemption": {
      "quantity": 1
    },
    "metadata": {
      "season": "Fall"
    },
    "additional_info": "secret-code1",
    "active": true
  },
  {
    "code": "CODE8",
    "category": "Second",
    "redemption": {
      "quantity": 18
    },
    "metadata": {
      "season": "Fall"
    },
    "additional_info": "secret-code1",
    "active": true
  },
  {
    "code": "CODE9",
    "redemption": {
      "quantity": 4
    },
    "metadata": {
      "season": "Fall"
    },
    "additional_info": "secret-code1",
    "active": true
  }
]
'

{
  "async_action_id": "aa_0a875d56c805df6601"
}

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

campaigns

{campaignId}

import

curl --request POST \
  --url https://{cluster}.voucherify.io/v1/campaigns/{campaignId}/import \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>' \
  --data '
[
  {
    "code": "CODE7",
    "category": "First",
    "redemption": {
      "quantity": 1
    },
    "metadata": {
      "season": "Fall"
    },
    "additional_info": "secret-code1",
    "active": true
  },
  {
    "code": "CODE8",
    "category": "Second",
    "redemption": {
      "quantity": 18
    },
    "metadata": {
      "season": "Fall"
    },
    "additional_info": "secret-code1",
    "active": true
  },
  {
    "code": "CODE9",
    "redemption": {
      "quantity": 4
    },
    "metadata": {
      "season": "Fall"
    },
    "additional_info": "secret-code1",
    "active": true
  }
]
'

{
  "async_action_id": "aa_0a875d56c805df6601"
}

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 ID of an existing campaign to which you're importing the codes. 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

application/json

Discount type, expiration date and the remaining attributes will be taken from the Campaign settings.

Voucher Import Loyalty Card
Voucher Import Gift
Voucher Import Discount

Object model for gift card object being imported.

code

string

required

Value representing the imported code.

loyalty_card

Simple Loyalty Card · object

required

Simplified loyalty card data.

Show child attributes

loyalty_card.points

integer

required

Total number of points added to the loyalty card over its lifespan.

loyalty_card.balance

integer

Points available for reward redemption. This is calculated as follows: balance = points - expired_points - subtracted_points - redemption.redeemed_points.

loyalty_card.next_expiration_date

string

The next closest date when the next set of points are due to expire.

loyalty_card.next_expiration_points

integer

The amount of points that are set to expire next.

loyalty_card.pending_points

integer

Shows the number of pending points that will be added to the loyalty card when they are activated automatically or manually.

loyalty_card.expired_points

integer

Shows the total number of expired points over the lifetime of the loyalty card.

loyalty_card.subtracted_points

integer

Shows the total number of subtracted points over the lifetime of the loyalty card.

redemption

object

Stores the quantity of redemptions that can be applied to the voucher.

Show child attributes

redemption.quantity

integer

How many times a voucher can be redeemed. A null value means unlimited.

Example:

10

active

boolean

A flag to toggle the voucher on or off. You can disable a voucher even though it's within the active period defined by the start_date and expiration_date.

true indicates an active voucher
false indicates an inactive voucher

metadata

object

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.

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.

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

async_action_id

string

required

The ID of the scheduled asynchronous action.

Example:

"aa_0a875d56c805df6601"

Add Voucher with Specific Code to Campaign Import Vouchers to Campaign by CSV

⌘I

Introduction

Endpoints

Events

Import Vouchers to Campaign

Authorizations

Path Parameters

Body

Response