Skip to main content
PATCH
Update a record

Authorizations

Authorization
string
header
required

An admin application key: Authorization: Api-Key <token> (or legacy x-api-key). Only tenant owners and admins can create one. Standard keys are refused with 403 on workspace management and tenant configuration routes.

Path Parameters

orgId
string
required

The organization (tenant) id. Must equal the tenant of the admin key.

listId
string
required

The custom list id.

recordId
string
required

The record id (id of a record, not its record_uid).

Body

application/json

name and entity_type are always required. Creating also requires record_uid. An update replaces the record's fields with this body rather than merging into them, so a field left out is cleared: send the full record every time. aliases and countries are stored pipe-joined.

record_uid
string
name
string
entity_type
enum<string>
Available options:
individual,
organization,
unknown
aliases
string[]
countries
string[]
date_of_birth
string
date_of_incorporation
string
reason
string
notes
string
custom_fields
object

Response

Success

{ data: CustomListRecord }

data
object
required