The intercom API reference.
Intercom API (2.7)
Download OpenAPI description
Overview
URL
License
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/
Update Collection Request Payload
You can update a collection
The name of the collection. For multilingual collections, this will be the name of the default language's content.
Example: "collection 51"
The description of the collection. For multilingual collections, this will be the description of the default language's content.
Example: "English description"
{ "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
An image URL containing the avatar of a contact
Example: "https://www.example.com/avatar_image.jpg"
The time specified for when a contact signed up
Example: 1571672154
The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually)
Example: 1571672154
The id of an admin that has been assigned account ownership of the contact
Example: 123
Whether the contact is unsubscribed from emails
Example: true
{ "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": {} }