Intercom API Operations Reference

AI Content

10 operations

POST/ai/content_import_sources

Create a content import source

Set up a new content source for your AI to learn from, enabling your chatbot or AI assistant to draw answers from your chosen knowledge base or content repository.

POST/ai/external_pages

Create an external page (or update an external page by external ID)

Create or update external pages that AI can reference when generating responses, allowing you to feed custom knowledge sources into your Intercom AI assistant. This helps ensure your AI provides accurate, business-specific answers based on your own content.

DELETE/ai/content_import_sources/{source_id}

Delete a content import source

Remove a content import source and all associated imported pages from your AI knowledge base. Use this when you no longer need content from a particular source feeding into your AI assistant.

DELETE/ai/external_pages/{page_id}

Delete an external page

Remove an external page from your content library so it no longer appears in the UI and won't be used by AI to generate answers. Use this when content becomes outdated or irrelevant.

GET/ai/content_import_sources

List content import sources

Retrieve all content import sources available in your workspace to see where your AI content can be pulled from. This helps you understand and manage your connected content repositories.

GET/ai/external_pages

List external pages

Retrieve all external pages configured in your workspace to manage and review which web pages are available for AI-powered content assistance and customer interactions.

GET/ai/content_import_sources/{source_id}

Retrieve a content import source

Fetch details about a specific content import source that's configured in your Intercom workspace, allowing you to verify its settings and status before syncing content for your AI features.

GET/ai/external_pages/{page_id}

Retrieve an external page

Fetch a specific external page stored in Intercom to access its content and metadata. This is useful for building integrations that reference page data in your customer support workflows.

PUT/ai/content_import_sources/{source_id}

Update a content import source

Modify an existing content import source to change how AI training data is collected from your website or documents. Use this to update URLs, file locations, or import settings without creating a new source from scratch.

PUT/ai/external_pages/{page_id}

Update an external page

Modify the content, metadata, and settings of an external page you previously created through the API, allowing you to keep your AI-powered content pages current without recreating them.

Admins

5 operations

GET/me

Identify an admin

Retrieve the current admin's profile information and workspace details to verify who is logged in and what workspace they have access to.

GET/admins/activity_logs

List all activity logs

View a complete activity log of all admin actions taken in your Intercom workspace, helping you track changes and maintain accountability across your team.

2 query params

GET/admins

List all admins

Retrieve a complete list of all administrators in your Intercom workspace to see who has access and management permissions.

GET/admins/{admin_id}

Retrieve an admin

Fetch detailed information about a specific team member or administrator account, including their role, contact details, and account status.

1 path params

PUT/admins/{admin_id}/away

Set an admin to away

Marks an admin as away in your Inbox so customers know they won't receive immediate responses. This helps set proper expectations and prevents messages from being assigned to unavailable team members.

1 path params

Articles

6 operations

POST/articles

Create an article

Create a new knowledge base article to build your self-service support library and help customers find answers independently. This allows you to programmatically add content to your Intercom help center.

DELETE/articles/{article_id}

Delete an article

Removes an article from your knowledge base permanently, allowing you to clean up outdated or incorrect content and keep your help resources current.

1 path params

GET/articles

List all articles

Retrieve all articles from your knowledge base, sorted by most recently updated first. This helps you access and review your entire article library for publishing, updates, or analysis.

GET/articles/{article_id}

Retrieve an article

Fetch the complete details of a specific article including its content, metadata, and publishing status. Use this to display article information in your application or retrieve content for external distribution.

1 path params

GET/articles/search

Search for articles

Find specific articles in your knowledge base by searching for keywords, topics, or content. This helps you quickly locate help documentation to share with customers or reference when training your team.

4 query params

PUT/articles/{article_id}

Update an article

Modify the content, title, and metadata of an existing help article to keep your knowledge base current and aligned with your product or service offerings.

1 path params

Away Status Reasons

1 operation

GET/away_status_reasons

List all away status reasons

Retrieves all away status reasons available in your workspace to see what options your team can use when marking themselves as unavailable.

Brands

2 operations

GET/brands

List all brands

Retrieves all brands associated with your workspace so you can view and manage different brand identities within your Intercom account.

GET/brands/{id}

Retrieve a brand

Fetch details about a specific brand to view its settings, appearance preferences, and configuration within your Intercom account. This helps you manage and reference brand information across your customer communication tools.

