Dataevents 1 endpoints

POST /events/summaries Create event summaries

Create event summaries for a user. Event summaries are used to track the number of times an event has occurred, the first time it occurred and the last time it occurred.

operationId: DataEvents_createEventSummaries

Parameters

Name	In	Required	Type	Description
Intercom-Version	header	optional		—

Request Body

application/json

schema create_data_event_summaries_request

Property	Type	Required
user_id	string	optional
event_summaries	object	optional
└ last	integer	optional
└ count	integer	optional
└ first	integer	optional
└ event_name	string	optional

Responses

200

successful

401

Unauthorized

POST /events/summaries

Dataexport 4 endpoints

GET /download/content/data/{job_identifier} Download content data export

When a job has a status of complete, and thus a filled download_url, you can download your data by hitting that provided URL, formatted like so: https://api.intercom.io/download/content/data/xyz1234.

Your exported message data will be streamed continuously back down to you in a gzipped CSV format.

📘 Octet header required

You will have to specify the header Accept: application/octet-stream when hitting this endpoint.

operationId: DataExport_downloadDataExport

Parameters

Name	In	Required	Type	Description
Intercom-Version	header	optional		—
job_identifier	path	required	string	job_identifier

Responses

200

successful

GET /download/content/data/{job_identifier}

POST /export/cancel/{job_identifier} Cancel content data export

You can cancel your job

operationId: DataExport_cancelJob

Parameters

Name	In	Required	Type	Description
Intercom-Version	header	optional		—
job_identifier	path	required	string	job_identifier

Responses

200

successful

POST /export/cancel/{job_identifier}

POST /export/content/data Create content data export

To create your export job, you need to send a POST request to the export endpoint https://api.intercom.io/export/content/data.

The only parameters you need to provide are the range of dates that you want exported.

🚧 Limit of one active job

You can only have one active job per workspace. You will receive a HTTP status code of 429 with the message Exceeded rate limit of 1 pending message data export jobs if you attempt to create a second concurrent job.

❗️ Updated_at not included

It should be noted that the timeframe only includes messages sent during the time period and not messages that were only updated during this period. For example, if a message was updated yesterday but sent two days ago, you would need to set the created_at_after date before the message was sent to include that in your retrieval job.

📘 Date ranges are inclusive

Requesting data for 2018-06-01 until 2018-06-30 will get all data for those days including those specified - e.g. 2018-06-01 00:00:00 until 2018-06-30 23:59:99.

operationId: DataExport_createContentExport

Parameters

Name	In	Required	Type	Description
Intercom-Version	header	optional		—

Request Body

application/json

schema create_data_exports_request

Property	Type	Required
created_at_after	integer	required
created_at_before	integer	required

Responses

200

successful

POST /export/content/data

GET /export/content/data/{job_identifier} Show content data export

You can view the status of your job by sending a GET request to the URL
https://api.intercom.io/export/content/data/{job_identifier} - the {job_identifier} is the value returned in the response when you first created the export job. More on it can be seen in the Export Job Model.

🚧 Jobs expire after two days
All jobs that have completed processing (and are thus available to download from the provided URL) will have an expiry limit of two days from when the export ob completed. After this, the data will no longer be available.

operationId: DataExport_statusByJobIdentifier

Parameters

Name	In	Required	Type	Description
Intercom-Version	header	optional		—
job_identifier	path	required	string	job_identifier

Responses

200

successful

GET /export/content/data/{job_identifier}

Helpcenter 12 endpoints

GET /help_center/collections List all collections

You can fetch a list of all collections by making a GET request to https://api.intercom.io/help_center/collections.

Collections will be returned in descending order on the updated_at attribute. This means if you need to iterate through results then we’ll show the most recently updated collections first.

operationId: HelpCenter_listAllCollections

Parameters

Name	In	Required	Type	Description
Intercom-Version	header	optional		—

Responses

200

Successful

401

Unauthorized

GET /help_center/collections

POST /help_center/collections Create a collection

You can create a new collection by making a POST request to https://api.intercom.io/help_center/collections.

operationId: HelpCenter_createCollection

Parameters

Name	In	Required	Type	Description
Intercom-Version	header	optional		—

Request Body

application/json

schema create_collection_request

Property	Type	Required
name	string	required
description	string	optional
help_center_id	integer	optional
translated_content	object	optional
└ ar	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ bg	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ bs	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ ca	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ cs	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ da	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ de	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ el	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ en	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ es	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ et	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ fi	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ fr	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ he	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ hr	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ hu	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ id	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ it	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ ja	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ ko	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ …18 more	object	optional

