Intercom

Create a new tag. Args: - name: Tag name Returns: The created tag.

Get a single company by ID. Args: - id: The company ID - format: Response format Returns: The company record.

Delete a contact from Intercom. Args: - id: Contact ID to delete Returns: Confirmation of deletion.

Get a single company by your external company_id. Args: - company_id: Your external company ID - format: Response format Returns: The company record.

Get the currently authenticated admin. Returns: The current admin record.

List all admins/teammates in the workspace. Returns: List of all admins.

Get a single admin by ID. Args: - id: The admin ID - format: Response format Returns: The admin record.

Attach a contact to a company. Args: - contact_id: Contact ID - company_id: Company ID to attach Returns: The company record.

Set an admin's away status. Args: - admin_id: Admin ID - away_mode_enabled: Whether away mode is enabled - away_mode_reassign: Whether to reassign conversations Returns: The updated admin record.

List Help Center articles with pagination. Args: - per_page: Number of articles to return (1-50, default: 20) - starting_after: Pagination cursor - format: Response format Returns: Paginated list of articles.

Get a single article by ID. Args: - id: The article ID - format: Response format Returns: The article record with content.

Create a new Help Center article. Args: - title: Article title - author_id: Admin ID of the author - body: Article body content (HTML) - description: Article description - state: Article state ('published' or 'draft') - parent_id: Parent collection ID - parent_type: Type of parent ('collection' or 'section') Returns: The created article.

Update an existing article. Args: - id: Article ID to update - title: New article title - body: New article body content - description: New description - state: New article state - author_id: New author ID - parent_id: New parent collection ID - parent_type: New parent type Returns: The updated article.

Delete an article. Args: - id: Article ID to delete Returns: Confirmation of deletion.

Search for articles by phrase. Args: - phrase: Search phrase - state: Filter by state ('published' or 'draft') - help_center_id: Filter by Help Center ID - format: Response format Returns: List of matching articles.

List Help Center collections with pagination. Args: - per_page: Number of collections to return (1-50, default: 20) - starting_after: Pagination cursor - format: Response format Returns: Paginated list of collections.

Get a single collection by ID. Args: - id: The collection ID - format: Response format Returns: The collection record.

Create a new Help Center collection. Args: - name: Collection name - description: Collection description - help_center_id: Help Center ID to add collection to Returns: The created collection.

Update an existing collection. Args: - id: Collection ID to update - name: New collection name - description: New description Returns: The updated collection.

Delete a collection. Args: - id: Collection ID to delete Returns: Confirmation of deletion.

Archive a contact in Intercom. Args: - id: Contact ID to archive Returns: The archived contact.

Unarchive a contact in Intercom. Args: - id: Contact ID to unarchive Returns: The unarchived contact.

List companies from Intercom with pagination. Args: - per_page: Number of companies to return (1-60, default: 50) - starting_after: Pagination cursor from previous response - format: Response format ('json' or 'markdown') Returns: Paginated list of companies.

Scroll through all companies using cursor-based pagination. Args: - scroll_param: Scroll cursor from previous response - format: Response format Returns: List of companies with scroll_param for next page.

Create a new company or update an existing one. Args: - company_id: Your external company ID (required) - name: Company name - plan: Plan name - monthly_spend: Monthly spend amount - size: Number of employees - website: Company website URL - industry: Industry - custom_attributes: Custom attributes Returns: The created or updated company.

Update an existing company by Intercom ID. Args: - id: Intercom company ID - name: New company name - plan: New plan name - monthly_spend: New monthly spend amount - size: New number of employees - website: New company website URL - industry: New industry - custom_attributes: Custom attributes to update Returns: The updated company.

Delete a company from Intercom. Args: - id: Company ID to delete Returns: Confirmation of deletion.

List all contacts attached to a company. Args: - company_id: Company ID - per_page: Number of contacts per page - format: Response format Returns: Paginated list of contacts.

List all segments a company belongs to. Args: - company_id: Company ID - format: Response format Returns: List of segments.

List contacts from Intercom with pagination. Args: - per_page: Number of contacts to return (1-150, default: 50) - starting_after: Pagination cursor from previous response - format: Response format ('json' or 'markdown') Returns: Paginated list of contacts.