1 path params

Calls

9 operations

GET/fin_voice/collect/{id}

Collect Fin Voice call by ID

Retrieve details about a specific Fin Voice call using its unique identifier to access call recordings, transcripts, and metadata for your records.

1 path params

GET/fin_voice/external_id/{external_id}

Collect Fin Voice call by external ID

Retrieve details about a specific Fin Voice call using an external identifier you've assigned to it, allowing you to access call information from your own system.

1 path params

GET/fin_voice/phone_number/{phone_number}

Collect Fin Voice call by phone number

Retrieve details about a Fin Voice call associated with a specific phone number, helping you quickly access call records without needing the call ID.

1 path params

GET/calls/{call_id}

Get a call

Retrieve detailed information about a specific call record, including duration, participants, and status to access conversation history and outcomes.

1 path params

GET/calls/{call_id}/recording

Get call recording by call id

Retrieve a call recording by its ID to access the audio file for playback or archival purposes. This helps you review conversations with prospects or customers for quality assurance and training.

1 path params

GET/calls/{call_id}/transcript

Get call transcript by call id

Retrieve the full transcript of a recorded call in text format for easy access and storage. This helps you document customer interactions and conversations without manual note-taking.

1 path params

GET/calls

List all calls

Retrieve all calls made through your communication system with pagination support, allowing you to review and analyze your customer interactions.

2 query params

POST/calls/search

List calls with transcripts

Retrieve customer call records along with their transcripts by providing conversation IDs, allowing you to review and analyze customer interactions in detail.

POST/fin_voice/register

Register a Fin Voice call

Link an incoming or outgoing phone call from your contact center system to a specific Intercom conversation, creating a unified record that connects call data with customer chat history.

Companies

11 operations

POST/contacts/{contact_id}/companies

Attach a Contact to a Company

Link a contact to their associated company in your CRM, helping you organize and track business relationships alongside individual contact information.

1 path params

POST/companies

Create or Update a company

Create a new company profile in Intercom or update an existing one using your unique company identifier. This helps you organize customer conversations and track company-level information within Intercom.

DELETE/companies/{company_id}

Delete a company

Remove a company from your Intercom workspace permanently. Use this when you need to clean up records or discontinue tracking a specific business.

1 path params

DELETE/contacts/{contact_id}/companies/{company_id}

Detach a contact from a company

Remove the association between a contact and a company in your customer records. Use this when a contact no longer works for or is affiliated with a specific company.

2 path params

POST/companies/list

List all companies

Retrieve a list of all companies in your Intercom workspace, sorted by most recent activity. Use this to view and organize your customer accounts for reporting, segmentation, or analysis purposes.

3 query params

GET/companies/{company_id}/contacts

List attached contacts

Retrieve all contacts associated with a specific company in your Intercom workspace. This helps you see everyone from that organization who has interacted with your business.

1 path params

GET/companies/{company_id}/segments

List attached segments for companies

Retrieve all customer segments associated with a specific company to understand which audience groups they belong to and their market positioning.

1 path params

GET/companies/{company_id}

Retrieve a company by ID

Look up detailed information about a specific company in your Intercom workspace to access their profile data, communication history, and customer attributes.

1 path params

GET/companies

Retrieve companies

Retrieve company information from your Intercom workspace by searching for specific companies or filtering by segments and tags. Use this to access customer organization data for reporting, segmentation, and personalized outreach.

6 query params

GET/companies/scroll

Scroll over all companies

Efficiently retrieve all companies from your Intercom workspace without performance issues, using a scrolling mechanism that handles large datasets that standard pagination can't process reliably.

1 query params

PUT/companies/{company_id}

Update a company

Modify company details in Intercom such as name, industry, website, or custom attributes to keep your customer information current and accurate.

1 path params

Contacts

15 operations

POST/contacts/{contact_id}/archive

Archive contact

Permanently remove a contact from your active contact list while preserving their data for record-keeping and compliance purposes. This helps you keep your contact database clean and organized without losing historical information.

1 path params

POST/contacts/{contact_id}/block

Block contact

Permanently block a contact from contacting you, which also archives all their conversations to keep your inbox clean. This prevents them from sending new messages and cluttering your communication channels.

1 path params

POST/contacts

Create contact