Responses

200

collection created

400

Bad Request

401

Unauthorized

POST /help_center/collections

DELETE /help_center/collections/{id} Delete a collection

You can delete a single collection by making a DELETE request to https://api.intercom.io/collections/<id>.

operationId: HelpCenter_deleteCollection

Parameters

Name	In	Required	Type	Description
Intercom-Version	header	optional		—
id	path	required	integer	The unique identifier for the collection which is given by Intercom.

Responses

200

successful

401

Unauthorized

404

collection Not Found

DELETE /help_center/collections/{id}

GET /help_center/collections/{id} Retrieve a collection

You can fetch the details of a single collection by making a GET request to https://api.intercom.io/help_center/collections/<id>.

operationId: HelpCenter_getCollection

Parameters

Name	In	Required	Type	Description
Intercom-Version	header	optional		—
id	path	required	integer	The unique identifier for the collection which is given by Intercom.

Responses

200

Collection found

401

Unauthorized

404

Collection not found

GET /help_center/collections/{id}

PUT /help_center/collections/{id} Update a collection

You can update the details of a single collection by making a PUT request to https://api.intercom.io/collections/<id>.

operationId: HelpCenter_updateCollectionById

Parameters

Name	In	Required	Type	Description
Intercom-Version	header	optional		—
id	path	required	integer	The unique identifier for the collection which is given by Intercom.

Request Body

application/json

schema update_collection_request

Property	Type	Required
name	string	optional
description	string	optional
translated_content	object	optional
└ ar	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ bg	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ bs	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ ca	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ cs	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ da	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ de	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ el	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ en	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ es	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ et	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ fi	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ fr	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ he	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ hr	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ hu	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ id	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ it	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ ja	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ ko	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ …18 more	object	optional

Responses

200

successful

401

Unauthorized

404

Collection Not Found

PUT /help_center/collections/{id}

GET /help_center/help_centers List all Help Centers

You can list all Help Centers by making a GET request to https://api.intercom.io/help_center/help_centers.

operationId: HelpCenter_listAllHelpCenters

Parameters

Name	In	Required	Type	Description
Intercom-Version	header	optional		—

Responses

200

Help Centers found

401

Unauthorized

GET /help_center/help_centers

GET /help_center/help_centers/{id} Retrieve a Help Center

You can fetch the details of a single Help Center by making a GET request to https://api.intercom.io/help_center/help_center/<id>.

operationId: HelpCenter_getDetails

Parameters

Name	In	Required	Type	Description
Intercom-Version	header	optional		—
id	path	required	integer	The unique identifier for the collection which is given by Intercom.

Responses

200

Collection found

401

Unauthorized

404

Collection not found

GET /help_center/help_centers/{id}

GET /help_center/sections List all sections

You can fetch a list of all sections by making a GET request to https://api.intercom.io/help_center/sections.

📘 How are the sections sorted and ordered?

Sections will be returned in descending order on the updated_at attribute. This means if you need to iterate through results then we’ll show the most recently updated sections first.

operationId: HelpCenter_listAllSections

Parameters

Name	In	Required	Type	Description
Intercom-Version	header	optional		—

Responses

200

Successful

401

Unauthorized

GET /help_center/sections

POST /help_center/sections Create a section

You can create a new section by making a POST request to https://api.intercom.io/help_center/sections.

operationId: HelpCenter_createSection

Parameters

Name	In	Required	Type	Description
Intercom-Version	header	optional		—

Request Body

application/json

schema create_section_request

Property	Type	Required
name	string	required
parent_id	integer	required
translated_content	object	optional
└ ar	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ bg	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ bs	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ ca	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ cs	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ da	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ de	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ el	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ en	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ es	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ et	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ fi	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ fr	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ he	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ hr	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ hu	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ id	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ it	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ ja	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ ko	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ …18 more	object	optional

Responses

200

section created

401

Unauthorized

POST /help_center/sections

DELETE /help_center/sections/{id} Delete a section

You can delete a single section by making a DELETE request to https://api.intercom.io/sections/<id>.

operationId: HelpCenter_deleteSection

Parameters

Name	In	Required	Type	Description
Intercom-Version	header	optional		—
id	path	required	integer	The unique identifier for the section which is given by Intercom.

Responses

200

successful

401

Unauthorized

404

section Not Found

DELETE /help_center/sections/{id}

GET /help_center/sections/{id} Retrieve a section

