Updating Resources

The CRMchat API uses JSON Merge Patch (RFC 7396) for partial updates via PATCH endpoints.

TL;DR

• Send a PATCH request with Content-Type: application/merge-patch+json.
• Include only the fields you want to change.
• Send null to remove a field.

Content Type

Per RFC 7396, PATCH requests should use:

Content-Type: application/merge-patch+json

For convenience, application/json is also accepted with the same merge-patch semantics. Requests with any other Content-Type receive a 415 Unsupported Media Type response.

Example

curl -X PATCH https://api.crmchat.ai/v1/organizations/abc123 \
  -H "Authorization: Bearer sk_your_api_key" \
  -H "Content-Type: application/merge-patch+json" \
  -d '{ "name": "New Name" }'

{
  "data": {
    "id": "abc123",
    "name": "New Name",
    "createdAt": "2026-03-12T10:00:00.000Z",
    "updatedAt": "2026-03-12T10:05:00.000Z"
  }
}

Removing Fields

Per RFC 7396, sending null for a key means "remove this field". Only optional fields can be set to null — required fields reject null values with a 400 error.

For nested objects, sending null for the parent removes all fields inside it. You can also target individual subfields:

{ "telegram": { "id": null } }

{ "telegram": null }

Updating Arrays

JSON Merge Patch does not support partial array updates — there is no way to add, remove, or reorder individual items. When a field is an array, you must always send the complete replacement array.

{ "tags": ["vip", "enterprise"] }

Sending a partial array does not merge — it overwrites. If you send ["vip"] when the current value is ["vip", "enterprise"], the result is ["vip"].

To remove all items, send an empty array:

{ "tags": [] }

Unknown Fields

Unknown or non-writable fields in the request body are silently ignored, consistent with the merge-patch philosophy of "ignore what you don't understand".

Error Responses