Update CRM Object Attribute - Zeeg Developer Hub

PATCH

crm

objects

{slug}

attributes

{attributeKey}

Update an attribute on a CRM object

curl --request PATCH \
  --url https://api.zeeg.me/v2/crm/objects/{slug}/attributes/{attributeKey} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "Status",
  "isRequired": true,
  "isArchived": false,
  "options": [
    {
      "value": "Active",
      "color": "success",
      "id": 1
    }
  ],
  "relatedObjectLabel": "Contact Person",
  "currencyDisplay": "code",
  "currencyDecimal": false,
  "currencyGrouping": false
}
'

{
  "success": true,
  "status": 200,
  "attribute": {
    "key": "customer_status",
    "label": "Status",
    "type": "select",
    "isRequired": true,
    "isStandard": false,
    "isUnique": false,
    "isArchived": false,
    "options": [
      {
        "id": 1,
        "value": "Lead",
        "color": "warning"
      },
      {
        "id": 2,
        "value": "Active",
        "color": "success"
      },
      {
        "id": 3,
        "value": "Churned",
        "color": "red"
      }
    ],
    "createdAt": "2025-06-15T10:00:00+00:00",
    "updatedAt": "2025-06-20T14:00:00+00:00"
  }
}

Partially updates a single attribute definition. Only the fields you include are changed.

Updatable fields

Field	Applies to	Notes
`label`	All types
`isRequired`	All types
`isArchived`	All types	Archived attributes are hidden in the UI but data is retained
`options`	`select`, `multiselect`, `status`	Full replacement — see below
`relatedObjectLabel`	`relation`	Display label shown in the UI for the linked object
`currencyDisplay`	`currency`	`code`, `name`, or `symbol`
`currencyDecimal`	`currency`	Show decimal places
`currencyGrouping`	`currency`	Use thousands separator

Immutable fields

Field	Reason
`type`	Changing type would corrupt existing record data
`key`	Used as the stable identifier in all record values
`relatedObjectSlug`	Changing the target would orphan existing linked records
`currency`	Changing the currency code would make stored amounts misleading

Updating options (`select` / `multiselect` / `status`)

When you send options, the list fully replaces the current options:

Include id on existing options you want to keep — existing record values are preserved.
Omit id for new options — the server assigns a new ID.
Exclude an option entirely to delete it — existing records that held that value will have the value cleared.

{
  "options": [
    { "id": 12, "value": "Active",   "color": "success" },
    { "id": 13, "value": "On Hold",  "color": "warning" },
    {           "value": "Churned",  "color": "gray"    }
  ]
}

Standard attributes

Standard attributes (e.g. first_name, emails on people) cannot be updated and return 400.

Authorizations

Authorization

string

header

required

Path Parameters

slug

string

required

The object slug.

Example:

"people"

attributeKey

string

required

The attribute key (slug) to update. Retrieve available keys from GET /crm/objects/{slug}.

Example:

"customer_status"

Body

application/json

label

string

New display label.

Maximum string length: 255

Example:

"Status"

isRequired

boolean

Whether a value is required when creating a record.

Example:

true

isArchived

boolean

Set to true to hide this attribute from the UI without deleting data.

Example:

false

options

object[]

Replacement options list for select, multiselect, and status types. Include existing option id values to preserve them.

Hide child attributes

options.value

string

required

The option label shown in the UI and stored as the attribute value.

Maximum string length: 512

Example:

"Active"

options.color

string

required

Color name for the option. Allowed values: gray, primary, warning, success, cyan, sky, violet, fuchsia, rose, blue, green, red, pink, black, yellow, orange.

Example:

"success"

options.id

integer | null

Server-assigned option ID. Omit when adding a new option; include when updating an existing one to preserve it.

Example:

1

relation only — updated display label for the linked object. The target object (relatedObjectSlug) cannot change.

Maximum string length: 255

Example:

"Contact Person"

currencyDisplay

enum<string>

currency only — how the currency value is shown: code, name, or symbol.

Available options:

code,

name,

symbol

Example:

"code"

currencyDecimal

boolean

currency only — show decimal places.

Example:

false

currencyGrouping

boolean

currency only — use a thousands separator.

Example:

false

Response

success

boolean

Example:

true

status

integer

Example:

200

attribute

object

Definition of a single attribute on a CRM object.

