Skip to main content
PATCH
/
v1
/
misc
/
patch
curl --request PATCH \
  --url https://api.example.com/v1/misc/patch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "record_type": "accounts",
  "record_id": "550e8400-e29b-41d4-a716-446655440000",
  "active": false
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "active": true,
  "description": "<string>",
  "metadata": {},
  "modified_at": "2023-11-07T05:31:56Z",
  "modified_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

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:
{
  "category": "premium",
  "region": "europe",
  "tags": ["vip", "priority"]
}

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