The intercom API reference.
Download OpenAPI description
The production API server The european API serverhttps://api.eu.intercom.io/
The australian API serverhttps://api.au.intercom.io/
AdminsEverything about your Admins
AI ContentWith the AI Content APIs, you can create and manage External Pages and Content Import Sources for your Fin Content Library.
External Pages are pages that you want Fin to be able to answer questions about. The API for External Pages is a great way to ingest into your Fin Content Library pages that are not publicly accessible and hence can't be crawled by Intercom.
Content Import Sources are the sources of those pages, and they are used to determine the default audience for the pages (configured via the UI). You should create a Content Import Source for each source of External Pages that you want to ingest into your Fin Content Library.
You can then iterate through the content from that source via its API and POST it to the External Pages endpoint. That endpoint has an external_id parameter which allows you to specify the identifier from the source. The endpoint will then either create a new External Page or update an existing one as appropriate.",
ArticlesEverything about your Articles
Away Status ReasonsEverything about your Away Status Reasons
CompaniesEverything about your Companies
ConversationsEverything about your Conversations
Custom Channel EventsWith the "Custom Channel" integration, you can bring Fin and Intercom capabilities to your own platform via API, enabling powerful custom integrations.
Intercom treats your integration like any other Intercom channel, allowing your application and Intercom to exchange events seamlessly. This makes it possible, for example, for your users to interact with Fin directly within your own application’s UI.
Custom Object InstancesNote: "Fin over API" is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.
Everything about your Custom Object instances.
Permission Requirements
From now on, to access this endpoint, you need additional permissions. Please head over to the Developer Hub app package authentication settings to configure the required permissions.
Data AttributesEverything about your Data Attributes
Data EventsEverything about your Data Events
Data ExportEverything about your Data Exports
Help CenterEverything about your Help Center
Internal ArticlesEverything about your Internal Articles
MessagesEverything about your messages
MessageMessage are how you reach out to contacts in Intercom. They are created when an admin sends an outbound message to a contact.
The id representing the message.
Example: "1488971108"
created_atinteger(date-time)requiredThe time the conversation was created.
Example: 1667560812
The subject of the message. Only present if message_type: email.
Example: "Greetings"
The message body, which may contain HTML.
Example: "Hello"
message_typestringrequiredThe type of message that was sent. Can be email, inapp, facebook or twitter.
Enum"email""inapp""facebook""twitter"
Example: "inapp"
The associated conversation_id
Example: "64619700005570"
Request{ "type": "user_message", "id": "1488971108", "created_at": 1667560812, "subject": "Greetings", "body": "Hello", "message_type": "inapp", "conversation_id": "64619700005570" }
You can create a message that has been initiated by an admin. The conversation can be either an in-app message or an email.
🚧 Sending for visitors
There can be a short delay between when a contact is created and when a contact becomes available to be messaged through the API. A 404 Not Found error will be returned in this case.
This will return the Message model that has been created.
Headers Intercom-Versionstring(intercom_version)🚧 Retrieving Associated Conversations
As this is a message, there will be no conversation present until the contact responds. Once they do, you will have to search for a contact's conversations with the id of the message.
Intercom API version.
By default, it's equal to the version set in the app package.
Default 2.14
Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"
Example: 2.14
Bodyapplication/jsonAny of:
message_typestringrequiredThe kind of message being created. Values: in_app
or email
.
Enum"in_app""email"
Example: "in_app"
Example: "Thanks for everything"
The content of the message. HTML and plaintext are supported.
Example: "Hello there"
The style of the outgoing message. Possible values plain
or personal
.
Example: "plain"
The sender of the message. If not provided, the default sender will be used.
Always admin
.
Value"admin"
Example: "admin"
The identifier for the admin which is given by Intercom.
Example: 394051
toRecipient (object) or Array of Recipient (objects)requiredOne of:
The role associated to the contact - user
or lead
.
Enum"user""lead"
Example: "user"
The identifier for the contact which is given by Intercom.
Example: "536e564f316c83104c000020"
ccRecipient (object) or Array of Recipient (objects) bccRecipient (object) or Array of Recipient (objects)The time the message was created. If not provided, the current time will be used.
Example: 1590000000
create_conversation_without_contact_replybooleanWhether a conversation should be opened in the inbox for the message without the contact replying. Defaults to false if not provided.
Default false
Example: true
https://api.intercom.io/messages
https://api.eu.intercom.io/messages
https://api.au.intercom.io/messages
curl -i -X POST \ https://api.intercom.io/messages \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -H 'Intercom-Version: 2.14' \ -d '{ "from": { "type": "user", "id": "6762f2341bb69f9f2193bc17" }, "body": "heyy", "referer": "https://twitter.com/bob" }'Bodyapplication/json
The id representing the message.
Example: "1488971108"
created_atinteger(date-time)requiredThe time the conversation was created.
Example: 1667560812
The subject of the message. Only present if message_type: email.
Example: "Greetings"
The message body, which may contain HTML.
Example: "Hello"
message_typestringrequiredThe type of message that was sent. Can be email, inapp, facebook or twitter.
Enum"email""inapp""facebook""twitter"
Example: "inapp"
The associated conversation_id
Example: "64619700005570"
News{ "type": "user_message", "id": "403918396", "created_at": 1734537780, "body": "heyy", "message_type": "inapp", "conversation_id": "613" }
Everything about your News
NotesEverything about your Notes
Reporting Data ExportEverything about Reporting Data Export
SegmentsEverything about your Segments
Subscription TypesEverything about subscription types
TeamsEverything about your Teams
Ticket StatesEverything about your ticket states
Ticket Type AttributesEverything about your ticket type attributes
Ticket TypesEverything about your ticket types
TicketsEverything about your tickets
VisitorsEverything about your Visitors
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4