You can fetch the details of a single section by making a GET request to https://api.intercom.io/help_center/sections/<id>.

operationId: HelpCenter_getSectionById

Parameters

Name	In	Required	Type	Description
Intercom-Version	header	optional		—
id	path	required	integer	The unique identifier for the section which is given by Intercom.

Responses

200

Section found

401

Unauthorized

404

Section not found

GET /help_center/sections/{id}

PUT /help_center/sections/{id} Update a section

You can update the details of a single section by making a PUT request to https://api.intercom.io/sections/<id>.

operationId: HelpCenter_updateSectionById

Parameters

Name	In	Required	Type	Description
Intercom-Version	header	optional		—
id	path	required	integer	The unique identifier for the section which is given by Intercom.

Request Body

application/json

schema update_section_request

Property	Type	Required
name	string	optional
parent_id	integer	optional
translated_content	object	optional
└ ar	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ bg	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ bs	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ ca	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ cs	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ da	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ de	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ el	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ en	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ es	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ et	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ fi	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ fr	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ he	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ hr	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ hu	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ id	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ it	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ ja	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ ko	object	optional
└ name	string	optional
└ type	string	optional
└ description	string	optional
└ …18 more	object	optional

Responses

200

successful

401

Unauthorized

404

Section Not Found

PUT /help_center/sections/{id}

Messages 1 endpoints

POST /messages Create a message

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.

🚧 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.

operationId: Messages_createMessage

Parameters

Name	In	Required	Type	Description
Intercom-Version	header	optional		—

Request Body

application/json

schema create_message_request

Property	Type	Required
to	object	optional
└ id	string	required
└ type	string	required
body	string	optional
from	object	optional
└ id	integer	required
└ type	string	required
subject	string	optional
template	string	optional
message_type	string	optional
create_conversation_without_contact_reply	boolean	optional

Responses

200

admin message created

400

No body supplied for email message

401

Unauthorized

403

API plan restricted

422

No subject supplied for email message

POST /messages

News 8 endpoints

GET /news/news_items List all news items

You can fetch a list of all news items

operationId: News_listAllNewsItems

Parameters

Name	In	Required	Type	Description
Intercom-Version	header	optional		—

Responses

200

successful

401

Unauthorized

GET /news/news_items

POST /news/news_items Create a news item

You can create a news item

operationId: News_createNewsItem

Parameters

Name	In	Required	Type	Description
Intercom-Version	header	optional		—

Request Body

application/json

schema news_item_request

Property	Type	Required
body	string	optional
state	string	optional
title	string	required
labels	array	optional
reactions	array	optional
sender_id	integer	required
deliver_silently	boolean	optional
newsfeed_assignments	array	optional
└ newsfeed_id	integer	optional
└ published_at	integer	optional

Responses

200

successful

401

Unauthorized

POST /news/news_items

DELETE /news/news_items/{id} Delete a news item

You can delete a single news item.

operationId: News_deleteItem

Parameters

Name	In	Required	Type	Description
Intercom-Version	header	optional		—
id	path	required	integer	The unique identifier for the news item which is given by Intercom.

Responses

200

successful

401

Unauthorized

404

News Item Not Found

DELETE /news/news_items/{id}

GET /news/news_items/{id} Retrieve a news item

You can fetch the details of a single news item.

operationId: News_getItem

Parameters

Name	In	Required	Type	Description
Intercom-Version	header	optional		—
id	path	required	integer	The unique identifier for the news item which is given by Intercom.

Responses

200

successful

401

Unauthorized

404

News Item Not Found

GET /news/news_items/{id}

PUT /news/news_items/{id} Update a news item

operationId: News_updateNewsItem

Parameters

Name	In	Required	Type	Description
Intercom-Version	header	optional		—
id	path	required	integer	The unique identifier for the news item which is given by Intercom.

Request Body

application/json

schema news_item_request

Property	Type	Required
body	string	optional
state	string	optional
title	string	required
labels	array	optional
reactions	array	optional
sender_id	integer	required
deliver_silently	boolean	optional
newsfeed_assignments	array	optional
└ newsfeed_id	integer	optional
└ published_at	integer	optional

Responses

200

successful

401

Unauthorized

404

News Item Not Found

PUT /news/news_items/{id}

GET /news/newsfeeds List all newsfeeds

You can fetch a list of all newsfeeds

operationId: News_listAllNewsfeeds

Parameters

Name	In	Required	Type	Description
Intercom-Version	header	optional		—

Responses

200

successful

401

Unauthorized

GET /news/newsfeeds