Add a new customer, prospect, or team member to your Intercom workspace so you can track interactions and manage relationships in one place.

DELETE/contacts/{contact_id}

Delete a contact

Permanently remove a contact from your Intercom workspace. Use this when you need to delete outdated or duplicate customer records.

1 path params

GET/contacts/{contact_id}

Get a contact

Retrieve detailed information about a specific contact, including their profile, conversation history, and engagement data.

1 path params

GET/contacts/find_by_external_id/{external_id}

Get a contact by External ID

Retrieve a specific customer's contact details using your own internal ID system, allowing you to quickly access their information without needing Intercom's ID. This is useful when you track customers by your own identifiers like account numbers or CRM IDs.

1 path params

GET/contacts

List all contacts

Retrieve all contacts (customers, leads, and users) stored in your Intercom workspace to access and analyze your entire customer base.

GET/contacts/{contact_id}/companies

List attached companies for contact

Retrieve all companies linked to a specific contact to understand their business relationships and account structure. This helps you see which organizations a person is associated with for better account management and targeting.

1 path params

GET/contacts/{contact_id}/segments

List attached segments for contact

Retrieve all customer segments that a specific contact belongs to, helping you understand how they're categorized in your audience.

1 path params

GET/contacts/{contact_id}/subscriptions

List subscriptions for a contact

Retrieve all subscription preferences (opt-ins and opt-outs) for a specific contact, showing which communication types they've chosen to receive or avoid.

1 path params

GET/contacts/{contact_id}/tags

List tags attached to a contact

Retrieve all tags assigned to a specific contact, helping you understand how that customer has been categorized and segmented in your system.

1 path params

POST/contacts/merge

Merge a lead and a user

Consolidate lead and user records by merging a lead contact into an existing user contact, eliminating duplicates and unifying customer information.

POST/contacts/search

Search contacts

Find specific contacts in your Intercom workspace using filters based on their attributes like email, name, location, or engagement history. This helps you quickly identify and target the exact audience you want to communicate with.

POST/contacts/{contact_id}/unarchive

Unarchive contact

Restore an archived contact to active status so you can resume communication and engagement with them. Use this when a previously inactive customer becomes relevant again or was archived by mistake.

1 path params

PUT/contacts/{contact_id}

Update a contact

Modify an existing contact's information such as name, email, phone number, or custom attributes to keep your customer records current and accurate.

1 path params

Conversations

12 operations

POST/conversations/{conversation_id}/customers

Attach a contact to a conversation

Add a contact or customer to an existing conversation so they can participate in the discussion or receive updates about the topic being discussed.

1 path params

POST/conversations/{conversation_id}/convert

Convert a conversation to a ticket

Convert an ongoing conversation into a support ticket that can be tracked separately, allowing you to manage customer issues through your ticketing system while maintaining conversation context.

1 path params

POST/conversations

Creates a conversation

Initiates a new conversation with a contact or visitor, allowing you to send messages directly within your Intercom workspace. This enables you to start proactive communication with customers, leads, and website visitors.

DELETE/conversations/{conversation_id}

Delete a conversation

Permanently removes a conversation and all its data from your inbox, including messages, files, and metadata. This action cannot be undone.

1 path params

DELETE/conversations/{conversation_id}/customers/{contact_id}

Detach a contact from a group conversation

Remove a specific contact from a group conversation, allowing you to manage participant access and clean up inactive or resolved discussions. This helps you maintain organized conversations by removing contacts who no longer need to be involved.

2 path params

GET/conversations

List all conversations

Retrieve all conversations from your Intercom workspace to view customer interactions and support tickets. This helps you monitor, analyze, and manage all customer communications in one place.

2 query params

POST/conversations/{conversation_id}/parts

Manage a conversation

Update the status and assignment of a conversation by closing it, reopening it, snoozing it for later, or assigning it to team members for follow-up.

1 path params

POST/conversations/redact

Redact a conversation part

Remove or hide sensitive information from a conversation message or conversation part in Intercom to comply with data protection requirements or remove accidentally shared confidential details.

POST/conversations/{conversation_id}/reply

Reply to a conversation

Send a message or internal note to a conversation, allowing you to respond to customer inquiries, provide updates, or leave notes for your team to reference later.

1 path params

GET/conversations/{conversation_id}

