Skip to main content
PATCH
Update a custom CRM object
Partially updates a custom CRM object’s display metadata. Only fields you include are changed — omitted fields retain their current values.

What can and cannot be changed

Standard objects (people, companies) cannot be updated — the endpoint returns 403. To add or modify attributes, use POST /crm/objects/{slug}/attributes and PATCH /crm/objects/{slug}/attributes/{attributeKey}.

Authorizations

Authorization
string
header
required

Path Parameters

slug
string
required

The slug of the custom object to update.

Example:

"products"

Body

application/json
singularName
string

New singular display name.

Maximum string length: 255
Example:

"Product"

pluralName
string

New plural display name.

Maximum string length: 255
Example:

"Products"

titleAttribute
string

Key of the attribute that names each record and that search on the records list matches. It must be a required text, number or phone_number attribute; anything else returns 422.

Maximum string length: 255
Example:

"name"

Response

OK

success
boolean
Example:

true

status
integer
Example:

200

object
object

A CRM object definition including its full attribute schema.

Last modified on June 11, 2026