GET /news/newsfeeds/{id} Retrieve a newsfeed

You can fetch the details of a single newsfeed

operationId: News_getNewsfeed

Parameters

Name	In	Required	Type	Description
Intercom-Version	header	optional		—
id	path	required	string	The unique identifier for the news feed item which is given by Intercom.

Responses

200

successful

401

Unauthorized

GET /news/newsfeeds/{id}

GET /news/newsfeeds/{id}/items List all live newsfeed items

You can fetch a list of all news items that are live on a given newsfeed

operationId: News_listLiveItems

Parameters

Name	In	Required	Type	Description
Intercom-Version	header	optional		—
id	path	required	string	The unique identifier for the news feed item which is given by Intercom.

Responses

200

successful

401

Unauthorized

GET /news/newsfeeds/{id}/items

Notes 3 endpoints

GET /contacts/{id}/notes List all notes

You can fetch a list of notes that are associated to a contact.

operationId: Notes_listAll

Parameters

Name	In	Required	Type	Description
id	path	required	integer	The unique identifier of a contact.
Intercom-Version	header	optional		—

Responses

200

Successful response

404

Contact not found

GET /contacts/{id}/notes

POST /contacts/{id}/notes Create a note

You can add a note to a single contact.

operationId: Notes_addNoteToContact

Parameters

Name	In	Required	Type	Description
Intercom-Version	header	optional		—
id	path	required	integer	The unique identifier of a given contact.

Request Body

application/json

schema NotesAddNoteToContactRequest

Property	Type	Required
body	string	required
admin_id	string	optional
contact_id	string	optional

Responses

200

Successful response

404

Contact not found

POST /contacts/{id}/notes

GET /notes/{id} Retrieve a note

You can fetch the details of a single note.

operationId: Notes_getNoteDetails

Parameters

Name	In	Required	Type	Description
Intercom-Version	header	optional		—
id	path	required	integer	The unique identifier of a given note

Responses

200

Note found

401

Unauthorized

404

Note not found

GET /notes/{id}

Segments 2 endpoints

GET /segments List all segments

You can fetch a list of all segments.

operationId: Segments_listAll

Parameters

Name	In	Required	Type	Description
Intercom-Version	header	optional		—
include_count	query	optional	boolean	It includes the count of contacts that belong to each segment.

Responses

200

Successful response

401

Unauthorized

GET /segments

GET /segments/{id} Retrieve a segment

You can fetch the details of a single segment.

operationId: Segments_getById

Parameters

Name	In	Required	Type	Description
Intercom-Version	header	optional		—
id	path	required	string	The unique identified of a given segment.

Responses

200

Successful response

401

Unauthorized

404

Segment not found

GET /segments/{id}

Subscriptiontypes 3 endpoints

POST /contacts/{contact_id}/subscriptions Add subscription to a contact

You can add a specific subscription to a contact. In Intercom, we have two different subscription types based on user consent - opt-out and opt-in:

1.Attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type.

2.Attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type.

This will return a subscription type model for the subscription type that was added to the contact.

operationId: SubscriptionTypes_addSubscriptionToContact

Parameters

Name	In	Required	Type	Description
Intercom-Version	header	optional		—
contact_id	path	required	string	The unique identifier for the contact which is given by Intercom

Request Body

application/json

schema SubscriptionTypesAddSubscriptionToContactRequest

Property	Type	Required
id	string	required
consent_type	string	required

Responses

200

Successful

401

Unauthorized

404

Resource not found

POST /contacts/{contact_id}/subscriptions

DELETE /contacts/{contact_id}/subscriptions/{id} Remove subscription from a contact

You can remove a specific subscription from a contact. This will return a subscription type model for the subscription type that was removed from the contact.

operationId: SubscriptionTypes_removeFromContact

Parameters

Name	In	Required	Type	Description
Intercom-Version	header	optional		—
contact_id	path	required	string	The unique identifier for the contact which is given by Intercom
id	path	required	string	The unique identifier for the subscription type which is given by Intercom

Responses

200

Successful

401

Unauthorized

404

Resource not found

DELETE /contacts/{contact_id}/subscriptions/{id}

GET /subscription_types List subscription types

You can list all subscription types. A list of subscription type objects will be returned.

operationId: SubscriptionTypes_list

Parameters

Name	In	Required	Type	Description
Intercom-Version	header	optional		—

Responses

200

Successful

401

Unauthorized

GET /subscription_types

Switch 1 endpoints

POST /phone_call_redirects Create a phone Switch

