@utdk/intercom

Intercom API

Generated UTDK provider client for Intercom API. The intercom API reference.

Import sample

import intercom from "@utdk/intercom"

Factory sample

import { createIntercomClient } from "@utdk/intercom"

Provider path: intercom
Source API title: Intercom API
Version: 2.15
Generated: May 30, 2026, 12:26 PM
Homepage: Open site
API spec: View spec

README

Embedded directly from the package source.

intercom

Generated UTDK provider types and OpenAPI-backed client for https://raw.githubusercontent.com/intercom/Intercom-OpenAPI/main/descriptions/2.15/api.intercom.io.yaml.

Operations

156 operations — open try-it console

Method	Operation ID	Path	Summary
GET	identifyAdmin	/me	Identify an admin	Try
PUT	setAwayAdmin	/admins/{admin_id}/away	Set an admin to away	Try
GET	listActivityLogs	/admins/activity_logs	List all activity logs	Try
GET	listAdmins	/admins	List all admins	Try
GET	retrieveAdmin	/admins/{admin_id}	Retrieve an admin	Try
GET	listContentImportSources	/ai/content_import_sources	List content import sources	Try
POST	createContentImportSource	/ai/content_import_sources	Create a content import source	Try
GET	getContentImportSource	/ai/content_import_sources/{source_id}	Retrieve a content import source	Try
PUT	updateContentImportSource	/ai/content_import_sources/{source_id}	Update a content import source	Try
DELETE	deleteContentImportSource	/ai/content_import_sources/{source_id}	Delete a content import source	Try
GET	listExternalPages	/ai/external_pages	List external pages	Try
POST	createExternalPage	/ai/external_pages	Create an external page (or update an external page by external ID)	Try
GET	getExternalPage	/ai/external_pages/{page_id}	Retrieve an external page	Try
PUT	updateExternalPage	/ai/external_pages/{page_id}	Update an external page	Try
DELETE	deleteExternalPage	/ai/external_pages/{page_id}	Delete an external page	Try
GET	listArticles	/articles	List all articles	Try
POST	createArticle	/articles	Create an article	Try
GET	retrieveArticle	/articles/{article_id}	Retrieve an article	Try
PUT	updateArticle	/articles/{article_id}	Update an article	Try
DELETE	deleteArticle	/articles/{article_id}	Delete an article	Try
GET	searchArticles	/articles/search	Search for articles	Try
GET	listAwayStatusReasons	/away_status_reasons	List all away status reasons	Try
POST	startFinConversation	/fin/start	Start a conversation with Fin	Try
POST	replyToFin	/fin/reply	Reply to Fin	Try
GET	listAllCollections	/help_center/collections	List all collections	Try
POST	createCollection	/help_center/collections	Create a collection	Try
GET	retrieveCollection	/help_center/collections/{collection_id}	Retrieve a collection	Try
PUT	updateCollection	/help_center/collections/{collection_id}	Update a collection	Try
DELETE	deleteCollection	/help_center/collections/{collection_id}	Delete a collection	Try
GET	retrieveHelpCenter	/help_center/help_centers/{help_center_id}	Retrieve a Help Center	Try
GET	listHelpCenters	/help_center/help_centers	List all Help Centers	Try
GET	listInternalArticles	/internal_articles	List all articles	Try
POST	createInternalArticle	/internal_articles	Create an internal article	Try
GET	retrieveInternalArticle	/internal_articles/{internal_article_id}	Retrieve an internal article	Try
PUT	updateInternalArticle	/internal_articles/{internal_article_id}	Update an internal article	Try
DELETE	deleteInternalArticle	/internal_articles/{internal_article_id}	Delete an internal article	Try
GET	searchInternalArticles	/internal_articles/search	Search for internal articles	Try
GET	getIpAllowlist	/ip_allowlist	Get IP allowlist settings	Try
PUT	updateIpAllowlist	/ip_allowlist	Update IP allowlist settings	Try
GET	retrieveCompany	/companies	Retrieve companies	Try
POST	createOrUpdateCompany	/companies	Create or Update a company	Try
GET	RetrieveACompanyById	/companies/{company_id}	Retrieve a company by ID	Try
PUT	UpdateCompany	/companies/{company_id}	Update a company	Try
DELETE	deleteCompany	/companies/{company_id}	Delete a company	Try
GET	ListAttachedContacts	/companies/{company_id}/contacts	List attached contacts	Try
GET	ListAttachedSegmentsForCompanies	/companies/{company_id}/segments	List attached segments for companies	Try
GET	listCompanyNotes	/companies/{company_id}/notes	List all company notes	Try
POST	listAllCompanies	/companies/list	List all companies	Try
GET	scrollOverAllCompanies	/companies/scroll	Scroll over all companies	Try
GET	listCompaniesForAContact	/contacts/{contact_id}/companies	List attached companies for contact	Try
POST	attachContactToACompany	/contacts/{contact_id}/companies	Attach a Contact to a Company	Try
DELETE	detachContactFromACompany	/contacts/{contact_id}/companies/{company_id}	Detach a contact from a company	Try
GET	listNotes	/contacts/{contact_id}/notes	List all notes	Try
POST	createNote	/contacts/{contact_id}/notes	Create a note	Try
GET	listSegmentsForAContact	/contacts/{contact_id}/segments	List attached segments for contact	Try
GET	listSubscriptionsForAContact	/contacts/{contact_id}/subscriptions	List subscriptions for a contact	Try
POST	attachSubscriptionTypeToContact	/contacts/{contact_id}/subscriptions	Add subscription to a contact	Try
DELETE	detachSubscriptionTypeToContact	/contacts/{contact_id}/subscriptions/{subscription_id}	Remove subscription from a contact	Try
GET	listTagsForAContact	/contacts/{contact_id}/tags	List tags attached to a contact	Try
POST	attachTagToContact	/contacts/{contact_id}/tags	Add tag to a contact	Try
DELETE	detachTagFromContact	/contacts/{contact_id}/tags/{tag_id}	Remove tag from a contact	Try
GET	ShowContact	/contacts/{contact_id}	Get a contact	Try
PUT	UpdateContact	/contacts/{contact_id}	Update a contact	Try
DELETE	DeleteContact	/contacts/{contact_id}	Delete a contact	Try
POST	MergeContact	/contacts/merge	Merge a lead and a user	Try
POST	SearchContacts	/contacts/search	Search contacts	Try
GET	ListContacts	/contacts	List all contacts	Try
POST	CreateContact	/contacts	Create contact	Try
GET	ShowContactByExternalId	/contacts/find_by_external_id/{external_id}	Get a contact by External ID	Try
POST	ArchiveContact	/contacts/{contact_id}/archive	Archive contact	Try
POST	UnarchiveContact	/contacts/{contact_id}/unarchive	Unarchive contact	Try
POST	BlockContact	/contacts/{contact_id}/block	Block contact	Try
POST	attachTagToConversation	/conversations/{conversation_id}/tags	Add tag to a conversation	Try
DELETE	detachTagFromConversation	/conversations/{conversation_id}/tags/{tag_id}	Remove tag from a conversation	Try
GET	listConversations	/conversations	List all conversations	Try
POST	createConversation	/conversations	Creates a conversation	Try
GET	retrieveConversation	/conversations/{conversation_id}	Retrieve a conversation	Try
PUT	updateConversation	/conversations/{conversation_id}	Update a conversation	Try
DELETE	deleteConversation	/conversations/{conversation_id}	Delete a conversation	Try
POST	searchConversations	/conversations/search	Search conversations	Try
POST	replyConversation	/conversations/{conversation_id}/reply	Reply to a conversation	Try
POST	manageConversation	/conversations/{conversation_id}/parts	Manage a conversation	Try
POST	attachContactToConversation	/conversations/{conversation_id}/customers	Attach a contact to a conversation	Try
DELETE	detachContactFromConversation	/conversations/{conversation_id}/customers/{contact_id}	Detach a contact from a group conversation	Try
POST	redactConversation	/conversations/redact	Redact a conversation part	Try
POST	convertConversationToTicket	/conversations/{conversation_id}/convert	Convert a conversation to a ticket	Try
GET	getCustomObjectInstancesByExternalId	/custom_object_instances/{custom_object_type_identifier}	Get Custom Object Instance by External ID	Try
POST	createCustomObjectInstances	/custom_object_instances/{custom_object_type_identifier}	Create or Update a Custom Object Instance	Try
DELETE	deleteCustomObjectInstancesById	/custom_object_instances/{custom_object_type_identifier}	Delete a Custom Object Instance by External ID	Try
GET	getCustomObjectInstancesById	/custom_object_instances/{custom_object_type_identifier}/{custom_object_instance_id}	Get Custom Object Instance by ID	Try
DELETE	deleteCustomObjectInstancesByExternalId	/custom_object_instances/{custom_object_type_identifier}/{custom_object_instance_id}	Delete a Custom Object Instance by ID	Try
GET	lisDataAttributes	/data_attributes	List all data attributes	Try
POST	createDataAttribute	/data_attributes	Create a data attribute	Try
PUT	updateDataAttribute	/data_attributes/{data_attribute_id}	Update a data attribute	Try
GET	lisDataEvents	/events	List all data events	Try
POST	createDataEvent	/events	Submit a data event	Try
POST	dataEventSummaries	/events/summaries	Create event summaries	Try
POST	createDataExport	/export/content/data	Create content data export	Try
GET	getDataExport	/export/content/data/{job_identifier}	Show content data export	Try
POST	cancelDataExport	/export/cancel/{job_identifier}	Cancel content data export	Try
GET	downloadDataExport	/download/content/data/{job_identifier}	Download content data export	Try
GET	jobsStatus	/jobs/status/{job_id}	Retrieve job status	Try
POST	createMessage	/messages	Create a message	Try
GET	listNewsItems	/news/news_items	List all news items	Try
POST	createNewsItem	/news/news_items	Create a news item	Try
GET	retrieveNewsItem	/news/news_items/{news_item_id}	Retrieve a news item	Try
PUT	updateNewsItem	/news/news_items/{news_item_id}	Update a news item	Try
DELETE	deleteNewsItem	/news/news_items/{news_item_id}	Delete a news item	Try
GET	listLiveNewsfeedItems	/news/newsfeeds/{newsfeed_id}/items	List all live newsfeed items	Try
GET	listNewsfeeds	/news/newsfeeds	List all newsfeeds	Try
GET	retrieveNewsfeed	/news/newsfeeds/{newsfeed_id}	Retrieve a newsfeed	Try
GET	retrieveNote	/notes/{note_id}	Retrieve a note	Try
GET	listSegments	/segments	List all segments	Try
GET	retrieveSegment	/segments/{segment_id}	Retrieve a segment	Try
GET	listSubscriptionTypes	/subscription_types	List subscription types	Try
POST	createPhoneSwitch	/phone_call_redirects	Create a phone Switch	Try
GET	listCalls	/calls	List all calls	Try
GET	showCall	/calls/{call_id}	Get a call	Try
GET	showCallRecording	/calls/{call_id}/recording	Get call recording by call id	Try
GET	showCallTranscript	/calls/{call_id}/transcript	Get call transcript by call id	Try
POST	listCallsWithTranscripts	/calls/search	List calls with transcripts	Try
GET	listTags	/tags	List all tags	Try
POST	createTag	/tags	Create or update a tag, Tag or untag companies, Tag contacts	Try
GET	findTag	/tags/{tag_id}	Find a specific tag	Try
DELETE	deleteTag	/tags/{tag_id}	Delete tag	Try
GET	listTeams	/teams	List all teams	Try
GET	retrieveTeam	/teams/{team_id}	Retrieve a team	Try
GET	listTicketStates	/ticket_states	List all ticket states	Try
POST	createTicketTypeAttribute	/ticket_types/{ticket_type_id}/attributes	Create a new attribute for a ticket type	Try
PUT	updateTicketTypeAttribute	/ticket_types/{ticket_type_id}/attributes/{attribute_id}	Update an existing attribute for a ticket type	Try
GET	listTicketTypes	/ticket_types	List all ticket types	Try
POST	createTicketType	/ticket_types	Create a ticket type	Try
GET	getTicketType	/ticket_types/{ticket_type_id}	Retrieve a ticket type	Try
PUT	updateTicketType	/ticket_types/{ticket_type_id}	Update a ticket type	Try
POST	replyTicket	/tickets/{ticket_id}/reply	Reply to a ticket	Try
POST	attachTagToTicket	/tickets/{ticket_id}/tags	Add tag to a ticket	Try
DELETE	detachTagFromTicket	/tickets/{ticket_id}/tags/{tag_id}	Remove tag from a ticket	Try
POST	createTicket	/tickets	Create a ticket	Try
POST	enqueueCreateTicket	/tickets/enqueue	Enqueue create ticket	Try
GET	getTicket	/tickets/{ticket_id}	Retrieve a ticket	Try
PUT	updateTicket	/tickets/{ticket_id}	Update a ticket	Try
DELETE	deleteTicket	/tickets/{ticket_id}	Delete a ticket	Try
POST	searchTickets	/tickets/search	Search tickets	Try
GET	retrieveVisitorWithUserId	/visitors	Retrieve a visitor with User ID	Try
PUT	updateVisitor	/visitors	Update a visitor	Try
POST	convertVisitor	/visitors/convert	Convert a visitor	Try
GET	listBrands	/brands	List all brands	Try
GET	retrieveBrand	/brands/{id}	Retrieve a brand	Try
GET	listEmails	/emails	List all email settings	Try
GET	retrieveEmail	/emails/{id}	Retrieve an email setting	Try
POST	registerFinVoiceCall	/fin_voice/register	Register a Fin Voice call	Try
GET	collectFinVoiceCallById	/fin_voice/collect/{id}	Collect Fin Voice call by ID	Try
GET	collectFinVoiceCallByExternalId	/fin_voice/external_id/{external_id}	Collect Fin Voice call by external ID	Try
GET	collectFinVoiceCallByPhoneNumber	/fin_voice/phone_number/{phone_number}	Collect Fin Voice call by phone number	Try
GET	collectFinVoiceCallsByConversationId	/fin_voice/conversation/{conversation_id}	Collect Fin Voice calls by conversation ID	Try
GET	exportWorkflow	/export/workflows/{id}	Export a workflow	Try