Skip to main content
POST
Add records to a list

Authorizations

Authorization
string
header
required

A Custral API key, created in Settings → Developers → Applications, sent as Authorization: Bearer sk_…. The X-Api-Key header is also accepted and takes precedence. Use a secret key (sk_…) from your server; a publishable key (pk_…) may hold only objects:read and usage:write. Never expose a secret key in a browser.

Path Parameters

id
string
required

The list's id.

Body

application/json
recordIds
string[]
required

Up to 500 record ids.

Required array length: 1 - 500 elements
Maximum string length: 64

Response

200 - application/json

What changed, record by record.

data
object

What an add or remove did, record by record. One bad id never fails the rest.

reqId
string

A per-request id (req_…). Quote it to support when reporting a problem.

Example:

"req_2a1f9c8e7b6d5"