You can use the API to deflect phone calls to the Intercom Messenger.
Calling this endpoint will send an SMS with a link to the Messenger to the phone number specified.

If custom attributes are specified, they will be added to the user or lead’s custom data attributes.

operationId: Switch_deflectPhoneCalls

Parameters

Name	In	Required	Type	Description
Intercom-Version	header	optional		—

Request Body

application/json

schema create_phone_switch_request

Property	Type	Required
phone	string	required
custom_attributes	object	optional

Responses

200

successful

400

bad request - invalid number

401

Unauthorized

422

unprocessable entity

POST /phone_call_redirects

Tags 8 endpoints

POST /contacts/{contact_id}/tags Add tag to a contact

You can tag a specific contact. This will return a tag object for the tag that was added to the contact.

operationId: Tags_addTagToContact

Parameters

Name	In	Required	Type	Description
Intercom-Version	header	optional		—
contact_id	path	required	string	The unique identifier for the contact which is given by Intercom

Request Body

application/json

schema TagsAddTagToContactRequest

Property	Type	Required
id	string	required

Responses

200

successful

401

Unauthorized

404

Tag not found

POST /contacts/{contact_id}/tags

DELETE /contacts/{contact_id}/tags/{id} Remove tag from a contact

You can remove tag from a specific contact. This will return a tag object for the tag that was removed from the contact.

operationId: Tags_removeFromContact

Parameters

Name	In	Required	Type	Description
Intercom-Version	header	optional		—
contact_id	path	required	string	The unique identifier for the contact which is given by Intercom
id	path	required	string	The unique identifier for the tag which is given by Intercom

Responses

200

successful

401

Unauthorized

404

Tag not found

DELETE /contacts/{contact_id}/tags/{id}

POST /conversations/{conversation_id}/tags Add tag to a conversation

You can tag a specific conversation. This will return a tag object for the tag that was added to the conversation.

operationId: Tags_addTagToConversation

Parameters

Name	In	Required	Type	Description
Intercom-Version	header	optional		—
conversation_id	path	required	string	conversation_id

Request Body

application/json

schema TagsAddTagToConversationRequest

Property	Type	Required
id	string	required
admin_id	string	required

Responses

200

successful

401

Unauthorized

404

Conversation not found

POST /conversations/{conversation_id}/tags

DELETE /conversations/{conversation_id}/tags/{id} Remove tag from a conversation

You can remove tag from a specific conversation. This will return a tag object for the tag that was removed from the conversation.

operationId: Tags_removeFromConversation

Parameters

Name	In	Required	Type	Description
Intercom-Version	header	optional		—
conversation_id	path	required	string	conversation_id
id	path	required	string	id

Request Body

application/json

schema TagsRemoveFromConversationRequest

Property	Type	Required
admin_id	string	required

Responses

200

successful

401

Unauthorized

404

Tag not found

DELETE /conversations/{conversation_id}/tags/{id}

GET /tags List all tags

You can fetch a list of all tags for a given workspace.

operationId: Tags_getAllTags

Parameters

Name	In	Required	Type	Description
Intercom-Version	header	optional		—

Responses

200

successful

401

Unauthorized

GET /tags

POST /tags Create or update a tag, Tag or untag companies, Tag contacts

You can use this endpoint to perform the following operations:

1. Create a new tag: You can create a new tag by passing in the tag name as specified in “Create or Update Tag Request Payload” described below.

2. Update an existing tag: You can update an existing tag by passing the id of the tag as specified in “Create or Update Tag Request Payload” described below.

3. Tag Companies: You can tag single company or a list of companies. You can tag a company by passing in the tag name and the company details as specified in “Tag Company Request Payload” described below. Also, if the tag doesn’t exist then a new one will be created automatically.

4. Untag Companies: You can untag a single company or a list of companies. You can untag a company by passing in the tag id and the company details as specified in “Untag Company Request Payload” described below.

5. Tag Multiple Users: You can tag a list of users. You can tag the users by passing in the tag name and the user details as specified in “Tag Users Request Payload” described below.

Each operation will return a tag object.

operationId: Tags_createOrUpdateTag

Parameters

Name	In	Required	Type	Description
Intercom-Version	header	optional		—

Request Body

application/json

schema TagsCreateOrUpdateTagRequest

Responses

200

Action successful

400

Invalid parameters

401

Unauthorized

404

User not found

POST /tags

DELETE /tags/{id} Delete tag

You can delete the details of tags that are on the workspace by passing in the id.

operationId: Tags_deleteTagById