Hide child attributes

attribute.key

string

required

Attribute key used when reading or writing record values.

Example:

"job_title"

attribute.label

string

required

Human-readable label shown in the UI.

Example:

"Job Title"

attribute.type

enum<string>

required

Attribute data type. Cannot be changed after creation.

Available options:

text,

number,

phone_number,

date,

datetime,

checkbox,

select,

multiselect,

rating,

relation,

status,

user,

currency

Example:

"text"

attribute.isRequired

boolean

required

Whether a value is required when creating a record.

Example:

false

attribute.isStandard

boolean

required

true for built-in attributes, false for custom attributes added by your workspace.

Example:

false

attribute.isUnique

boolean

required

Whether values must be unique across all records. Applies to text, phone, and number types.

Example:

false

attribute.isArchived

boolean

required

Whether the attribute is archived. Archived attributes are hidden from the UI but their data is preserved.

Example:

false

attribute.createdAt

string<date-time>

required

ISO 8601 timestamp when the attribute was created.

Example:

"2025-06-01T10:00:00+00:00"

attribute.updatedAt

string<date-time>

required

ISO 8601 timestamp when the attribute was last updated.

Example:

"2025-06-01T10:00:00+00:00"

attribute.options

object[]

Available options. Present only for select, multiselect, and status attributes.

Hide child attributes

attribute.options.value

string

required

The option label shown in the UI and stored as the attribute value.

Maximum string length: 512

Example:

"Active"

attribute.options.color

string

required

Color name for the option. Allowed values: gray, primary, warning, success, cyan, sky, violet, fuchsia, rose, blue, green, red, pink, black, yellow, orange.

Example:

"success"

attribute.options.id

integer | null

Server-assigned option ID. Omit when adding a new option; include when updating an existing one to preserve it.

Example:

1

Slug of the related object. Present only for relation attributes. Immutable after creation.

Example:

"companies"

Display label for the relation. Present only for relation attributes. Can be updated via PATCH.

Example:

"Company"

attribute.relationType

enum<string> | null

Cardinality of the relation. Present only for relation attributes.

Available options:

one_to_one,

many_to_one,

one_to_many,

many_to_many

Example:

"many_to_one"

attribute.isMultipleSelection

boolean

true when relationType is one_to_many or many_to_many. Present only for relation attributes.

Example:

false

attribute.currency

string | null

ISO 4217 currency code. Present only for currency attributes. Immutable after creation.

Example:

"EUR"

attribute.currencyDisplay

enum<string> | null

How the currency value is displayed. Present only for currency attributes.

Available options:

code,

name,

symbol

Example:

"symbol"

attribute.currencyDecimal

boolean | null

Whether decimal places are shown. Present only for currency attributes.

Example:

true

attribute.currencyGrouping

boolean | null

Whether a thousands separator is used. Present only for currency attributes.

Example:

true

Last modified on May 14, 2026

Add Attribute to CRM Object

List CRM Companies

Update an attribute on a CRM object

curl --request PATCH \
  --url https://api.zeeg.me/v2/crm/objects/{slug}/attributes/{attributeKey} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "Status",
  "isRequired": true,
  "isArchived": false,
  "options": [
    {
      "value": "Active",
      "color": "success",
      "id": 1
    }
  ],
  "relatedObjectLabel": "Contact Person",
  "currencyDisplay": "code",
  "currencyDecimal": false,
  "currencyGrouping": false
}
'

{
  "success": true,
  "status": 200,
  "attribute": {
    "key": "customer_status",
    "label": "Status",
    "type": "select",
    "isRequired": true,
    "isStandard": false,
    "isUnique": false,
    "isArchived": false,
    "options": [
      {
        "id": 1,
        "value": "Lead",
        "color": "warning"
      },
      {
        "id": 2,
        "value": "Active",
        "color": "success"
      },
      {
        "id": 3,
        "value": "Churned",
        "color": "red"
      }
    ],
    "createdAt": "2025-06-15T10:00:00+00:00",
    "updatedAt": "2025-06-20T14:00:00+00:00"
  }
}

Documentation Index

​Updatable fields

​Immutable fields

​Updating options (select / multiselect / status)

​Standard attributes

Authorizations

Path Parameters

Body

Response

Updatable fields

Immutable fields

Updating options (`select` / `multiselect` / `status`)

Standard attributes