Documentation Index Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
Use this file to discover all available pages before exploring further.
Server path: /intercom | Type: Application | PCID required: YesTool Description intercom_start_fin_conversationStart a new Fin conversation on behalf of a user. Sends an initial user message and optional user/context data into Fin. Returns the Fin conversation ID, current status, reply HTML, and metadata. intercom_send_fin_replyContinue an existing Fin conversation by sending a follow-up user message. Returns updated status, reply HTML, and metadata. intercom_get_fin_conversation_metadataRetrieve metadata for a Fin conversation (state, tags, ai_agent, contacts, etc.). Use the Intercom conversation ID returned by intercom_start_fin_conversation or intercom_send_fin_reply. intercom_list_fin_content_sourcesList content sources used by Fin for knowledge. intercom_create_fin_content_sourceCreate a new content source for Fin knowledge. intercom_update_fin_content_sourceUpdate an existing content source for Fin. intercom_list_fin_external_pagesList external pages (documents) Fin can use as knowledge. Optionally filter by source ID or external ID. intercom_upsert_fin_external_pageCreate or update an External Page used by Fin for knowledge. Uses the external_id as a stable identifier for upsert behavior. intercom_delete_fin_external_pageDelete an External Page from Fin knowledge. intercom_list_conversationsList Intercom conversations with optional sorting and pagination. intercom_search_conversationsSearch Intercom conversations using a query object with filters for attributes, tags, date ranges, assignees, and state. intercom_get_conversationFetch full details for an Intercom conversation including parts, participants, tags, and stats. intercom_reply_to_conversationPost a reply into an existing Intercom conversation. intercom_create_conversationOpen a new Intercom conversation with a contact. intercom_list_contactsList Intercom contacts with pagination. intercom_search_contactsSearch Intercom contacts by attributes such as name, email, phone, tags, and custom properties. intercom_get_contactRetrieve a single Intercom contact with full details including custom attributes and activity. intercom_create_or_update_contactUpsert an Intercom contact by email or external ID. Creates a new contact if none exists, or updates the existing one. intercom_delete_contactDelete an Intercom contact by ID. intercom_list_contact_notesList notes attached to an Intercom contact. intercom_create_contact_noteAttach a note to an Intercom contact (e.g., a summary from Fin or internal context). intercom_add_tag_to_conversationApply a tag to an Intercom conversation for routing, analytics, or categorization. Requires the Intercom tag ID (from list tags or conversation tag objects). intercom_remove_tag_from_conversationRemove a tag from an Intercom conversation. Requires the Intercom tag ID (from the conversation’s tags). intercom_create_ticketCreate a structured ticket. Requires Intercom Tickets to be enabled. Title and description are sent as default_title and default_description under ticket_attributes. intercom_update_ticketUpdate an existing Intercom ticket. intercom_list_ticket_typesList all ticket types configured in the Intercom workspace. Useful for finding the ticket_type_id needed to create tickets.
intercom_start_fin_conversation Start a new Fin conversation on behalf of a user. Sends an initial user message and optional user/context data into Fin. Returns the Fin conversation ID, current status, reply HTML, and metadata.
Parameters: Parameter Type Required Default Description messagestring Yes — Initial user message to send to Fin conversation_idstring No — External conversation ID to associate with this Fin conversation userobject No — User identity timestampstring No — ISO 8601 timestamp of the message (e.g., 2025-01-24T10:01:20.000Z)
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID" }, "message" : { "type" : "string" , "description" : "Initial user message to send to Fin" }, "conversation_id" : { "type" : "string" , "description" : "External conversation ID to associate with this Fin conversation" }, "user" : { "type" : "object" , "properties" : { "id" : { "type" : "string" , "description" : "User ID in Intercom" }, "name" : { "type" : "string" , "description" : "User display name" }, "email" : { "type" : "string" , "description" : "User email" } }, "description" : "User identity" }, "timestamp" : { "type" : "string" , "description" : "ISO 8601 timestamp of the message (e.g., 2025-01-24T10:01:20.000Z)" } }, "required" : [ "PCID" , "message" ] }
intercom_send_fin_reply Continue an existing Fin conversation by sending a follow-up user message. Returns updated status, reply HTML, and metadata.
Parameters: Parameter Type Required Default Description conversation_idstring Yes — Intercom conversation ID to continue messagestring Yes — Follow-up user message userobject No — User identity timestampstring No — ISO 8601 timestamp of the message (e.g., 2025-01-24T10:01:20.000Z)
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID" }, "conversation_id" : { "type" : "string" , "description" : "Intercom conversation ID to continue" }, "message" : { "type" : "string" , "description" : "Follow-up user message" }, "user" : { "type" : "object" , "properties" : { "id" : { "type" : "string" , "description" : "User ID in Intercom" }, "name" : { "type" : "string" , "description" : "User display name" }, "email" : { "type" : "string" , "description" : "User email" } }, "description" : "User identity" }, "timestamp" : { "type" : "string" , "description" : "ISO 8601 timestamp of the message (e.g., 2025-01-24T10:01:20.000Z)" } }, "required" : [ "PCID" , "conversation_id" , "message" ] }
Retrieve metadata for a Fin conversation (state, tags, ai_agent, contacts, etc.). Use the Intercom conversation ID returned by intercom_start_fin_conversation or intercom_send_fin_reply.
Parameters: Parameter Type Required Default Description conversation_idstring Yes — Intercom conversation ID (same ID returned by intercom_start_fin_conversation and intercom_send_fin_reply)
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID" }, "conversation_id" : { "type" : "string" , "description" : "Intercom conversation ID (same ID returned by intercom_start_fin_conversation and intercom_send_fin_reply)" } }, "required" : [ "PCID" , "conversation_id" ] }
intercom_list_fin_content_sources List content sources used by Fin for knowledge.
Parameters: Parameter Type Required Default Description pagenumber No — Page number for pagination per_pagenumber No — Number of results per page
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID" }, "page" : { "type" : "number" , "description" : "Page number for pagination" }, "per_page" : { "type" : "number" , "description" : "Number of results per page" } }, "required" : [ "PCID" ] }
intercom_create_fin_content_source Create a new content source for Fin knowledge.
Parameters: Parameter Type Required Default Description namestring Yes — Name of the content source descriptionstring No — Description of the content source configobject No — Configuration (audience, visibility, etc.)
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID" }, "name" : { "type" : "string" , "description" : "Name of the content source" }, "description" : { "type" : "string" , "description" : "Description of the content source" }, "config" : { "type" : "object" , "additionalProperties" : true , "description" : "Configuration (audience, visibility, etc.)" } }, "required" : [ "PCID" , "name" ] }
intercom_update_fin_content_source Update an existing content source for Fin.
Parameters: Parameter Type Required Default Description source_idstring Yes — Content source ID to update namestring No — Updated name descriptionstring No — Updated description configobject No — Updated configuration
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID" }, "source_id" : { "type" : "string" , "description" : "Content source ID to update" }, "name" : { "type" : "string" , "description" : "Updated name" }, "description" : { "type" : "string" , "description" : "Updated description" }, "config" : { "type" : "object" , "additionalProperties" : true , "description" : "Updated configuration" } }, "required" : [ "PCID" , "source_id" ] }
intercom_list_fin_external_pages List external pages (documents) Fin can use as knowledge. Optionally filter by source ID or external ID.
Parameters: Parameter Type Required Default Description source_idstring No — Filter by content source ID external_idstring No — Filter by external page ID pagenumber No — Page number for pagination per_pagenumber No — Number of results per page
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID" }, "source_id" : { "type" : "string" , "description" : "Filter by content source ID" }, "external_id" : { "type" : "string" , "description" : "Filter by external page ID" }, "page" : { "type" : "number" , "description" : "Page number for pagination" }, "per_page" : { "type" : "number" , "description" : "Number of results per page" } }, "required" : [ "PCID" ] }
intercom_upsert_fin_external_page Create or update an External Page used by Fin for knowledge. Uses the external_id as a stable identifier for upsert behavior.
Parameters: Parameter Type Required Default Description external_idstring Yes — Your stable identifier for the page (used for upsert) titlestring Yes — Page title bodystring Yes — Page content (HTML or markdown) urlstring No — Source URL of the page source_idstring No — Content source ID this page belongs to metadataobject No — Additional metadata
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID" }, "external_id" : { "type" : "string" , "description" : "Your stable identifier for the page (used for upsert)" }, "title" : { "type" : "string" , "description" : "Page title" }, "body" : { "type" : "string" , "description" : "Page content (HTML or markdown)" }, "url" : { "type" : "string" , "description" : "Source URL of the page" }, "source_id" : { "type" : "string" , "description" : "Content source ID this page belongs to" }, "metadata" : { "type" : "object" , "additionalProperties" : true , "description" : "Additional metadata" } }, "required" : [ "PCID" , "external_id" , "title" , "body" ] }
intercom_delete_fin_external_page Delete an External Page from Fin knowledge.
Parameters: Parameter Type Required Default Description external_idstring No — External ID of the page to delete page_idstring No — Intercom page ID to delete (provide either external_id or page_id)
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID" }, "external_id" : { "type" : "string" , "description" : "External ID of the page to delete" }, "page_id" : { "type" : "string" , "description" : "Intercom page ID to delete (provide either external_id or page_id)" } }, "required" : [ "PCID" ] }
intercom_list_conversations List Intercom conversations with optional sorting and pagination.
Parameters: Parameter Type Required Default Description pagenumber No — Page number for pagination per_pagenumber No — Number of results per page sortstring No — Field to sort by (e.g., created_at, updated_at) orderstring No — Sort order
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID" }, "page" : { "type" : "number" , "description" : "Page number for pagination" }, "per_page" : { "type" : "number" , "description" : "Number of results per page" }, "sort" : { "type" : "string" , "description" : "Field to sort by (e.g., created_at, updated_at)" }, "order" : { "type" : "string" , "enum" : [ "asc" , "desc" ], "description" : "Sort order" } }, "required" : [ "PCID" ] }
intercom_search_conversations Search Intercom conversations using a query object with filters for attributes, tags, date ranges, assignees, and state.
Parameters: Parameter Type Required Default Description queryobject Yes — Search query object with filters (attributes, tags, date ranges, etc.) pagenumber No — Page number for pagination per_pagenumber No — Number of results per page
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID" }, "query" : { "type" : "object" , "additionalProperties" : true , "description" : "Search query object with filters (attributes, tags, date ranges, etc.)" }, "page" : { "type" : "number" , "description" : "Page number for pagination" }, "per_page" : { "type" : "number" , "description" : "Number of results per page" } }, "required" : [ "PCID" , "query" ] }
intercom_get_conversation Fetch full details for an Intercom conversation including parts, participants, tags, and stats.
Parameters: Parameter Type Required Default Description conversation_idstring Yes — Conversation ID to retrieve
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID" }, "conversation_id" : { "type" : "string" , "description" : "Conversation ID to retrieve" } }, "required" : [ "PCID" , "conversation_id" ] }
intercom_reply_to_conversation Post a reply into an existing Intercom conversation.
Parameters: Parameter Type Required Default Description conversation_idstring Yes — Conversation ID to reply to message_typestring Yes — Message type (comment for user-visible reply, note for internal) typestring Yes — Author type of the reply bodystring Yes — Reply message body (HTML supported) intercom_user_idstring No — Intercom user ID of the author (required when type is “user”) attachmentsobject[] No — File attachments metadataobject No — Additional metadata
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID" }, "conversation_id" : { "type" : "string" , "description" : "Conversation ID to reply to" }, "message_type" : { "type" : "string" , "enum" : [ "comment" , "note" ], "description" : "Message type (comment for user-visible reply, note for internal)" }, "type" : { "type" : "string" , "enum" : [ "admin" , "user" , "bot" ], "description" : "Author type of the reply" }, "body" : { "type" : "string" , "description" : "Reply message body (HTML supported)" }, "intercom_user_id" : { "type" : "string" , "description" : "Intercom user ID of the author (required when type is \" user \" )" }, "attachments" : { "type" : "array" , "items" : { "type" : "object" , "additionalProperties" : true }, "description" : "File attachments" }, "metadata" : { "type" : "object" , "additionalProperties" : true , "description" : "Additional metadata" } }, "required" : [ "PCID" , "conversation_id" , "message_type" , "type" , "body" ] }
intercom_create_conversation Open a new Intercom conversation with a contact.
Parameters: Parameter Type Required Default Description contact_idstring No — Contact ID (provide contact_id or email) emailstring No — Contact email (provide contact_id or email) bodystring Yes — Initial message body fromobject Yes — Sender identity metadataobject No — Additional metadata
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID" }, "contact_id" : { "type" : "string" , "description" : "Contact ID (provide contact_id or email)" }, "email" : { "type" : "string" , "description" : "Contact email (provide contact_id or email)" }, "body" : { "type" : "string" , "description" : "Initial message body" }, "from" : { "type" : "object" , "properties" : { "type" : { "type" : "string" , "description" : "Sender type (admin, bot)" }, "id" : { "type" : "string" , "description" : "Sender ID" } }, "description" : "Sender identity" }, "metadata" : { "type" : "object" , "additionalProperties" : true , "description" : "Additional metadata" } }, "required" : [ "PCID" , "body" , "from" ] }
List Intercom contacts with pagination.
Parameters: Parameter Type Required Default Description pagenumber No — Page number for pagination per_pagenumber No — Number of results per page
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID" }, "page" : { "type" : "number" , "description" : "Page number for pagination" }, "per_page" : { "type" : "number" , "description" : "Number of results per page" } }, "required" : [ "PCID" ] }
Search Intercom contacts by attributes such as name, email, phone, tags, and custom properties.
Parameters: Parameter Type Required Default Description queryobject Yes — Search query object with filters (properties, tags, etc.) pagenumber No — Page number for pagination per_pagenumber No — Number of results per page
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID" }, "query" : { "type" : "object" , "additionalProperties" : true , "description" : "Search query object with filters (properties, tags, etc.)" }, "page" : { "type" : "number" , "description" : "Page number for pagination" }, "per_page" : { "type" : "number" , "description" : "Number of results per page" } }, "required" : [ "PCID" , "query" ] }
Retrieve a single Intercom contact with full details including custom attributes and activity.
Parameters: Parameter Type Required Default Description contact_idstring Yes — Contact ID to retrieve
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID" }, "contact_id" : { "type" : "string" , "description" : "Contact ID to retrieve" } }, "required" : [ "PCID" , "contact_id" ] }
Upsert an Intercom contact by email or external ID. Creates a new contact if none exists, or updates the existing one.
Parameters: Parameter Type Required Default Description contact_idstring No — Existing contact ID to update emailstring No — Contact email (used for matching) external_idstring No — External ID (used for matching) attributesobject No — Contact attributes to set (name, phone, custom_attributes, etc.)
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID" }, "contact_id" : { "type" : "string" , "description" : "Existing contact ID to update" }, "email" : { "type" : "string" , "description" : "Contact email (used for matching)" }, "external_id" : { "type" : "string" , "description" : "External ID (used for matching)" }, "attributes" : { "type" : "object" , "additionalProperties" : true , "description" : "Contact attributes to set (name, phone, custom_attributes, etc.)" } }, "required" : [ "PCID" ] }
Delete an Intercom contact by ID.
Parameters: Parameter Type Required Default Description contact_idstring Yes — Contact ID to delete
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID" }, "contact_id" : { "type" : "string" , "description" : "Contact ID to delete" } }, "required" : [ "PCID" , "contact_id" ] }
List notes attached to an Intercom contact.
Parameters: Parameter Type Required Default Description contact_idstring Yes — Contact ID to list notes for pagenumber No — Page number for pagination per_pagenumber No — Number of results per page
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID" }, "contact_id" : { "type" : "string" , "description" : "Contact ID to list notes for" }, "page" : { "type" : "number" , "description" : "Page number for pagination" }, "per_page" : { "type" : "number" , "description" : "Number of results per page" } }, "required" : [ "PCID" , "contact_id" ] }
Attach a note to an Intercom contact (e.g., a summary from Fin or internal context).
Parameters: Parameter Type Required Default Description contact_idstring Yes — Contact ID to attach the note to bodystring Yes — Note content metadataobject No — Additional metadata
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID" }, "contact_id" : { "type" : "string" , "description" : "Contact ID to attach the note to" }, "body" : { "type" : "string" , "description" : "Note content" }, "metadata" : { "type" : "object" , "additionalProperties" : true , "description" : "Additional metadata" } }, "required" : [ "PCID" , "contact_id" , "body" ] }
intercom_add_tag_to_conversation Apply a tag to an Intercom conversation for routing, analytics, or categorization. Requires the Intercom tag ID (from list tags or conversation tag objects).
Parameters: Parameter Type Required Default Description conversation_idstring Yes — Conversation ID to tag tag_idstring Yes — Intercom tag ID (e.g. “7522907”) admin_idstring No — Intercom admin ID (required by API if not injected by proxy)
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID" }, "conversation_id" : { "type" : "string" , "description" : "Conversation ID to tag" }, "tag_id" : { "type" : "string" , "description" : "Intercom tag ID (e.g. \" 7522907 \" )" }, "admin_id" : { "type" : "string" , "description" : "Intercom admin ID (required by API if not injected by proxy)" } }, "required" : [ "PCID" , "conversation_id" , "tag_id" ] }
intercom_remove_tag_from_conversation Remove a tag from an Intercom conversation. Requires the Intercom tag ID (from the conversation’s tags).
Parameters: Parameter Type Required Default Description conversation_idstring Yes — Conversation ID to remove tag from tag_idstring Yes — Intercom tag ID (e.g. “7522907”) admin_idstring No — Intercom admin ID (required by API if not injected by proxy)
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID" }, "conversation_id" : { "type" : "string" , "description" : "Conversation ID to remove tag from" }, "tag_id" : { "type" : "string" , "description" : "Intercom tag ID (e.g. \" 7522907 \" )" }, "admin_id" : { "type" : "string" , "description" : "Intercom admin ID (required by API if not injected by proxy)" } }, "required" : [ "PCID" , "conversation_id" , "tag_id" ] }
intercom_create_ticket Create a structured ticket. Requires Intercom Tickets to be enabled. Title and description are sent as default_title and default_description under ticket_attributes.
Parameters: Parameter Type Required Default Description ticket_type_idnumber Yes — Ticket type ID (required, numeric). Find in Intercom Settings > Tickets > Ticket Types. titlestring Yes — Ticket title (sent as default_title ) descriptionstring Yes — Ticket description (sent as default_description ) contactsobject[] No — Array of contacts to associate with the ticket ticket_attributesobject No — Additional custom ticket attributes beyond title and description
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID" }, "ticket_type_id" : { "type" : "number" , "description" : "Ticket type ID (required, numeric). Find in Intercom Settings > Tickets > Ticket Types." }, "title" : { "type" : "string" , "description" : "Ticket title (sent as _default_title_)" }, "description" : { "type" : "string" , "description" : "Ticket description (sent as _default_description_)" }, "contacts" : { "type" : "array" , "items" : { "type" : "object" , "properties" : { "id" : { "type" : "string" , "description" : "Contact ID" } } }, "description" : "Array of contacts to associate with the ticket" }, "ticket_attributes" : { "type" : "object" , "additionalProperties" : true , "description" : "Additional custom ticket attributes beyond title and description" } }, "required" : [ "PCID" , "ticket_type_id" , "title" , "description" ] }
intercom_update_ticket Update an existing Intercom ticket.
Parameters: Parameter Type Required Default Description ticket_idstring Yes — Ticket ID to update statusstring No — Updated ticket status assignee_idstring No — Admin/team ID to assign the ticket to ticket_attributesobject No — Ticket attributes to update (e.g., default_title , default_description , custom fields)
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID" }, "ticket_id" : { "type" : "string" , "description" : "Ticket ID to update" }, "status" : { "type" : "string" , "description" : "Updated ticket status" }, "assignee_id" : { "type" : "string" , "description" : "Admin/team ID to assign the ticket to" }, "ticket_attributes" : { "type" : "object" , "additionalProperties" : true , "description" : "Ticket attributes to update (e.g., _default_title_, _default_description_, custom fields)" } }, "required" : [ "PCID" , "ticket_id" ] }
intercom_list_ticket_types List all ticket types configured in the Intercom workspace. Useful for finding the ticket_type_id needed to create tickets.
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID" } }, "required" : [ "PCID" ] }
