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"
}{
"code": "misc.invalid_record_type",
"message": "Invalid record type provided",
"details": {
"record_type": "invalid_type"
}
}{
"code": "misc.invalid_record_type",
"message": "Invalid record type provided",
"details": {}
}{
"code": "misc.invalid_record_type",
"message": "Invalid record type provided",
"details": {}
}{
"code": "misc.record_not_found",
"message": "Record not found",
"details": {
"record_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"code": "misc.no_fields_to_update",
"message": "No fields provided for update"
}{
"code": "misc.update_failed",
"message": "Failed to update record"
}Record Management
Update record fields
Update common fields for any record type with proper authorization checks
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"
}{
"code": "misc.invalid_record_type",
"message": "Invalid record type provided",
"details": {
"record_type": "invalid_type"
}
}{
"code": "misc.invalid_record_type",
"message": "Invalid record type provided",
"details": {}
}{
"code": "misc.invalid_record_type",
"message": "Invalid record type provided",
"details": {}
}{
"code": "misc.record_not_found",
"message": "Record not found",
"details": {
"record_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"code": "misc.no_fields_to_update",
"message": "No fields provided for update"
}{
"code": "misc.update_failed",
"message": "Failed to update record"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Type of record to update
Example:
"customers"
UUID of the record to update
Example:
"550e8400-e29b-41d4-a716-446655440000"
Active status of the record
Example:
true
Description of the record
Example:
"Updated description"
Custom metadata for the record
Example:
{
"category": "premium",
"region": "europe",
"tags": ["vip", "priority"]
}
Response
Fields updated successfully