DocsBuilding 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 -

Attribute

Type

Description

type

string

Value is 'data_attribute'

name

string

name 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_name

string

Full 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’]

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

Type of data stored in the attribute.
Possible values:
string
integer
float
boolean
date

options

list

List of predefined options for attribute value.
Example:
[“option_1”, “option_2”]

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

Only applicable to CDAs

created_at

timestamp

The time the CDA was created.
Only applicable to CDAs.

updated_at

timestamp

The last time the CDA was updated.
Only applicable to CDAs.

admin_id

string

Teammate who created the attribute.
Only applicable for CDAs