Create a code batch Coming soon

POST/v1/offers/{id}/code_batches

Generates single-use codes for a unique_codes offer. Each code is the prefix, a dash and 6 random letters and digits. Large batches take a few seconds: the batch starts as generating and becomes ready.

Permissions: Secret key with offers:write.

Guide

Run offers from your server

Request headers#

Idempotency-Keystring
Any string up to 255 characters; use a UUID v4. Kept 24 hours per key (or member) and endpoint. Same key and body replays the first response with Idempotent-Replayed: true.
Max Length 255

Path parameters#

idstring (uuid)Required

Request body#

prefixstringRequired
Letters and digits, for example HOLIDAY.
quantityintegerRequired
Number of codes.

Response fields#

Returns 201 with CodeBatch

idstring (uuid)
offer_idstring (uuid)
prefixstring
quantityinteger
statusstring
created_atstring (date-time)

POST/v1/offers/{id}/code_batches

1
2
3
4curl -X POST https://api.unplugdining.com/v1/offers/e7d25a90-4c18-4b6f-8a3e-91f0c6b2d475/code_batches \
  -H "Authorization: Bearer $UNPLUG_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "prefix": "HOLIDAY", "quantity": 5000 }'

1
2
3
4
5
6
7
8
9const response = await fetch("https://api.unplugdining.com/v1/offers/e7d25a90-4c18-4b6f-8a3e-91f0c6b2d475/code_batches", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.UNPLUG_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ prefix: "HOLIDAY", quantity: 5000 }),
});
const data = await response.json();

1
2
3
4
5
6
7
8
9
10
11import os
import requests

response = requests.post(
    "https://api.unplugdining.com/v1/offers/e7d25a90-4c18-4b6f-8a3e-91f0c6b2d475/code_batches",
    headers={
        "Authorization": f"Bearer {os.environ['UNPLUG_KEY']}",
    },
    json={"prefix": "HOLIDAY", "quantity": 5000},
)
data = response.json()

Response JSON201

1
2
3
4
5
6
7
8{
  "id": "f6b0a9d2-4c37-4e18-9a5b-82d1c7e3f094",
  "offer_id": "e7d25a90-4c18-4b6f-8a3e-91f0c6b2d475",
  "prefix": "HOLIDAY",
  "quantity": 5000,
  "status": "generating",
  "created_at": "2026-11-04T17:30:12Z"
}

Error descriptions#

400Bad request

invalid_param

A prefix with characters other than letters and digits, or a quantity under 1.

400Bad request

invalid_request

The offer's distribution isn't unique_codes.

409Conflict

invalid_state

The offer has ended.

Any endpoint can also return the common errors.

400 Bad request

1
2
3
4
5
6
7{
  "type": "https://docs.unplugdining.com/reference/errors#invalid_param",
  "title": "Bad request",
  "status": 400,
  "code": "invalid_param",
  "detail": "A prefix with characters other than letters and digits, or a quantity under 1."
}