Intercom tools
The 13 Intercom operations your product runs on your customer's account through Connect. All of them use the same endpoint, POST /api/tools/{tool}/execute.
- List contactsGETLists the contacts of the workspace, users and leads, 10 per page by default. The next page comes from pages.next.starting_after in the response; without it, this is the last page. Merged contacts do not appear.
- Search contactsPOSTSearches contacts by their attributes, for example by email, role or a custom attribute. Timestamps are Unix seconds in UTC. Returns total_count and data, 50 per page by default, and the next page comes from pages.next.starting_after. A contact created in the last few minutes may not show up yet.
- Get contactGETReturns one contact with role, email, phone, name, owner_id, custom_attributes, tags, companies and location. A contact merged into another returns 410.
- Create contactPOSTCreates a contact, a user or a lead. Send at least one of email, external_id or role. Every custom attribute sent must already exist in the workspace, or Intercom refuses the contact.
- Update contactPUTUpdates a contact: send only the fields to change. A user cannot become a lead. Every custom attribute sent must already exist in the workspace.
- List conversationsGETLists the conversations of the workspace, 20 per page by default. The next page comes from pages.next.starting_after in the response; without it, this is the last page. Get conversation returns all the parts of one conversation.
- Search conversationsPOSTSearches conversations by their attributes, for example the open ones assigned to a teammate or a team. Timestamps are Unix seconds. Returns total_count and conversations, 20 per page by default, and the next page comes from pages.next.starting_after.
- Get conversationGETReturns one conversation with its parts (messages, notes and actions), up to the 500 most recent ones, plus state, assignees, contacts and tags.
- Create conversation replyPOSTReplies to a conversation as a teammate. A comment goes to the contact through the channel of the conversation, such as the Messenger or email; a note stays internal, visible only to teammates. Closing, snoozing, reopening and assigning are done by Manage conversation.
- Manage conversationPOSTCloses, snoozes, reopens or assigns a conversation. close needs type admin; snoozed needs snoozed_until; assignment needs type and assignee_id, and a conversation can have an admin and a team assigned at the same time. Assigning a closed conversation reopens it unless skip_reopen is true.
- Create messagePOSTSends a new message from a teammate to a contact, in the Messenger (in_app) or by email. Email needs subject and template. The conversation only exists after the contact replies, unless create_conversation_without_contact_reply is true.
- List adminsGETLists the teammates (admins) of the workspace with id, name, email, away_mode_enabled and team_ids. The id is the admin_id of replies and conversation actions and the owner_id of contacts.
- List teamsGETLists the teams of the workspace with id, name and admin_ids. The id is the assignee_id of a conversation assigned to a team.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
