Skip to main content
POST
Create a record

Authorizations

Authorization
string
header
required

A Custral secret API key (sk_…), created in Settings → Applications. Sent as Authorization: Bearer sk_…. The X-Api-Key: sk_… header is also accepted and takes precedence. Never expose a secret key in a browser.

Path Parameters

object
string
required

The target object — its id (obj_…), key, or name (e.g. contacts).

Body

application/json

The body of a create-record request. The target object is supplied in the path.

fields
object
required

A {property: value} map. Keys may be a property id, key, or name.

Example:
name
string

An optional explicit record name.

Example:

"Jane Doe"

Response

The created record's id and any ignored field keys.

data
object

The result of a create.

reqId
string

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

Example:

"req_2a1f9c8e7b6d5"