Skip to main content
PATCH

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
record_type
string
required

Type of record to update

Example:

"customers"

record_id
string<uuid>
required

UUID of the record to update

Example:

"550e8400-e29b-41d4-a716-446655440000"

active
boolean

Active status of the record

Example:

true

description
string

Description of the record

Example:

"Updated description"

metadata
object

Custom metadata for the record

Example:

Response

Fields updated successfully

id
string<uuid>

UUID of the updated record

active
boolean

Current active status

description
string

Current description

metadata
object

Current metadata

modified_at
string<date-time>

Last modification timestamp

modified_by
string<uuid>

UUID of the user who made the modification