Home
/
REST API Reference
/
Data Attributes
/
Create a data attribute

Create a data attribute

You can create a data attributes for a contact or a company.

SecurityHTTP: bearerAuth
Request
header Parameters
Intercom-Version
string (intercom_version)
Default: 2.11

Intercom API version.
By default, it's equal to the version set in the app package.

Enum: "1.0" "1.1" "1.2" "1.3" "1.4" "2.0" "2.1" "2.2" "2.3" "2.4" "2.5" "2.6" "2.7" "2.8" "2.9" "2.10" "2.11" "Unstable"
Example: 2.11
Request Body schema: application/json
name
required
string

The name of the data attribute.

model
required
string

The model that the data attribute belongs to.

Enum: "contact" "company"
data_type
required
string

The type of data stored for this attribute.

Enum: "string" "integer" "float" "boolean" "datetime" "date"
description
string

The readable description you see in the UI for the attribute.

options
Array of strings

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.

messenger_writable
boolean

Can this attribute be updated by the Messenger

post
/data_attributes
Request samples
application/json
{
"name": "Mithril Shirt",
"model": "company",
"data_type": "string"
}
Responses

200

Successful

Response Schema: application/json
type
string

Value is data_attribute.

Value: "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 and company for company attributes.

Enum: "contact" "company"
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.

Enum: "string" "integer" "float" "boolean" "date"
options
Array of strings

List of predefined options for attribute value.

api_writable
boolean

Can this attribute be updated through API

messenger_writable
boolean

Can this attribute be updated by the Messenger

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 <date-time>

The time the attribute was created as a UTC Unix timestamp

updated_at
integer <date-time>

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

admin_id
string

Teammate who created the attribute. Only applicable to CDAs

400

Too few options for list

401

Unauthorized

Response samples
application/json
{
"id": 165,
"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": false,
"custom": true,
"archived": false,
"admin_id": "991271770",
"created_at": 1715077973,
"updated_at": 1715077973,
"model": "company"
}