Retrieve a conversation

Fetch the complete details of a single conversation including all messages and metadata. Use this to review the full conversation history, understand customer context, or pull data for analysis and reporting.

1 path, 2 query params

POST/conversations/search

Search conversations

Find specific customer conversations in Intercom by filtering on attributes like status, date, content, or assignee to quickly locate the interactions you need to review or act on.

PUT/conversations/{conversation_id}

Update a conversation

Modify conversation details like custom fields and metadata to keep customer interactions organized and tagged with relevant business information. This helps you track customer context and maintain accurate conversation history without sending new replies.

1 path, 1 query params

Custom Channel Events

4 operations

POST/custom_channel_events/notify_new_conversation

Notify Intercom of a new conversation created in a custom channel

Sends a notification to Intercom when a new conversation starts in your custom channel, automatically creating conversation records and triggering any associated workflows you've set up in Intercom.

POST/custom_channel_events/notify_new_message

Notify Intercom of a new message in a custom channel conversation

Notifies Intercom when a new message arrives in a conversation on your custom channel or platform, enabling Intercom to process the message and trigger automated workflows. This keeps your customer conversations synchronized across your own systems and Intercom's platform.

POST/custom_channel_events/notify_quick_reply_selected

Notify Intercom of a quick reply response in a custom channel conversation

Sends a notification to Intercom when a customer selects a quick reply option in your custom channel, enabling Intercom to process the response and trigger automated workflows.

POST/custom_channel_events/notify_attribute_collected

Notify Intercom of an attribute collector response in a custom channel conversation

Sends user responses from attribute collectors in your custom channel directly to Intercom so that user data is captured and can trigger automated workflows. This keeps your customer information synchronized across your platform and Intercom's automation engine.

Custom Object Instances

5 operations

POST/custom_object_instances/{custom_object_type_identifier}

Create or Update a Custom Object Instance

Adds a new custom object record or updates an existing one in your Intercom workspace, allowing you to store and manage business-specific data tied to your contacts.

DELETE/custom_object_instances/{custom_object_type_identifier}

Delete a Custom Object Instance by External ID

Remove a custom object record from your workspace using its external ID, allowing you to clean up or eliminate outdated customer data without affecting other records.

1 query params

DELETE/custom_object_instances/{custom_object_type_identifier}/{custom_object_instance_id}

Delete a Custom Object Instance by ID

Remove a specific custom data record from Intercom when it's no longer needed or has become outdated. This helps maintain clean customer data and prevents confusion with outdated information.

1 path params

GET/custom_object_instances/{custom_object_type_identifier}

Get Custom Object Instance by External ID

Retrieve a specific custom object record from Intercom using its external identifier, allowing you to access data you've synced from your own systems without needing Intercom's internal ID.

1 query params

GET/custom_object_instances/{custom_object_type_identifier}/{custom_object_instance_id}

Get Custom Object Instance by ID

Retrieve a specific custom object record using its unique identifier, allowing you to access detailed information about a particular entity stored in your system.

1 path params

Data Attributes

3 operations

POST/data_attributes

Create a data attribute

Create custom fields to store additional information about your contacts or companies in Intercom, enabling you to track data that matters most to your business.

GET/data_attributes

List all data attributes

Retrieve all custom data attributes you've created for contacts, companies, or conversations in your Intercom workspace. Use this to understand what customer information fields are available for your business.

2 query params

PUT/data_attributes/{data_attribute_id}

Update a data attribute

Modify the properties of an existing data attribute in your Intercom workspace, such as its name, description, or other metadata to keep your customer data organized and accurate.

1 path params

Data Events

3 operations

POST/events/summaries

Create event summaries

Track when and how often specific customer actions happen by creating event summaries that record occurrence counts, first occurrence, and last occurrence dates.

GET/events

List all data events

Retrieve a list of customer events and interactions tracked in Intercom, such as feature usage, page visits, and custom activities from the past 90 days. This helps you understand customer behavior patterns and engagement with your product.

3 query params

POST/events

Submit a data event

Record custom events and user actions in Intercom to track customer behavior and interactions with your product or service. This helps you understand how customers are using your business and segment them based on their activities.

Data Export

4 operations

POST/export/cancel/{job_identifier}

Cancel content data export

Stops an in-progress customer data export job before it completes, allowing you to halt unnecessary processing or correct mistakes without waiting for the export to finish.

