Menu
Intercom actions
Pick an action to see its parameters, request body and response fields.
101 actions
Admins · 7
GETIdentify Admin
/meIdentify an adminGETList Activity Log Event Types/admins/activity_log_event_typesList all activity log event typesGETList Activity Logs/admins/activity_logsList all activity logsGETList Admins/adminsList all adminsGETRetrieve Admin/admins/{admin_id}Retrieve an adminPOSTSearch Activity Logs/admins/activity_logs/searchSearch activity logsPUTSet Away Admin/admins/{admin_id}/awaySet an admin to awayArticles · 13
POSTAttach Tag To Article
/articles/{article_id}/tagsAdd a tag to an articlePOSTCreate Article/articlesCreate an articleDELETEDelete Article/articles/{article_id}Delete an articleDELETEDetach Tag From Article/articles/{article_id}/tags/{id}Remove a tag from an articleGETList Article Versions/articles/{article_id}/versionsList article versionsGETList Articles/articlesList all articlesPOSTPublish Article Draft/articles/{id}/draft/publishPublish an article draftGETRetrieve Article/articles/{article_id}Retrieve an articleGETRetrieve Article Draft/articles/{id}/draftRetrieve an article draftGETRetrieve Article Version/articles/{article_id}/versions/{id}Retrieve an article versionGETSearch Articles/articles/searchSearch for articlesPUTStage Article Draft/articles/{id}/draftStage an article draftPUTUpdate Article/articles/{article_id}Update an articleBanners · 2
Companies · 11
POSTAttach Contact To A Company
/contacts/{contact_id}/companiesAttach a Contact to a CompanyPOSTCreate Or Update Company/companiesCreate or Update a companyDELETEDelete Company/companies/{company_id}Delete a companyDELETEDetach Contact From A Company/contacts/{contact_id}/companies/{company_id}Detach a contact from a companyPOSTList All Companies/companies/listList all companiesGETList Attached Contacts/companies/{company_id}/contactsList attached contactsGETList Attached Segments For Companies/companies/{company_id}/segmentsList attached segments for companiesGETRetrieve A Company By Id/companies/{company_id}Retrieve a company by IDGETRetrieve Company/companiesRetrieve companiesGETScroll Over All Companies/companies/scrollScroll over all companiesPUTUpdate Company/companies/{company_id}Update a companyContacts · 16
POSTArchive Contact
/contacts/{contact_id}/archiveArchive contactPOSTBlock Contact/contacts/{contact_id}/blockBlock contactPOSTCreate Contact/contactsCreate contactDELETEDelete Contact/contacts/{contact_id}Delete a contactGETList Companies For A Contact/contacts/{contact_id}/companiesList attached companies for contactGETList Contact Merge History/contacts/{id}/merge_historyGet contact merge historyGETList Contacts/contactsList all contactsGETList Segments For A Contact/contacts/{contact_id}/segmentsList attached segments for contactGETList Subscriptions For A Contact/contacts/{contact_id}/subscriptionsList subscriptions for a contactGETList Tags For A Contact/contacts/{contact_id}/tagsList tags attached to a contactPOSTMerge Contact/contacts/mergeMerge a lead and a userPOSTSearch Contacts/contacts/searchSearch contactsGETShow Contact/contacts/{contact_id}Get a contactGETShow Contact By External Id/contacts/find_by_external_id/{external_id}Get a contact by External IDPOSTUnarchive Contact/contacts/{contact_id}/unarchiveUnarchive contactPUTUpdate Contact/contacts/{contact_id}Update a contactContent Snippets · 2
Conversations · 16
POSTAttach Contact To Conversation
/conversations/{conversation_id}/customersAttach a contact to a conversationPOSTConvert Conversation To Ticket/conversations/{conversation_id}/convertConvert a conversation to a ticketPOSTCreate Conversation/conversationsCreates a conversationDELETEDelete Conversation/conversations/{conversation_id}Delete a conversationDELETEDetach Contact From Conversation/conversations/{conversation_id}/customers/{contact_id}Detach a contact from a group conversationGETList Conversations/conversationsList all conversationsGETList Deleted Conversation Ids/conversations/deletedList all deleted conversation IDsGETList Handling Events/conversations/{id}/handling_eventsList handling eventsGETList Side Conversations/conversations/{id}/side_conversationsList side conversationsPOSTManage Conversation/conversations/{conversation_id}/partsManage a conversationPOSTMerge Conversation/conversations/{id}/mergeMerge a conversationPOSTRedact Conversation/conversations/redactRedact a conversation partPOSTReply Conversation/conversations/{conversation_id}/replyReply to a conversationGETRetrieve Conversation/conversations/{conversation_id}Retrieve a conversationPOSTSearch Conversations/conversations/searchSearch conversationsPUTUpdate Conversation/conversations/{conversation_id}Update a conversationData Events · 3
Internal Articles · 2
Notes · 5
POSTCreate Company Note
/companies/{company_id}/notesCreate a company notePOSTCreate Note/contacts/{contact_id}/notesCreate a noteGETList Company Notes/companies/{company_id}/notesList all company notesGETList Notes/contacts/{contact_id}/notesList all notesGETRetrieve Note/notes/{note_id}Retrieve a noteSegments · 2
Subscription Types · 2
Tags · 10
POSTAttach Tag To Contact
/contacts/{contact_id}/tagsAdd tag to a contactPOSTAttach Tag To Conversation/conversations/{conversation_id}/tagsAdd tag to a conversationPOSTAttach Tag To Ticket/tickets/{ticket_id}/tagsAdd tag to a ticketPOSTCreate Tag/tagsCreate or update a tag, Tag or untag companies, Tag contactsDELETEDelete Tag/tags/{tag_id}Delete tagDELETEDetach Tag From Contact/contacts/{contact_id}/tags/{tag_id}Remove tag from a contactDELETEDetach Tag From Conversation/conversations/{conversation_id}/tags/{tag_id}Remove tag from a conversationDELETEDetach Tag From Ticket/tickets/{ticket_id}/tags/{tag_id}Remove tag from a ticketGETFind Tag/tags/{tag_id}Find a specific tagGETList Tags/tagsList all tagsTickets · 10
POSTChange Ticket Type
/tickets/{ticket_id}/change_typeChange ticket typePOSTCreate Ticket/ticketsCreate a ticketDELETEDelete Ticket/tickets/{ticket_id}Delete a ticketPOSTEnqueue Create Ticket/tickets/enqueueEnqueue create ticketGETGet Ticket/tickets/{ticket_id}Retrieve a ticketPOSTLink Conversation To Ticket/tickets/{ticket_id}/linked_conversationsLink a conversation to a ticketPOSTReply Ticket/tickets/{ticket_id}/replyReply to a ticketPOSTSearch Tickets/tickets/searchSearch ticketsDELETEUnlink Conversation From Ticket/tickets/{ticket_id}/linked_conversations/{id}Unlink a conversation from a ticketPUTUpdate Ticket/tickets/{ticket_id}Update a ticket