Get a single contact by ID. Args: - id: The contact ID - format: Response format Returns: The contact record.

Create a new contact in Intercom. Args: - role: Contact role ('user' or 'lead') - email: Email address - phone: Phone number - name: Full name - external_id: External ID from your system - custom_attributes: Custom attributes as JSON object Returns: The created contact.

Update an existing contact. Args: - id: Contact ID to update - email: New email address - phone: New phone number - name: New full name - custom_attributes: Custom attributes to update Returns: The updated contact.

Merge a lead contact into a user contact. Args: - lead_id: ID of the lead contact (will be merged into user) - user_id: ID of the user contact (will be kept) Returns: The merged contact.

Search for contacts using Intercom's search API. Args: - field: Field to search on (e.g., 'email', 'name', 'role') - operator: Search operator ('=', '!=', 'IN', 'NIN', '>', '<', '~', '!~', '^', '$') - value: Value to search for - per_page: Number of results per page - format: Response format Returns: Paginated list of matching contacts.

Detach a contact from a company. Args: - contact_id: Contact ID - company_id: Company ID to detach Returns: The company record.

List all companies attached to a contact. Args: - contact_id: Contact ID - format: Response format Returns: List of companies attached to the contact.

Add a tag to a contact. Args: - contact_id: Contact ID - tag_id: Tag ID to add Returns: The tag that was added.

Remove a tag from a contact. Args: - contact_id: Contact ID - tag_id: Tag ID to remove Returns: The tag that was removed.

List all notes for a contact. Args: - contact_id: Contact ID - per_page: Number of notes per page - format: Response format Returns: Paginated list of notes.

Create a note for a contact. Args: - contact_id: Contact ID - body: Note body content - admin_id: Admin ID creating the note (optional) Returns: The created note.

List all segments a contact belongs to. Args: - contact_id: Contact ID - format: Response format Returns: List of segments.

List all subscription types for a contact. Args: - contact_id: Contact ID - format: Response format Returns: List of subscription types.

Subscribe a contact to a subscription type. Args: - contact_id: Contact ID - subscription_id: Subscription type ID - consent_type: Type of consent ('opt_in', 'opt_out') Returns: The subscription type.

Unsubscribe a contact from a subscription type. Args: - contact_id: Contact ID - subscription_id: Subscription type ID Returns: The subscription type.

List conversations from Intercom with pagination. Args: - per_page: Number of conversations to return (1-150, default: 20) - starting_after: Pagination cursor from previous response - format: Response format ('json' or 'markdown') Returns: Paginated list of conversations.

List all tags in the workspace. Returns: List of all tags.

Get a single conversation by ID. Args: - id: The conversation ID - format: Response format ('json' or 'markdown') Returns: The conversation record with all messages.

Create a new conversation. Args: - user_id: ID of the user starting the conversation - body: Message body content Returns: The created conversation.

Reply to an existing conversation. Args: - conversation_id: Conversation ID to reply to - message_type: Type of reply ('comment', 'note') - body: Reply body content - admin_id: Admin ID if replying as admin - attachment_urls: Array of attachment URLs (optional) Returns: The updated conversation.

Assign a conversation to an admin or team. Args: - conversation_id: Conversation ID to assign - admin_id: Admin ID performing the assignment - assignee_id: Admin ID to assign the conversation to - body: Assignment message (optional) Returns: The updated conversation.

Snooze a conversation until a specific time. Args: - conversation_id: Conversation ID to snooze - admin_id: Admin ID performing the snooze - snoozed_until: Unix timestamp when to unsnooze Returns: The snoozed conversation.

Open a closed conversation. Args: - conversation_id: Conversation ID to open - admin_id: Admin ID opening the conversation Returns: The opened conversation.

Close an open conversation. Args: - conversation_id: Conversation ID to close - admin_id: Admin ID closing the conversation - body: Closing message (optional) Returns: The closed conversation.

Search for conversations using Intercom's search API. Args: - field: Field to search on (e.g., 'source.author.id', 'state', 'open', 'read') - operator: Search operator ('=', '!=', 'IN', 'NIN', '>', '<', '~', '!~') - value: Value to search for - per_page: Number of results per page - format: Response format Returns: Paginated list of matching conversations.