1 path params

POST/export/content/data

Create content data export

Initiates a bulk export job to retrieve all messages and conversations from your Intercom workspace within a specified date range. This allows you to back up, archive, or analyze your customer communication data.

GET/download/content/data/{job_identifier}

Download content data export

Download your exported customer data as a compressed CSV file once the export job is complete. This retrieves the actual data that was prepared by your export request.

1 path params

GET/export/content/data/{job_identifier}

Show content data export

Check the status and availability of a content data export job that you've initiated, including whether it's ready for download. This helps you track when your exported customer or support data is prepared and available to retrieve.

1 path params

Emails

2 operations

GET/emails

List all email settings

Retrieve all configured sender email addresses for your workspace to manage how customer communications are sent. This helps you understand which email addresses are available for customer outreach and support.

GET/emails/{id}

Retrieve an email setting

Retrieve the details of a specific email configuration you've set up, including its content, recipients, and delivery settings.

1 path params

Export

4 operations

GET/download/reporting_data/{job_identifier}

Download completed export job data

Retrieves the actual data file from a completed reporting export job, allowing you to access customer analytics, conversation metrics, or other business intelligence data you've prepared for download.

2 query params

POST/export/reporting_data/enqueue

Enqueue a new reporting data export job

Starts a data export job to retrieve your reporting data from Intercom, which you can then download and analyze in your preferred tools.

GET/export/reporting_data/{job_identifier}

Get export job status

Check the progress and completion status of a data export job you've initiated, so you can know when your customer insights and metrics are ready to download.

3 query params

GET/export/reporting_data/get_datasets

List available datasets and attributes

Retrieve all available datasets and attributes from your Intercom account to understand what customer communication data you can export and analyze. This helps you identify which metrics and information are available for reporting and business intelligence.

Help Center

7 operations

POST/help_center/collections

Create a collection

Organize your help center articles by creating a new collection to group related topics together. This helps customers find information more easily and improves your knowledge base structure.

DELETE/help_center/collections/{collection_id}

Delete a collection

Permanently removes a collection from your help center, allowing you to clean up outdated knowledge bases or reorganize your support resources.

1 path params

GET/help_center/help_centers

List all Help Centers

Retrieve a complete list of all your Help Centers to view available knowledge bases and customer support resources. This helps you understand your current documentation structure and manage multiple help centers if you maintain separate ones for different products or audiences.

GET/help_center/collections

List all collections

Retrieve all knowledge base collections to view your complete help center organization and identify which topics your customers are accessing. This helps you understand your support content structure and plan content updates.

GET/help_center/help_centers/{help_center_id}

Retrieve a Help Center

Fetch detailed information about a specific Help Center including its name, settings, and configuration to understand its current state and structure.

1 path params

GET/help_center/collections/{collection_id}

Retrieve a collection

Fetch detailed information about a specific help center collection, including its metadata, content structure, and organizational details. This helps you understand your support documentation hierarchy and manage content organization effectively.

1 path params

PUT/help_center/collections/{collection_id}

Update a collection

Modify the title, description, and other details of an existing help center collection to keep your knowledge base organized and up-to-date.

1 path params

IP Allowlist

2 operations

GET/ip_allowlist

Get IP allowlist settings

Retrieve your workspace's current IP allowlist configuration to see which IP addresses are allowed to access your Intercom workspace. This helps you verify your security restrictions are properly configured.

PUT/ip_allowlist

Update IP allowlist settings

Manage which IP addresses can access your Intercom workspace by updating your allowlist settings, helping you control who can connect from where.

Internal Articles

6 operations

POST/internal_articles

Create an internal article

Create a new internal article to document processes, knowledge, and information accessible to your team within Intercom.

DELETE/internal_articles/{internal_article_id}

Delete an internal article

Permanently remove an internal article from your knowledge base so outdated or incorrect information no longer appears in your team's resources. This helps keep your internal documentation clean and ensures employees always access current guidance.

1 path params

GET/internal_articles

List all articles

Retrieves all internal articles stored in your Intercom workspace, allowing you to view and manage your knowledge base content. This helps you organize, audit, and maintain your internal documentation in one place.

GET/internal_articles/{internal_article_id}

Retrieve an internal article

