Order cards in bulk

This endpoint initiates a process that generates cards in bulk.

The endpoint itself only performs certain validations and saves the request.

The cards are subsequently created by a cron, which will notify the client of the results via a webhook on said client's end.

The client will immediately receive a 200 OK response if the request is valid and returns a batch reference ID for tracking.

Note:

The result of this process is not immediate. You will receive the final status and details via the webhook configured on your ecommerce system.

You can see the webhook structure here

The generated cards are not yet attached to a customer; the /activateCardForCustomer endpoint exists for that purpose.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
batch
array of objects
required

All cards to be created

batch*
string
length ≤ 100

The id for the card's campaign.
A default campaign will be set if this field is not present.

delivery_location
object
required

Contains information for delivery, both the location and the person who'll receive the cards

string
length ≤ 10

The id for the card's design.
A default design will be set if this field is not present.

Headers
string
required

OAuth token belonging to the e-commerce

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json