API ReferenceBuilding AppsInstalling IntercomAPI & Webhook ReferenceCanvas Kit Reference
DocsApp StoreForumBlogYour Apps

Data Attribute Model

Example Data Attribute Object

{
  "type": "data_attribute",
  "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 Attribute Object

A data attribute object contains the following fields -

AttributeTypeDescription
typestringValue is 'data_attribute'
idintegerThe unique identifier for the data attribute which is given by Intercom. Only available for custom attributes.
namestringname of the attribute

Examples:
email
region_name for region_name for stored in location_data object
image_url for image_url for stored in avatar object
paid_subscriber for CDA named paid_subscriber
full_namestringFull name of the attribute. Should match the name unless it's a nested attribute.

Examples:
email
location_data.region_name
avatar.image_url
custom_attributes.paid_subscriber

We can split full_name on . to access nested user object values.
Examples:
user['location_data']['region_name']
user['custom_attributes']['paid_subscriber']
labelstringReadable name of the attribute (i.e. name you see in the UI)
descriptionstringReadable description of the attribute
data_typestringType of data stored in the attribute.
Possible values:
string
integer
float
boolean
date
optionslistList of predefined options for attribute value.
Example:
["option_1", "option_2"]
api_writablebooleanCan this attribute be updated through API
ui_writablebooleanCan this attribute be updated in the UI
custombooleanSet to true if this is a CDA
archivedbooleanOnly applicable to CDAs
created_attimestampThe time the CDA was created.
Only applicable to CDAs.
updated_attimestampThe last time the CDA was updated.
Only applicable to CDAs.
admin_idstringTeammate who created the attribute.
Only applicable for CDAs