Fetch the full details and content of a specific internal article stored in Intercom, including metadata like title, body, and status. Use this to programmatically access knowledge base articles for your team's reference or to integrate internal documentation into other business tools.

1 path params

GET/internal_articles/search

Search for internal articles

Find internal knowledge base articles by searching through your organization's documentation stored in Intercom. This helps your team quickly locate reference materials and information to assist with customer inquiries or internal processes.

1 query params

PUT/internal_articles/{internal_article_id}

Update an internal article

Modify the content, title, or metadata of an internal article to keep your knowledge base current and relevant for your team.

1 path params

Jobs

1 operation

GET/jobs/status/{job_id}

Retrieve job status

Check the current status of a background job you've initiated, such as data imports or bulk operations, to see if it's completed, in progress, or failed. This helps you track long-running processes without waiting for immediate responses.

1 path params

Messages

1 operation

POST/messages

Create a message

Send a message to a contact via in-app or email from your admin account, enabling you to reach out proactively without waiting for customer responses. Use this to deliver personalized notifications, updates, or outreach directly through Intercom.

News

8 operations

POST/news/news_items

Create a news item

Create and publish news items to share updates, announcements, and product information with your team and customers through Intercom.

DELETE/news/news_items/{news_item_id}

Delete a news item

Remove a news item from your Intercom workspace when it's no longer relevant or needs to be taken offline. This helps you keep your customer communication channels clean and up-to-date.

1 path params

GET/news/newsfeeds/{newsfeed_id}/items

List all live newsfeed items

Retrieve all published news items currently visible on a specific newsfeed to monitor active content and engagement. This helps you track which updates are live and performing with your audience.

1 path params

GET/news/news_items

List all news items

Retrieve all news items from your Intercom workspace to view announcements, updates, and communications sent to your audience. This helps you track what information has been shared with your customers and team members.

GET/news/newsfeeds

List all newsfeeds

Retrieve a complete list of all your newsfeeds to see what content sources and feeds you have set up in your system. This helps you manage and organize your content distribution channels.

GET/news/news_items/{news_item_id}

Retrieve a news item

Fetch complete details about a specific news article or announcement you've published in Intercom, including its content, status, and engagement metrics.

1 path params

GET/news/newsfeeds/{newsfeed_id}

Retrieve a newsfeed

Retrieve detailed information about a specific newsfeed to view its settings, content, and configuration.

1 path params

PUT/news/news_items/{news_item_id}

Update a news item

Modify an existing news item in your Intercom workspace, such as updating content, publication status, or target audience to keep your customer communications current and relevant.

1 path params

Notes

4 operations

POST/contacts/{contact_id}/notes

Create a note

Add a note to a customer's profile to record important information, feedback, or interaction details that your team can reference later.

1 path params

GET/companies/{company_id}/notes

List all company notes

Retrieve all notes attached to a company record, helping you view the complete history of interactions and important information stored for that client.

1 path params

GET/contacts/{contact_id}/notes

List all notes

Retrieve all notes attached to a specific customer, allowing you to view the complete history of interactions and important details about that contact.

1 path params

GET/notes/{note_id}

Retrieve a note

Retrieve the full details and content of a specific note you've created in Intercom to review information you've saved about customers or business matters.

1 path params

Segments

2 operations

GET/segments

List all segments

Retrieve all segments you've created to organize and target your customers based on their characteristics, behaviors, or attributes.

1 query params

GET/segments/{segment_id}

Retrieve a segment

Fetch detailed information about a specific customer segment, including its criteria and member count, to understand your audience groups and plan targeted outreach.

1 path params

Subscription Types

3 operations

POST/contacts/{contact_id}/subscriptions

Add subscription to a contact

Manage a contact's subscription preferences by adding them to a specific subscription type, controlling whether they opt in or out of receiving messages related to that category. This ensures your communications comply with user consent preferences.

1 path params

GET/subscription_types

List subscription types

Retrieve all subscription types available for your Intercom workspace to understand the different customer subscription options you've configured.

DELETE/contacts/{contact_id}/subscriptions/{subscription_id}

Remove subscription from a contact

Remove a specific subscription type from a contact, allowing you to manage which communication preferences or subscription lists they're enrolled in. This helps keep your contact preferences accurate and relevant.

2 path params

Switch

1 operation

POST/phone_call_redirects

