.svg?fit=max&auto=format&n=9voKLLkajreclhp4&q=85&s=321632804eda4b3cff044941f9ccadda)
Update a CRM Object
Partially updates a custom CRM object’s metadata. Only the fields you provide are updated — omitted fields retain their current values.
Standard objects (people, companies) cannot be updated.
Required scope: crm:write
curl --request PATCH \
--url https://api.zeeg.me/v2/crm/objects/{slug} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"singularName": "Product",
"pluralName": "Products"
}
'{
"success": true,
"status": 200,
"object": {
"slug": "products",
"singularName": "Product",
"pluralName": "Products",
"isStandard": false,
"isActive": true,
"attributes": [
{
"key": "title",
"label": "Title",
"type": "text",
"isRequired": true,
"isStandard": false
}
],
"createdAt": "2025-06-01T10:00:00+00:00",
"updatedAt": "2025-06-15T14:30:00+00:00"
}
}Partially updates a custom CRM object’s display metadata. Only fields you include are changed — omitted fields retain their current values.Documentation Index
Fetch the complete documentation index at: https://developer.zeeg.me/llms.txt
Use this file to discover all available pages before exploring further.
What can and cannot be changed
| Field | Updatable | Notes |
|---|---|---|
singularName | Yes | |
pluralName | Yes | |
slug | No | Immutable after creation |
isActive | No | Not exposed on this endpoint |
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
Path Parameters
The slug of the custom object to update.
"products"
Body
Response
OK
true
200
A CRM object definition including its full attribute schema.
Hide child attributes
Hide child attributes
Unique identifier for the object. Used in all record API calls.
"people"
Singular display name.
"Person"
Plural display name.
"People"
true for built-in objects (people, companies). false for custom objects.
true
Whether the object is enabled in the workspace.
true
Full list of attribute definitions for this object.
Hide child attributes
Hide child attributes
Attribute key used when reading or writing record values.
"job_title"
Human-readable label shown in the UI.
"Job Title"
Attribute data type. Cannot be changed after creation.
text, number, phone_number, date, datetime, checkbox, select, multiselect, rating, relation, status, user, currency "text"
Whether a value is required when creating a record.
false
true for built-in attributes, false for custom attributes added by your workspace.
false
Whether values must be unique across all records. Applies to text, phone, and number types.
false
Whether the attribute is archived. Archived attributes are hidden from the UI but their data is preserved.
false
ISO 8601 timestamp when the attribute was created.
"2025-06-01T10:00:00+00:00"
ISO 8601 timestamp when the attribute was last updated.
"2025-06-01T10:00:00+00:00"
Available options. Present only for select, multiselect, and status attributes.
Hide child attributes
Hide child attributes
The option label shown in the UI and stored as the attribute value.
512"Active"
Color name for the option. Allowed values: gray, primary, warning, success, cyan, sky, violet, fuchsia, rose, blue, green, red, pink, black, yellow, orange.
"success"
Server-assigned option ID. Omit when adding a new option; include when updating an existing one to preserve it.
1
Slug of the related object. Present only for relation attributes. Immutable after creation.
"companies"
Display label for the relation. Present only for relation attributes. Can be updated via PATCH.
"Company"
Cardinality of the relation. Present only for relation attributes.
one_to_one, many_to_one, one_to_many, many_to_many "many_to_one"
true when relationType is one_to_many or many_to_many. Present only for relation attributes.
false
ISO 4217 currency code. Present only for currency attributes. Immutable after creation.
"EUR"
How the currency value is displayed. Present only for currency attributes.
code, name, symbol "symbol"
Whether decimal places are shown. Present only for currency attributes.
true
Whether a thousands separator is used. Present only for currency attributes.
true
"2025-01-15T09:00:00+00:00"
"2025-06-01T12:00:00+00:00"
curl --request PATCH \
--url https://api.zeeg.me/v2/crm/objects/{slug} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"singularName": "Product",
"pluralName": "Products"
}
'{
"success": true,
"status": 200,
"object": {
"slug": "products",
"singularName": "Product",
"pluralName": "Products",
"isStandard": false,
"isActive": true,
"attributes": [
{
"key": "title",
"label": "Title",
"type": "text",
"isRequired": true,
"isStandard": false
}
],
"createdAt": "2025-06-01T10:00:00+00:00",
"updatedAt": "2025-06-15T14:30:00+00:00"
}
}