API ReferenceEndpointsPublic API (v1)Disable or reactivate many gift cards

Disable or reactivate many gift cards

DISABLED stops new holds; ACTIVE returns a card to service. REVOKED is not accepted in bulk — it belongs to re-issue, which moves the balance to a replacement first. There is no delete, here or anywhere: the ledger is append-only and a card may carry a statutory retention life.

PATCH
/v1/gift-cards/bulk/status
AuthorizationBearer <token>

Admin API key (server-to-server). Issue via the dashboard at Settings → API keys. Plain-text key is shown once — store in a secret manager. Format: Authorization: Bearer brainerce_xxxxxxxxx.

In: header

Header Parameters

Idempotency-Key?string

Client-supplied key (a UUID v4 is the recommended form, max 255 characters) that makes this mutation safe to retry.

  • Replay window: 24 hours. The first response for a key is cached; a retry inside the window with the same request body returns the original status and body without re-running the handler.
  • Reusing a key with a different body returns 409 Conflict with code: "IDEMPOTENCY_KEY_REUSED". The request fingerprint (method + path + body hash) is compared against the stored one; a mismatch is refused rather than served the old response.
  • Keys are scoped to the calling credential and store — two API keys may safely use the same key value.
  • Error responses are cached too, so a retry of a request that failed validation returns the same 400 immediately.
  • Sending this header on a GET returns 400 with code: "IDEMPOTENCY_KEY_NOT_SUPPORTED" — GETs are already idempotent.
  • Support is per-route and this parameter is the authoritative signal: a key sent to a route that does not declare it is accepted and silently ignored.

See /docs/api/idempotency.

Lengthlength <= 255
giftCardIdsarray<string>

Gift card ids to update.

Itemsitems <= 200
statusstring

DISABLED stops new holds; ACTIVE puts the card back in service. REVOKED is deliberately not accepted in bulk — it belongs to re-issue, which moves the balance to a replacement first.

Value in"ACTIVE" | "DISABLED"
curl -X PATCH "https://api.brainerce.com/api/v1/gift-cards/bulk/status" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "giftCardIds": [      "clx1a2b3c4d5e6f7g8h9"    ],    "status": "ACTIVE"  }'
{
  "updated": 3
}

{
  "statusCode": 400,
  "code": "VALIDATION_FAILED",
  "message": "name should not be empty, price must be a positive number",
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/v1/gift-cards/bulk/status"
}

{
  "statusCode": 401,
  "code": "UNAUTHORIZED",
  "message": "Invalid or expired credential",
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/v1/products/bulk/{jobId}"
}

{
  "statusCode": 403,
  "code": "INSUFFICIENT_SCOPE",
  "message": "API key does not have the required scope: products:write",
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/v1/gift-cards/bulk/status"
}

{
  "statusCode": 429,
  "code": "RATE_LIMITED",
  "message": "Too many requests",
  "details": {
    "retryAfterSeconds": 12
  },
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/v1/store"
}