Create a phone Switch

Redirect incoming phone calls to Intercom Messenger by sending an SMS link to the caller, allowing you to manage conversations in one unified platform while optionally capturing custom customer data.

Teams

2 operations

GET/teams

List all teams

Retrieve all teams within your Intercom workspace to see who's part of your support and communication structure. Use this to understand your team organization and manage access across your customer interactions.

GET/teams/{team_id}

Retrieve a team

Fetch detailed information about a specific team including its members and administrators to understand team structure and access rights.

1 path params

Ticket States

1 operation

GET/ticket_states

List all ticket states

Retrieve all available ticket states configured in your workspace, including custom statuses you've created. This helps you understand the different workflow stages your support tickets can move through.

Ticket Type Attributes

2 operations

POST/ticket_types/{ticket_type_id}/attributes

Create a new attribute for a ticket type

Add custom fields to your ticket type to capture specific information relevant to your business needs, such as priority levels, customer segments, or project codes. This helps you organize and track ticket data in a way that matches your unique workflow.

1 path params

PUT/ticket_types/{ticket_type_id}/attributes/{attribute_id}

Update an existing attribute for a ticket type

Modify the properties and settings of a custom field or attribute assigned to a specific ticket type, such as changing its label, type, or validation rules.

2 path params

Ticket Types

4 operations

POST/ticket_types

Create a ticket type

Create a new ticket type to organize and categorize customer support requests in your Intercom workspace. Each ticket type automatically includes default title and description fields for consistent ticket management.

GET/ticket_types

List all ticket types

Retrieve all ticket types configured in your Intercom workspace to understand available support categories and organize customer inquiries efficiently.

GET/ticket_types/{ticket_type_id}

Retrieve a ticket type

Fetch detailed information about a specific ticket type to understand its configuration, properties, and how it's set up for your support workflow.

1 path params

PUT/ticket_types/{ticket_type_id}

Update a ticket type

Modify the properties of an existing ticket type, such as its name, description, or icon, to keep your support categories organized and up-to-date.

1 path params

Tickets

7 operations

POST/tickets

Create a ticket

Create a new support ticket to track customer issues, questions, or requests within your Intercom workspace.

DELETE/tickets/{ticket_id}

Delete a ticket

Permanently removes a ticket and all associated data (messages, attachments, attributes) from your inbox while maintaining incomplete records in reports for compliance purposes.

1 path params

POST/tickets/enqueue

Enqueue create ticket

Submits a new support ticket to be created asynchronously, allowing your system to queue the request without waiting for immediate processing. This enables faster response times when handling multiple ticket submissions simultaneously.

POST/tickets/{ticket_id}/reply

Reply to a ticket

Send a response to a customer ticket or add internal notes to keep your support conversation organized and responsive. Use this to reply as your team, on behalf of a customer, or leave notes that only admins see.

1 path params

GET/tickets/{ticket_id}

Retrieve a ticket

Fetch complete details about a specific support ticket, including messages, customer information, and current status. Use this to review individual customer issues and track resolution progress.

1 path params

POST/tickets/search

Search tickets

Find and filter specific support tickets using customizable search criteria based on attributes like status, assignee, dates, and content. This helps you quickly locate tickets that need attention without manually browsing through your entire ticket queue.

PUT/tickets/{ticket_id}

Update a ticket

Modify ticket details such as status, priority, assignment, or custom fields to keep your support conversations organized and up-to-date. This allows you to track progress, reassign work, or update customer information throughout the ticket lifecycle.

1 path params

Visitors

3 operations

POST/visitors/convert

Convert a visitor

Convert an anonymous website visitor into a tracked contact or user in your system, allowing you to maintain continuity of their conversation history and customer data. This merges visitor information into your existing contact database or creates a new user record.

GET/visitors

Retrieve a visitor with User ID

Look up detailed information about a specific visitor on your website using their user ID, such as their profile data, visit history, and engagement status.

1 query params

PUT/visitors

Update a visitor

Update visitor information in your Intercom workspace, such as name, email, custom attributes, or status. This allows you to keep your contact data current as visitors interact with your business or provide new information.

Workflows

1 operation

GET/export/workflows/{id}

Export a workflow

Export a complete workflow configuration including all steps, rules, and settings for backup, migration, or documentation purposes.

1 path params