Update a data attribute

REST API Reference

You can update a data attribute.

🚧 Updating the data type is not possible
It is currently a dangerous action to execute changing a data attribute's type via the API. You will need to update the type via the UI instead.

SecurityHTTP: bearerAuth

Request

path Parameters

required

integer

The data attribute id

Example: 1

header Parameters

Intercom-Version

string (intercom_version)

Default: 2.10

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" "Unstable"

Example: 2.10

Request Body schema: application/json

archived	boolean Whether the attribute is to be archived or not.
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

put

/data_attributes/{id}

Request samples
Payload
curl
Node.js
Ruby
PHP
Python
Java
Go
C#
R
5 more
application/json
Successful
{
"description": "Just a plain old ring",
"options": [
{
"value": "1-10"
},
{
"value": "11-20"
}
],
"archived": false
}

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 in list

401

Unauthorized

404

Attribute Not Found

422

Has Dependant Object

Response samples
200
400
401
404
422
application/json
Successful
{
"id": 527,
"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": "991282542",
"created_at": 1712223071,
"updated_at": 1712223072,
"model": "company"
}