Sign in

v51

latestOpenAPI 3.0.1MITraw.githubusercontent.com2026-08-01150230854.3 KB
Data Attributes

Update a data attribute

You can update a data attribute.

🚧 Updating the data type is not possible

It is currently a dangerous action to execute changing a data attribute's type via the API. You will need to update the type via the UI instead.

put/data_attributes/{data_attribute_id}

Path parameters

data_attribute_idinteger required

The data attribute id

Headers

Intercom-Version'1.0' | '1.1' | '1.2' | '1.3' | '1.4' | '2.0' | '2.1' | '2.2' | '2.3' | '2.4' | '2.5' | '2.6' | '2.7' | '2.8' | '2.9' | '2.10' | '2.11' | '2.12' | '2.13' | '2.14'

Intercom API version.</br>By default, it's equal to the version set in the app package.

Example:2.14

Request body

OR

Example request

{
  "description": "My Data Attribute Description",
  "options": [
    {
      "value": "1-10"
    },
    {
      "value": "11-50"
    }
  ]
}

Response

Successful

type'data_attribute'

Value is data_attribute.

idinteger

The unique identifier for the data attribute which is given by Intercom. Only available for custom attributes.

model'contact' | 'company'

Value is contact for user/lead attributes and company for company attributes.

namestring

Name of the attribute.

full_namestring

Full name of the attribute. Should match the name unless it's a nested attribute. We can split full_name on . to access nested user object values.

labelstring

Readable name of the attribute (i.e. name you see in the UI)

descriptionstring

Readable description of the attribute.

data_type'string' | 'integer' | 'float' | 'boolean' | 'date'

The data type of the attribute.

optionsstring[]

List of predefined options for attribute value.

api_writableboolean

Can this attribute be updated through API

messenger_writableboolean

Can this attribute be updated by the Messenger

ui_writableboolean

Can this attribute be updated in the UI

customboolean

Set to true if this is a CDA

archivedboolean

Is this attribute archived. (Only applicable to CDAs)

created_atinteger

The time the attribute was created as a UTC Unix timestamp

updated_atinteger

The time the attribute was last updated as a UTC Unix timestamp

admin_idstring

Teammate who created the attribute. Only applicable to CDAs

Example response

{
  "type": "data_attribute",
  "id": 12878,
  "model": "contact",
  "name": "paid_subscriber",
  "full_name": "custom_attributes.paid_subscriber",
  "label": "Paid Subscriber",
  "description": "Whether the user is a paid subscriber.",
  "data_type": "boolean",
  "options": [
    "true",
    "false"
  ],
  "api_writable": true,
  "ui_writable": true,
  "custom": true,
  "created_at": 1671028894,
  "updated_at": 1671028894,
  "admin_id": "5712945"
}