Example Data Attribute Object
{
"type": "data_attribute",
"model": "contact",
"name": "paid_subscriber",
"full_name": "custom_attributes.paid_subscriber",
"label": "paid_subscriber",
"description": "",
"data_type": "string",
"options": [
"pick_value_1",
"pick_value_2"
],
"api_writable": true,
"ui_writable": true,
"custom": true,
"archived": false,
"admin_id": "1",
"created_at": 1392734388,
"updated_at": 1392734388
}
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.
Object Models
Data Attribute
| Field | Type | Description |
|---|---|---|
| type | string | Value is 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, company for company attributes and conversation for conversation attributes.. |
| 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. |
| options | array | List of predefined options for attribute value. |
| api_writable | boolean | Can this attribute be updated through API |
| 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 | The time the attribute was created as a UTC Unix timestamp |
| updated_at | integer | The time the attribute was last updated as a UTC Unix timestamp |
| admin_id | string | Teammate who created the attribute. Only applicable to CDAs |