Data Attribute

Data Attributes are metadata used to describe your contact, company and conversation models. These include standard and custom attributes. By using the data attributes endpoint, you can get the global list of attributes for your workspace, as well as create and archive custom attributes.

type
string

Value is data_attribute.

Value: "data_attribute"
id
integer

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

model
string

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

Enum: "contact" "company"
name
string

Name of the attribute.

full_name
string

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.

label
string

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

description
string

Readable description of the attribute.

data_type
string

The data type of the attribute.

Enum: "string" "integer" "float" "boolean" "date"
options
Array of strings

List of predefined options for attribute value.

api_writable
boolean

Can this attribute be updated through API

messenger_writable
boolean

Can this attribute be updated by the Messenger

ui_writable
boolean

Can this attribute be updated in the UI

custom
boolean

Set to true if this is a CDA

archived
boolean

Is this attribute archived. (Only applicable to CDAs)

created_at
integer <date-time>

The time the attribute was created as a UTC Unix timestamp

updated_at
integer <date-time>

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

admin_id
string

Teammate who created the attribute. Only applicable to CDAs

{ "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, "messenger_writable": false, "ui_writable": true, "custom": true, "archived": false, "created_at": 1671028894, "updated_at": 1671028894, "admin_id": "5712945" }