The Intercom API reference.
Intercom API (2.13)
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/
AI Content
With 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.",
Operations
Custom Object Instances
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.
Operations
Create Message Request Payload
You can create a message
Any of:
You can create a message
The kind of message being created. Values: in_app or email.
Enum"in_app""email"
Example: "in_app"
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.
The sender of the message. If not provided, the default sender will be used.
The time the message was created. If not provided, the current time will be used.
Example: 1590000000
{ "message_type": "in_app", "subject": "Thanks for everything", "body": "Hello there", "template": "plain", "from": { "type": "admin", "id": 394051 }, "to": { "type": "user", "id": "536e564f316c83104c000020" }, "created_at": 1590000000, "create_conversation_without_contact_reply": true }
Create Or Update Company Request Payload
You can create or update a Company
The company id you have defined for the company. Can't be updated
Example: "625e90fc55ab113b6d92175f"
The URL for this company's website. Please note that the value specified here is not validated. Accepts any string.
Example: "https://www.example.com"
A hash of key/value pairs containing any other data about the company you want Intercom to store.
Example: {"paid_subscriber":true,"monthly_spend":155.5,"team_mates":9}
{ "name": "Intercom", "company_id": "625e90fc55ab113b6d92175f", "plan": "Enterprise", "size": "100", "website": "https://www.example.com", "industry": "Manufacturing", "custom_attributes": { "paid_subscriber": true, "monthly_spend": 155.5, "team_mates": 9 }, "remote_created_at": 1394531169, "monthly_spend": 1000 }
Create Or Update Custom Object Instance Request Payload
Payload to create or update a Custom Object instance
A unique identifier for the Custom Object instance in the external system it originated from.
The time when the Custom Object instance was created in the external system it originated from.
Example: 1571672154
The time when the Custom Object instance was last updated in the external system it originated from.
Example: 1571672154
{ "external_id": "string", "external_created_at": 1571672154, "external_updated_at": 1571672154, "custom_attributes": { "property1": "string", "property2": "string" } }