Intercom

Tools

• 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

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

• Assign conversation

  Assigns a conversation to a specific admin or team in intercom

• Attach a contact to a company

  You can attach a company to a single contact.

• Close conversation

  Closes a conversation in intercom, marking it as resolved

• Create a collection

  You can create a new collection by making a post request to `https://api.intercom.io/help center/collections.`

• Create an article

  You can create a new article by making a post request to `https://api.intercom.io/articles`.

• Create a note

  You can add a note to a single contact.

• Create conversation

  Creates a new conversation in intercom

• Create or update a company

  You can create or update a company. companies will be only visible in intercom when there is at least one associated user. companies are looked up via `company id` in a `post` request, if not found via `company id`, the new company will be

• Delete a collection

  destructive

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

• Delete a company

  destructive

  You can delete a single company.

• Delete a contact

  destructive

  You can delete a single contact.

• Delete an article

  destructive

  You can delete a single article by making a delete request to `https://api.intercom.io/articles/<id>`.

• Detach a contact from a company

  You can detach a company from a single contact.

• Get a contact

  You can fetch the details of a single contact.

• Get conversation

  Retrieves a specific conversation by id with all messages and details

• Identify an admin

  You can view the currently authorised admin along with the embedded app object (a "workspace" in legacy terminology). > 🚧 single sign on > > if you are building a custom "log in with intercom" flow for your site, and you call the `/me` end

• List all activity logs

  You can get a log of activities by all admins in an app.

• List all admins

  You can fetch a list of admins for a given workspace.

• List all articles

  You can fetch a list of all articles by making a get request to `https://api.intercom.io/articles`. > 📘 how are the articles sorted and ordered? > > articles will be returned in descending order on the `updated at` attribute. this means if

• 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

• List all companies

  You can list companies. the company list is sorted by the `last request at` field and by default is ordered descending, most recently requested first. note that the api does not include companies who have no associated users in list respons

• List all help centers

  You can list all help centers by making a get request to `https://api.intercom.io/help center/help centers`.

• List all notes

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

• List attached companies for contact

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

• List attached contacts

  You can fetch a list of all contacts that belong to a company.

• List attached segments for companies

  You can fetch a list of all segments that belong to a company.

• List attached segments for contact

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

• List conversations

  Lists conversations from intercom with filtering and pagination support

• List subscriptions for a contact

  You can fetch a list of subscription types that are attached to a contact. these can be subscriptions that a user has 'opted-in' to or has 'opted-out' from, depending on the subscription type. this will return a list of subscription type ob

• List tags attached to a contact

  You can fetch a list of all tags that are attached to a specific contact.

• Merge a lead and a user

  You can merge a contact with a `role` of `lead` into a contact with a `role` of `user`.

• Remove subscription from a contact

  destructive

  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.

• Remove tag from a contact

  destructive

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

• Reopen conversation

  Reopens a closed conversation in intercom

• Reply to conversation

  Sends a reply to an existing conversation in intercom

• 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>`.

• Retrieve a company by id

  You can fetch a single company.

• 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>`.

• Retrieve an admin

  You can retrieve the details of a single admin.

• Retrieve an article

  You can fetch the details of a single article by making a get request to `https://api.intercom.io/articles/<id>`.

• Retrieve companies

  You can fetch a single company by passing in `company id` or `name`. `https://api.intercom.io/companies?name={name}` `https://api.intercom.io/companies?company id={company id}` you can fetch all companies and filter by `segment id` or `tag

• Scroll over all companies

  The `list all companies` functionality does not work well for huge datasets, and can result in errors and performance problems when paging deeply. the scroll api provides an efficient mechanism for iterating over all companies in a dataset.

• Search conversations

  Searches for conversations using query string with support for filtering and sorting

• Search for articles

  You can search for articles by making a get request to `https://api.intercom.io/articles/search`.

• Set an admin to away

  You can set an admin as away for the inbox.

• Update a collection

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

• Update a company

  You can update a single company using the intercom provisioned `id`. {% admonition type="attention" name="using `company id`" %} when updating a company it is not possible to update `company id`. this can only be set once upon creation of t

• Update a contact

  You can update an existing contact (ie. user or lead).

Works well with

How Switchy teams use it

Starter prompts

@Intercom list all open unassigned conversations from the last 24 hours, then assign each one to the team member whose expertise matches the customer's question

@Intercom find all contacts mentioned in this conversation who work at enterprise accounts, then add the tag 'enterprise-user' to each one

@Intercom show me conversations marked waiting-on-customer for more than 5 days, then close any where the last message indicates the issue is solved

@Intercom read conversation 98765, extract the problem and solution, then create a new article in the Troubleshooting collection with a clear title and step-by-step instructions

@Intercom add a note to contact sarah@acme.com summarizing today's call: discussed Q1 renewal, flagged billing question, next follow-up in two weeks

Example outputs

Illustrative - representative of the model's voice and quality, not literal recordings.

Use-case deep-dives

Frequently asked