The intercom API reference.
The intercom API reference.
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.
The unique identifier for the data attribute which is given by Intercom. Only available for custom attributes.
Value is contact
for user/lead attributes and company
for company attributes.
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.
Readable description of the attribute.
The data type of the attribute.
The time the attribute was created as a UTC Unix timestamp
The time the attribute was last updated as a UTC Unix timestamp
{ "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" }
curl -i -X GET \ 'https://api.intercom.io/data_attributes?include_archived=true&model=contact' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Intercom-Version: 2.8'
{ "type": "list", "data": [ { … }, { … }, { … }, { … }, { … }, { … }, { … }, { … }, { … }, { … }, { … }, { … }, { … }, { … }, { … }, { … }, { … } ] }
The model that the data attribute belongs to.
The type of data stored for this attribute.
The readable description you see in the UI for the attribute.
To create list attributes. Provide a set of hashes with value
as the key of the options you want to make. data_type
must be string
.
curl -i -X POST \ https://api.intercom.io/data_attributes \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -H 'Intercom-Version: 2.8' \ -d '{ "name": "Mithril Shirt", "model": "company", "data_type": "string" }'
Successful
The unique identifier for the data attribute which is given by Intercom. Only available for custom attributes.
Value is contact
for user/lead attributes and company
for company attributes.
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.
Readable description of the attribute.
The data type of the attribute.
The time the attribute was created as a UTC Unix timestamp
The time the attribute was last updated as a UTC Unix timestamp
{ "id": 21, "type": "data_attribute", "name": "Mithril Shirt", "full_name": "custom_attributes.Mithril Shirt", "label": "Mithril Shirt", "data_type": "string", "api_writable": true, "ui_writable": false, "messenger_writable": true, "custom": true, "archived": false, "admin_id": "991267031", "created_at": 1717021242, "updated_at": 1717021242, "model": "company" }
The readable description you see in the UI for the attribute.
To create list attributes. Provide a set of hashes with value
as the key of the options you want to make. data_type
must be string
.
curl -i -X PUT \ 'https://api.intercom.io/data_attributes/{id}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -H 'Intercom-Version: 2.8' \ -d '{ "description": "Just a plain old ring", "options": [ { "value": "1-10" }, { "value": "11-20" } ], "archived": false }'
Successful
The unique identifier for the data attribute which is given by Intercom. Only available for custom attributes.
Value is contact
for user/lead attributes and company
for company attributes.
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.
Readable description of the attribute.
The data type of the attribute.
The time the attribute was created as a UTC Unix timestamp
The time the attribute was last updated as a UTC Unix timestamp
{ "id": 28, "type": "data_attribute", "name": "The One Ring", "full_name": "custom_attributes.The One Ring", "label": "The One Ring", "description": "Just a plain old ring", "data_type": "string", "options": [ "1-10", "11-20" ], "api_writable": true, "ui_writable": false, "messenger_writable": true, "custom": true, "archived": false, "admin_id": "991267038", "created_at": 1717021245, "updated_at": 1717021245, "model": "company" }