customer_request

Custom Attributes

An object containing the different custom attributes associated to the conversation as key-value pairs. For relationship attributes the value will be a list of custom object instance models.

property name*string or Custom Object Instance (object)additional property

Any of:

string

{
  "property1": "string",
  "property2": "string"
}

Data Attribute List

A list of all data attributes belonging to a workspace for contacts, companies or conversations.

typestringrequired

The type of the object

Value"list"

Example: "list"

dataArray of objects(Data Attribute)required

A list of data attributes

data[].typestringrequired

Value is data_attribute.

Value"data_attribute"

Example: "data_attribute"

data[].idinteger

The unique identifier for the data attribute which is given by Intercom. Only available for custom attributes.

Example: 12878

data[].modelstring

Value is contact for user/lead attributes and company for company attributes.

Enum"contact""company"

Example: "contact"

data[].namestringrequired

Name of the attribute.

Example: "paid_subscriber"

data[].full_namestringrequired

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.

Example: "custom_attributes.paid_subscriber"

data[].labelstringrequired

Readable name of the attribute (i.e. name you see in the UI)

Example: "Paid Subscriber"

data[].descriptionstringrequired

Readable description of the attribute.

Example: "Whether the user is a paid subscriber."

data[].data_typestringrequired

The data type of the attribute.

Enum"string""integer""float""boolean""date"

Example: "boolean"

data[].optionsArray of strings

List of predefined options for attribute value.

Example: ["true","false"]

data[].api_writableboolean

Can this attribute be updated through API

Example: true

data[].messenger_writableboolean

Can this attribute be updated by the Messenger

Example: false

data[].ui_writableboolean

Can this attribute be updated in the UI

Example: true

data[].customboolean

Set to true if this is a CDA

Example: true

data[].archivedboolean

Is this attribute archived. (Only applicable to CDAs)

Example: false

data[].created_atinteger(date-time)

The time the attribute was created as a UTC Unix timestamp

Example: 1671028894

data[].updated_atinteger(date-time)

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

Example: 1671028894

data[].admin_idstring

Teammate who created the attribute. Only applicable to CDAs

Example: "5712945"

{
  "type": "list",
  "data": [
    { … }
  ]
}

Intercom API (2.11)

Admins

Articles

Companies

Contacts

Conversations

Data Attributes

Data Events

Data Export

Help Center

Messages

News

Notes

Segments

Subscription Types

Switch

Tags

Teams

Ticket Type Attributes

Ticket Types

Tickets

Visitors

Models

Custom Attributes

customer_request

Data Attribute List