Void a code batch Coming soon

POST/v1/offers/{id}/code_batches/{batch_id}/void

Stops every unused code in the batch from working, for example after a leak. Used codes keep their history. A voided code fails at checkout with 422 code_invalid.

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
batch_idstring (uuid)Required

Response fields#

Returns 200 with CodeBatch

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

POST/v1/offers/{id}/code_batches/{batch_id}/void

1
2curl -X POST https://api.unplugdining.com/v1/offers/e7d25a90-4c18-4b6f-8a3e-91f0c6b2d475/code_batches/f6b0a9d2-4c37-4e18-9a5b-82d1c7e3f094/void \
  -H "Authorization: Bearer $UNPLUG_KEY"

1
2
3
4
5
6
7const response = await fetch("https://api.unplugdining.com/v1/offers/e7d25a90-4c18-4b6f-8a3e-91f0c6b2d475/code_batches/f6b0a9d2-4c37-4e18-9a5b-82d1c7e3f094/void", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.UNPLUG_KEY}`,
  },
});
const data = await response.json();

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

response = requests.post(
    "https://api.unplugdining.com/v1/offers/e7d25a90-4c18-4b6f-8a3e-91f0c6b2d475/code_batches/f6b0a9d2-4c37-4e18-9a5b-82d1c7e3f094/void",
    headers={
        "Authorization": f"Bearer {os.environ['UNPLUG_KEY']}",
    },
)
data = response.json()

Response JSON200

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": "void",
  "created_at": "2026-11-04T17:30:12Z"
}

Error descriptions#

404Not found

not_found

No such offer or batch.

Any endpoint can also return the common errors.

404 Not found

1
2
3
4
5
6
7{
  "type": "https://docs.unplugdining.com/reference/errors#not_found",
  "title": "Not found",
  "status": 404,
  "code": "not_found",
  "detail": "No such offer or batch."
}