Batches
Send up to 10,000 people per request; for more, send several batches. They run in the background, a few hundred links at a time. Poll the batch or wait for the batch.completed webhook. (Generating links in the portal has no size limit other than the links you have left.)
curl -X POST https://api-rewards.efiqone.com/v1/Services/RS8f2c…/Batches \
-u $EFIQ_ACCOUNT_SID:$EFIQ_AUTH_TOKEN \
-H "Content-Type: application/json" \
-H "Idempotency-Key: import-2026-11-11" \
-d '{"campaign":"DIWALI24","items":[{"externalUserId":"crm_1"},{"externalUserId":"crm_2"}]}'The response is 202 Accepted with a batch (BT…) in status queued. Links for all items are taken first; if you don’t have enough left, the batch is refused with 402 / 20204 and nothing is used.
Progress and results
GET /v1/Services/{ServiceSid}/Batches/{BatchSid} status, processed, created, existing, failed, percentage
GET /v1/Services/{ServiceSid}/Batches/{BatchSid}/Results one row per item with its link URL or error codeEach item succeeds or fails on its own. Items for a person who already has a link return that link (existing). Unused reservations are refunded when the batch completes.
If a campaign runs out of stock (or is paused or ends) while a batch is running, the batch stops right away: the remaining items are marked failed with 20903, refunded, and the batch’s error says why.
Names and phone numbers
If the Service’s DataMode is PII_DELIVERY, each item can carry the person’s name (shown on the gift page: “Hi Priya”) and phone number. Phone numbers are normalised the same way as in the dashboard (Indian mobiles become 10 digits). A phone number that’s already a contact in your account is reused. Pseudonymous Services refuse names and phones with PII_NOT_ALLOWED.
{
"campaign": "DIWALI24",
"items": [
{ "externalUserId": "crm_1042", "recipientName": "Priya Sharma", "recipientPhone": "+91 98765 43210", "externalRef": "order-5521" },
{ "externalUserId": "crm_1043", "recipient": { "name": "Arjun Mehta", "phone": "9845012345" } }
]
}In the portal
- Create links, Import contacts: upload a CSV (name, phone, and optionally your id and a reference). Columns are detected automatically, every row is checked first, and big files are sent as several batches. Without an id, the contact id is derived from the phone number, so importing the same person twice returns the same link. The CSV export includes each person’s name, phone and link.
- Create links, Generate anonymous links: any number of links with generated ids and no person data. No size limit other than the links you have left and the campaign’s stock.