Skip to content
Home
/
REST API Reference
/
Models
/
Update Conversation Request

Intercom API (2.10)

The intercom API reference.

Download OpenAPI description
api.intercom.io.json
api.intercom.io.yaml
Overview
URL

https://developers.intercom.com

License

MIT

Languages
Servers
The production API server

https://api.intercom.io/

The european API server

https://api.eu.intercom.io/

The australian API server

https://api.au.intercom.io/

Admins

Everything about your Admins

Operations

Articles

Everything about your Articles

Operations

Companies

Everything about your Companies

Operations

Contacts

Everything about your contacts

Operations

Conversations

Everything about your Conversations

Operations

Data Attributes

Everything about your Data Attributes

Operations

Data Events

Everything about your Data Events

Operations

Data Export

Everything about your Data Exports

Operations

Help Center

Everything about your Help Center

Operations

Messages

Everything about your messages

Operations

News

Everything about your News

Operations

Notes

Everything about your Notes

Operations

Segments

Everything about your Segments

Operations

Subscription Types

Everything about subscription types

Operations

Switch

Everything about Switch

Operations

Tags

Everything about tags

Operations

Teams

Everything about your Teams

Operations

Ticket Type Attributes

Everything about your ticket type attributes

Operations

Ticket Types

Everything about your ticket types

Operations

Tickets

Everything about your tickets

Operations

Visitors

Everything about your Visitors

Operations

Models

Update Contact Request Payload

You can update a contact

rolestring

The role of the contact.

external_idstring

A unique identifier for the contact which is given to Intercom

emailstring

The contacts email

Example: "jdoe@example.com"
phonestring or null

The contacts phone

Example: "+353871234567"
namestring or null

The contacts name

Example: "John Doe"
avatarstring or null

An image URL containing the avatar of a contact

Example: "https://www.example.com/avatar_image.jpg"
signed_up_atinteger or null(date-time)

The time specified for when a contact signed up

Example: 1571672154
last_seen_atinteger or null(date-time)

The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually)

Example: 1571672154
owner_idinteger or null

The id of an admin that has been assigned account ownership of the contact

Example: 123
unsubscribed_from_emailsboolean or null

Whether the contact is unsubscribed from emails

Example: true
custom_attributesobject or null

The custom attributes which are set for the contact

{
  "role": "string",
  "external_id": "string",
  "email": "jdoe@example.com",
  "phone": "+353871234567",
  "name": "John Doe",
  "avatar": "https://www.example.com/avatar_image.jpg",
  "signed_up_at": 1571672154,
  "last_seen_at": 1571672154,
  "owner_id": 123,
  "unsubscribed_from_emails": true,
  "custom_attributes": {}
}

Update Conversation Request

Payload of the request to update a conversation

readboolean

Mark a conversation as read within Intercom.

Example: true
{
  "read": true
}

Update Data Attribute Request

One of:
optionsArray of objectsrequired

Array of objects representing the options of the list, with value as the key and the option as the value. At least two options are required.

Example: [{"value":"1-10"},{"value":"11-50"}]
options[].​valuestring
archivedboolean

Whether the attribute is to be archived or not.

Example: false
descriptionstring

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

Example: "My Data Attribute Description"
messenger_writableboolean

Can this attribute be updated by the Messenger

Example: false
{
  "options": [
    { … },
    { … }
  ],
  "archived": false,
  "description": "My Data Attribute Description",
  "messenger_writable": false
}