Skip to content
Home/
REST API Reference
/
/
Create a conversation att...

Create a conversation attribute

Request

Create a new conversation attribute.

Security
bearerAuth
Headers
Intercom-Versionstring(intercom_version)

Intercom API version.
If you omit the header, the API uses the version set in your app package, and 1.0 if none is set.

Enum:"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"
Example:2.17
Bodyapplication/jsonrequired
namestringrequired

Name of the attribute.

Example:"api_test_attr"
descriptionstring

Readable description of the attribute.

Example:"Created via API test"
data_typestringrequired

The data type of the attribute. Allowed types: string, integer, list, decimal, boolean, datetime, relationship, files.

Value:"string"
Example:"string"
Discriminator
requiredboolean

Whether this attribute is required.

Example:false
visible_to_team_idsArray of strings

Team IDs that can see this attribute. Empty array means all teams.

Example:
[]
multilineboolean

Whether this string attribute is multiline.

Example:false
curl -i -X POST \
  https://api.intercom.io/conversations/attributes \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Intercom-Version: 2.17' \
  -d '{
    "name": "api_test_attr",
    "data_type": "string",
    "description": "Created via API test"
  }'

Responses

Successful response

Bodyapplication/json
typestring

Value is conversation_attribute.

Value:"conversation_attribute"
Example:"conversation_attribute"
idinteger

The unique identifier for the conversation attribute.

Example:8
namestring

Name of the attribute.

Example:"api_test_attr"
descriptionstring

Readable description of the attribute.

Example:"Created via API test"
data_typestring

The data type of the attribute. Allowed types: string, integer, list, decimal, boolean, datetime, relationship, files.

Value:"string"
Example:"string"
Discriminator
requiredboolean

Whether this attribute is required.

Example:false
visible_to_team_idsArray of strings

Team IDs that can see this attribute. Empty array means all teams.

Example:
[]
archivedboolean

Whether this attribute is archived.

Example:false
created_atinteger, (date-time)

The time the attribute was created as a UTC Unix timestamp.

Example:1778239701
updated_atinteger, (date-time)

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

Example:1778239701
admin_idstring or null

ID of the admin who created the attribute, or null if there isn't one.

Example:"16"
multilineboolean

Whether this string attribute is multiline.

Example:false
Response
{
  "type": "conversation_attribute",
  "id": 8,
  "name": "api_test_attr",
  "description": "Created via API test",
  "data_type": "string",
  "required": false,
  "visible_to_team_ids": [],
  "archived": false,
  "created_at": 1778239701,
  "updated_at": 1778239701,
  "admin_id": "16",
  "multiline": false
}