Skip to main content
POST
Add Batch Records

Headers

authorization
string | null
X-Organization-ID
string | null

Path Parameters

key
string
required

Cookies

stytch_session
string | null

Body

application/json
product_keys
string[]
Maximum array length: 10000
product_versions
Product Versions · object | null

Response

Successful Response

Response for POST /api/catalog/batches/{key}/records.

Catalog is a PUBLIC API tag, so this route is in the published OpenAPI spec and the vendored SDK. The route was previously an untyped passthrough returning {added, skipped_already_in_batch, skipped_not_found, records}; typing it renamed one field and dropped another, which would have silently broken external SDK/curl consumers. Both legacy fields are retained here as deprecated duplicates of the new ones so the change is genuinely additive.

added
integer
required
skipped_existing
integer
required
skipped_not_found
integer
required
total_items
integer
required
not_found_keys
string[]
Maximum array length: 200
records
Records · object[]

DEPRECATED — the catalog batch records created by this call, retained for backwards compatibility with pre-existing API consumers. Prefer GET /api/catalog/batches/{key}/records, which paginates; this field is unbounded and echoes every newly created record (the request accepts up to 10,000 keys). Empty when no new records were created.

skipped_already_in_batch
integer
default:0

DEPRECATED — the original name of this field, retained for backwards compatibility with pre-existing API consumers. Always equal to skipped_existing; use that instead.