Skip to content
Home/
REST API Reference
/
/
Data Attribute

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.

typestring

Value is data_attribute.

Value:"data_attribute"
Example:"data_attribute"
idinteger

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

Example:12878
modelstring

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

Enum:"contact""company"
Example:"contact"
namestring

Name of the attribute.

Example:"paid_subscriber"
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.

Example:"custom_attributes.paid_subscriber"
labelstring

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

Example:"Paid Subscriber"
descriptionstring

Readable description of the attribute.

Example:"Whether the user is a paid subscriber."
data_typestring

The data type of the attribute.

Enum:"string""integer""float""boolean""date"
Example:"boolean"
optionsArray of strings

List of predefined options for attribute value.

Example:
[
  "true",
  "false"
]
api_writableboolean

Can this attribute be updated through API

Example:true
messenger_writableboolean

Can this attribute be updated by the Messenger

Example:false
ui_writableboolean

Can this attribute be updated in the UI

Example:true
customboolean

Set to true if this is a CDA

Example:true
archivedboolean

Is this attribute archived. (Only applicable to CDAs)

Example:false
created_atinteger, (date-time)

The time the attribute was created as a UTC Unix timestamp

Example:1671028894
updated_atinteger, (date-time)

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

Example:1671028894
admin_idstring

Teammate who created the attribute. Only applicable to CDAs

Example:"5712945"
{
  "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"
}