Parameters

Name	In	Required	Type	Description
Intercom-Version	header	optional		—
id	path	required	string	The unique identifier of a given tag

Responses

200

Successful

400

Tag has dependent objects

401

Unauthorized

404

Resource not found

DELETE /tags/{id}

GET /tags/{id} Find a specific tag

You can fetch the details of tags that are on the workspace by their id.
This will return a tag object.

operationId: Tags_findSpecificTag

Parameters

Name	In	Required	Type	Description
Intercom-Version	header	optional		—
id	path	required	string	The unique identifier of a given tag

Responses

200

Tag found

401

Unauthorized

404

Tag not found

GET /tags/{id}

Teams 2 endpoints

GET /teams List all teams

This will return a list of team objects for the App.

operationId: Teams_getAll

Parameters

Name	In	Required	Type	Description
Intercom-Version	header	optional		—

Responses

200

successful

401

Unauthorized

GET /teams

GET /teams/{id} Retrieve a team

You can fetch the details of a single team, containing an array of admins that belong to this team.

operationId: Teams_getDetails

Parameters

Name	In	Required	Type	Description
Intercom-Version	header	optional		—
id	path	required	string	The unique identifier of a given team.

Responses

200

successful

401

Unauthorized

404

Team not found

GET /teams/{id}

Tickettypeattributes 2 endpoints

POST /ticket_types/{ticket_type_id}/attributes Create a new attribute for a ticket type

You can create a new attribute for a ticket type.

operationId: TicketTypeAttributes_createNewAttribute

Parameters

Name	In	Required	Type	Description
Intercom-Version	header	optional		—
ticket_type_id	path	required	string	The unique identifier for the ticket type which is given by Intercom.

Request Body

application/json

schema create_ticket_type_attribute_request

Property	Type	Required
name	string	required
data_type	string	required
multiline	boolean	optional
list_items	string	optional
description	string	required
visible_on_create	boolean	optional
required_to_create	boolean	optional
visible_to_contacts	boolean	optional
allow_multiple_values	boolean	optional
required_to_create_for_contacts	boolean	optional

Responses

200

Ticket Type Attribute created

401

Unauthorized

POST /ticket_types/{ticket_type_id}/attributes

PUT /ticket_types/{ticket_type_id}/attributes/{id} Update an existing attribute for a ticket type

You can update an existing attribute for a ticket type.

operationId: TicketTypeAttributes_updateExistingAttribute

Parameters

Name	In	Required	Type	Description
Intercom-Version	header	optional		—
ticket_type_id	path	required	string	The unique identifier for the ticket type which is given by Intercom.
id	path	required	string	The unique identifier for the ticket type attribute which is given by Intercom.

Request Body

application/json

schema update_ticket_type_attribute_request

Property	Type	Required
name	string	optional
archived	boolean	optional
multiline	boolean	optional
list_items	string	optional
description	string	optional
visible_on_create	boolean	optional
required_to_create	boolean	optional
visible_to_contacts	boolean	optional
allow_multiple_values	boolean	optional
required_to_create_for_contacts	boolean	optional

Responses

200

Ticket Type Attribute updated

401

Unauthorized

PUT /ticket_types/{ticket_type_id}/attributes/{id}

Tickettypes 3 endpoints

GET /ticket_types List all ticket types

You can get a list of all ticket types for a workspace.

operationId: TicketTypes_listAll

Parameters

Name	In	Required	Type	Description
Intercom-Version	header	optional		—

Responses

200

successful

401

Unauthorized

GET /ticket_types

POST /ticket_types Create a ticket type

You can create a new ticket type.

📘 Creating ticket types.

Every ticket type will be created with two default attributes: default_title and default_description.
For the icon propery, use an emoji from Twemoji Cheatsheet

operationId: TicketTypes_createNewType

Parameters

Name	In	Required	Type	Description
Intercom-Version	header	optional		—

Request Body

application/json

schema create_ticket_type_request

Property	Type	Required
icon	string	optional
name	string	required
description	string	optional
is_internal	boolean	optional

Responses

200

Ticket type created

401

Unauthorized

POST /ticket_types

GET /ticket_types/{id} Retrieve a ticket type

You can fetch the details of a single ticket type.

operationId: TicketTypes_getDetails

Parameters

Name	In	Required	Type	Description
Intercom-Version	header	optional		—
id	path	required	string	The unique identifier for the ticket type which is given by Intercom.

Responses

200

Ticket type found

401

Unauthorized

GET /ticket_types/{id}