Skip to main content
PATCH
Update 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 object the record belongs to — its id, key, or name.

id
string
required

The record id (rec_…).

Body

application/json

The body of an update-record request. The object + id are in the path.

fields
object

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

Example:
name
string

A new display name for the record.

Response

The update result.

data
object

The result of an update.

reqId
string

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

Example:

"req_2a1f9c8e7b6d5"