v1

latestOpenAPI 3.1.02026-08-0458234268.6 KB

catalog

Bulk create/update catalog allowances (async)

Creates or updates multiple catalog allowances asynchronously. Returns 202 with batch tracking info. Maximum 1000 allowances per request. Poll GET /batch/{id}/progress for status.

Deprecation notice: The previous synchronous bulk API has been deprecated. This async endpoint is the recommended behavior going forward — it avoids timeouts on large batches and provides progress tracking via the batch polling API.

post/catalog/allowances/bulk

Headers

Authorizationstring required

OAuth2 authentication flows. Auth server URLs will vary by environment

X-Api-Keystring required

API key for authentication

X-API-Versionstring

API version to use (optional, defaults to latest). Supported values: 1.0.0, 1.1.0.

Idempotency-Keystring

Client-generated unique key (UUID/ULID recommended). JSON requests: the first 2xx response is cached for 24h and replayed on a same-key retry with a matching body; a different body returns 422. Non-JSON requests (e.g. file uploads): the key is single-use — any same-key retry returns 422 regardless of body. See Idempotency for full details.

Response

Asynchronous processing started. Poll batch_url for status.

versionstring required

API version of this response

statusstring required

Processing status

batch_idstring required

Unique identifier for this batch job. Use to poll for progress.

batch_urlstring required

URL to poll for batch progress (GET)

results_urlstring required

URL to retrieve batch results once completed (GET)