Add a tag to a conversation. Args: - conversation_id: Conversation ID - tag_id: Tag ID to add - admin_id: Admin ID adding the tag Returns: The tag that was added.

Remove a tag from a conversation. Args: - conversation_id: Conversation ID - tag_id: Tag ID to remove - admin_id: Admin ID removing the tag Returns: The tag that was removed.

Get a single tag by ID. Args: - id: The tag ID - format: Response format Returns: The tag record.

List data attributes for a specific model. Args: - model: The model to list attributes for ('contact', 'company', 'conversation') - format: Response format Returns: List of data attributes.

Get a single data attribute by ID. Args: - id: The data attribute ID - format: Response format Returns: The data attribute record.

Create a new data attribute. Args: - name: Attribute name - model: Model type ('contact', 'company', 'conversation') - data_type: Data type ('string', 'integer', 'float', 'boolean', 'date') - description: Attribute description - options: Options for list type (array of strings) Returns: The created data attribute.

Update an existing data attribute. Args: - id: Data attribute ID to update - description: New description - archived: Whether to archive the attribute - options: New options for list type Returns: The updated data attribute.

List data events for a user. Args: - type: Filter type (always 'user') - user_id: User ID to list events for (optional) - intercom_user_id: Intercom user ID (optional) - email: User email (optional) - format: Response format Returns: List of data events.

Create a new data event. Args: - event_name: Name of the event - user_id: User ID (optional) - intercom_user_id: Intercom user ID (optional) - email: User email (optional) - created_at: Unix timestamp of when event occurred (optional) - metadata: Event metadata as JSON object Returns: Confirmation of event creation.

List all Help Centers in the workspace. Returns: List of all Help Centers.

Get a single Help Center by ID. Args: - id: The Help Center ID - format: Response format Returns: The Help Center record.

Create and send a new message. This can be used to send in-app messages or emails to users. Args: - message_type: Type of message ('in_app', 'email') - subject: Message subject (required for email) - body: Message body content - template: Message template ('plain', 'personal') - from_admin_id: Admin ID to send from - to_type: Recipient type ('user', 'lead') - to_id: Recipient ID Returns: The created message.

List all segments in the workspace. Args: - format: Response format Returns: List of all segments.

Get a single segment by ID. Args: - id: The segment ID - format: Response format Returns: The segment record.

List all subscription types in the workspace. Returns: List of all subscription types.

Update an existing tag. Args: - id: Tag ID to update - name: New tag name Returns: The updated tag.

Delete a tag. Args: - id: Tag ID to delete Returns: Confirmation of deletion.

List all teams in the workspace. Returns: List of all teams.

Get a single team by ID. Args: - id: The team ID - format: Response format Returns: The team record.

Get a single ticket by ID. Args: - id: The ticket ID - format: Response format Returns: The ticket record.

Update an existing ticket. Args: - id: Ticket ID to update - ticket_attributes: Ticket attributes to update (JSON object) - state: New ticket state ('open', 'in_progress', 'waiting_on_customer', 'resolved') - assignment_admin_id: Admin ID to assign to - is_shared: Whether ticket is shared Returns: The updated ticket.

Reply to a ticket. Args: - ticket_id: Ticket ID to reply to - message_type: Type of reply ('comment', 'note') - body: Reply body content - admin_id: Admin ID if replying as admin Returns: The ticket part (reply).

Search for tickets using Intercom's search API. Args: - field: Field to search on (e.g., 'ticket_state', 'created_at') - operator: Search operator ('=', '!=', 'IN', 'NIN', '>', '<') - value: Value to search for - per_page: Number of results per page - format: Response format Returns: Paginated list of matching tickets.

Get a visitor by ID. Args: - id: Visitor ID - format: Response format Returns: The visitor record.

Update a visitor's attributes. Args: - id: Visitor ID to update - name: Visitor name - custom_attributes: Custom attributes to update Returns: The updated visitor.

Convert a visitor to a user or lead contact. Args: - visitor_id: Visitor ID to convert - type: Type to convert to ('user' or 'lead') - user_id: User ID to merge with (optional, for existing users) - email: Email address (optional) Returns: The new contact.