Skip to content
Home
/
REST API Reference
/
Models
/
Update Contact Request Payload

Intercom API (2.7)

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

Visitors

Everything about your Visitors

Operations

Models

Update Collection Request Payload

You can update a collection

namestring

The name of the collection. For multilingual collections, this will be the name of the default language's content.

Example: "collection 51"
descriptionstring

The description of the collection. For multilingual collections, this will be the description of the default language's content.

Example: "English description"
translated_contentobject or null(Group Translated Content)

The Translated Content of an Group. The keys are the locale codes and the values are the translated content of the Group.

{
  "name": "collection 51",
  "description": "English description",
  "translated_content": {
    "type": "group_translated_content",
    "ar": { … },
    "bg": { … },
    "bs": { … },
    "ca": { … },
    "cs": { … },
    "da": { … },
    "de": { … },
    "el": { … },
    "en": { … },
    "es": { … },
    "et": { … },
    "fi": { … },
    "fr": { … },
    "he": { … },
    "hr": { … },
    "hu": { … },
    "id": { … },
    "it": { … },
    "ja": { … },
    "ko": { … },
    "lt": { … },
    "lv": { … },
    "mn": { … },
    "nb": { … },
    "nl": { … },
    "pl": { … },
    "pt": { … },
    "ro": { … },
    "ru": { … },
    "sl": { … },
    "sr": { … },
    "sv": { … },
    "tr": { … },
    "vi": { … },
    "pt-BR": { … },
    "zh-CN": { … },
    "zh-TW": { … }
  }
}

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
custom_attributesobject(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.

{
  "read": true,
  "custom_attributes": {
    "property1": "string",
    "property2": "string"
  }
}