Module intercom

ballerinax/intercom Ballerina library

1.0.1

Overview

Intercom is a customer service platform that enables businesses to communicate with customers through messaging, support, and engagement tools, helping companies build better customer relationships at scale.

The ballerinax/intercom package offers APIs to connect and interact with Intercom API endpoints, specifically based on Intercom API v2.15.

Key Features

Contacts management — create, update, search, and delete contacts
Conversations management — create, retrieve, update, and reply to conversations
Ticket management — create, update, reply to, and delete support tickets
Articles and knowledge base management — manage help center articles
Tags management — create and assign tags to contacts, conversations, and tickets
Companies management — create, update, and retrieve company data
Admins management — retrieve admin details and manage team assignments

Setup guide

To use the Intercom connector, you must have access to the Intercom API through an Intercom developer account and obtain an API access token. If you do not have an Intercom account, you can sign up for Intercom.

Create an Intercom account

Navigate to the Intercom website and sign up for an account or log in if you already have one.
Ensure you have a paid plan (Starter plan or higher), as API access is not available on the free trial version.

Generate an API access token

Log in to your Intercom account.
Navigate to Settings (gear icon in the top right corner), then select For Developers from the left sidebar.
In the Developer Hub, click on Your Apps, then select New app to create a new app or select an existing app.
Once in your app, go to the Configure tab and scroll down to the Access Token section to generate your access token.

Tip: Copy and store this token somewhere safe. It will not be visible again in your account settings for security reasons.

Quickstart

To use the intercom connector in your Ballerina application, modify the .bal file as follows:

Step 1: Import the module


import ballerinax/intercom;

Step 2: Instantiate a new connector

Create a Config.toml file and configure the obtained access token:


token = "<Your_Intercom_Access_Token>"

Create an intercom:ConnectionConfig and initialize the client:


configurable string token = ?;

final intercom:Client intercomClient = check new ({
    auth: {
        token
    }
});

Step 3: Invoke the connector operation

Now, utilize the available connector operations.

Create a contact


public function main() returns error? {
    intercom:ContactsBody newContact = {
        email: "user@example.com",
        name: "User Name"
    };

    intercom:ContactWithPush response = check intercomClient->/contacts.post(newContact);
}

Create a conversation


public function main() returns error? {
    intercom:CreateConversationRequest payload = {
        body: "Hello, I need help with my account.",
        'from: {'type: "user", id: "<contact_id>"}
    };

    intercom:ConversationMessage response = check intercomClient->/conversations.post(payload);
}

Examples

The ballerinax/intercom connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering the following use cases:

Support team analytics - Demonstrates how to analyze support team performance metrics using the Ballerina Intercom connector.
Priority ticket escalation - Illustrates automating the escalation of high-priority support tickets.
Support ticket automation - Shows how to automate support ticket creation and management workflows.
Knowledge base management - Demonstrates managing and updating knowledge base articles programmatically.

Clients

intercom: Client

Isolated

The intercom API reference.

Constructor

Gets invoked to initialize the connector.

init (ConnectionConfig config, string serviceUrl)

config ConnectionConfig - The configurations to be used when initializing the connector

serviceUrl string "https://api.intercom.io" - URL of the target service

get me

Isolated FunctionResource Function

function get me(IdentifyAdminHeaders headers) returns AdminWithApp|error

Identify an admin

Parameters

headers IdentifyAdminHeaders (default {}) - Headers to be sent with the request

Return Type

AdminWithApp|error - Successful response

put admins/[int adminId]/away

Isolated FunctionResource Function

function put admins/[int adminId]/away(AdminIdAwayBody payload, SetAwayAdminHeaders headers) returns Admin|error

Set an admin to away

Parameters

payload AdminIdAwayBody -

headers SetAwayAdminHeaders (default {}) - Headers to be sent with the request

Return Type

Admin|error - Successful response

get admins/activity_logs

Isolated FunctionResource Function

function get admins/activity_logs(ListActivityLogsHeaders headers, *ListActivityLogsQueries queries) returns ActivityLogList|error

List all activity logs

Parameters

headers ListActivityLogsHeaders (default {}) - Headers to be sent with the request

queries *ListActivityLogsQueries - Queries to be sent with the request

Return Type

ActivityLogList|error - Successful response

get admins

Isolated FunctionResource Function

function get admins(ListAdminsHeaders headers) returns AdminList|error

List all admins

Parameters

headers ListAdminsHeaders (default {}) - Headers to be sent with the request

Return Type

AdminList|error - Successful response

get admins/[int adminId]

Isolated FunctionResource Function

function get admins/[int adminId](RetrieveAdminHeaders headers) returns Admin|error

Retrieve an admin

Parameters

headers RetrieveAdminHeaders (default {}) - Headers to be sent with the request

Return Type

Admin|error - Admin found

get ai/content_import_sources

Isolated FunctionResource Function

function get ai/content_import_sources(ListContentImportSourcesHeaders headers) returns ContentImportSourcesList|error

List content import sources

Parameters

headers ListContentImportSourcesHeaders (default {}) - Headers to be sent with the request

Return Type

ContentImportSourcesList|error - successful

post ai/content_import_sources

Isolated FunctionResource Function

function post ai/content_import_sources(CreateContentImportSourceRequest payload, CreateContentImportSourceHeaders headers) returns ContentImportSource|error

Create a content import source

Parameters

payload CreateContentImportSourceRequest -

headers CreateContentImportSourceHeaders (default {}) - Headers to be sent with the request

Return Type

ContentImportSource|error - successful

get ai/content_import_sources/[string sourceId]

Isolated FunctionResource Function

function get ai/content_import_sources/[string sourceId](GetContentImportSourceHeaders headers) returns ContentImportSource|error

Retrieve a content import source

Parameters

headers GetContentImportSourceHeaders (default {}) - Headers to be sent with the request

Return Type

ContentImportSource|error - successful

put ai/content_import_sources/[string sourceId]

Isolated FunctionResource Function

function put ai/content_import_sources/[string sourceId](UpdateContentImportSourceRequest payload, UpdateContentImportSourceHeaders headers) returns ContentImportSource|error

Update a content import source

Parameters

payload UpdateContentImportSourceRequest -

headers UpdateContentImportSourceHeaders (default {}) - Headers to be sent with the request

Return Type

ContentImportSource|error - successful

delete ai/content_import_sources/[string sourceId]

Isolated FunctionResource Function

function delete ai/content_import_sources/[string sourceId](DeleteContentImportSourceHeaders headers) returns error?

Delete a content import source

Parameters

headers DeleteContentImportSourceHeaders (default {}) - Headers to be sent with the request

Return Type

error? - successful

get ai/external_pages

Isolated FunctionResource Function

function get ai/external_pages(ListExternalPagesHeaders headers) returns ExternalPagesList|error

List external pages

Parameters

headers ListExternalPagesHeaders (default {}) - Headers to be sent with the request

Return Type

ExternalPagesList|error - successful

post ai/external_pages

Isolated FunctionResource Function

function post ai/external_pages(CreateExternalPageRequest payload, CreateExternalPageHeaders headers) returns ExternalPage|error

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

Parameters

payload CreateExternalPageRequest -

headers CreateExternalPageHeaders (default {}) - Headers to be sent with the request

Return Type

ExternalPage|error - successful

get ai/external_pages/[string pageId]

Isolated FunctionResource Function

function get ai/external_pages/[string pageId](GetExternalPageHeaders headers) returns ExternalPage|error

Retrieve an external page

Parameters

headers GetExternalPageHeaders (default {}) - Headers to be sent with the request

Return Type

ExternalPage|error - successful

put ai/external_pages/[string pageId]

Isolated FunctionResource Function

function put ai/external_pages/[string pageId](UpdateExternalPageRequest payload, UpdateExternalPageHeaders headers) returns ExternalPage|error

Update an external page

Parameters

payload UpdateExternalPageRequest -

headers UpdateExternalPageHeaders (default {}) - Headers to be sent with the request

Return Type

ExternalPage|error - successful

delete ai/external_pages/[string pageId]

Isolated FunctionResource Function

function delete ai/external_pages/[string pageId](DeleteExternalPageHeaders headers) returns ExternalPage|error

Delete an external page

Parameters

headers DeleteExternalPageHeaders (default {}) - Headers to be sent with the request

Return Type

ExternalPage|error - successful

get articles

Isolated FunctionResource Function

function get articles(ListArticlesHeaders headers) returns ArticleList|error

List all articles

Parameters

headers ListArticlesHeaders (default {}) - Headers to be sent with the request

Return Type

ArticleList|error - successful

post articles

Isolated FunctionResource Function

function post articles(CreateArticleRequest payload, CreateArticleHeaders headers) returns Article|error

Create an article

Parameters

payload CreateArticleRequest -

headers CreateArticleHeaders (default {}) - Headers to be sent with the request

Return Type

Article|error - article created

get articles/[int articleId]

Isolated FunctionResource Function

function get articles/[int articleId](RetrieveArticleHeaders headers) returns Article|error

Retrieve an article

Parameters

headers RetrieveArticleHeaders (default {}) - Headers to be sent with the request

Return Type

Article|error - Article found

put articles/[int articleId]

Isolated FunctionResource Function

function put articles/[int articleId](UpdateArticleRequest payload, UpdateArticleHeaders headers) returns Article|error

Update an article

Parameters

payload UpdateArticleRequest -

headers UpdateArticleHeaders (default {}) - Headers to be sent with the request

Return Type

Article|error - successful

delete articles/[int articleId]

Isolated FunctionResource Function

function delete articles/[int articleId](DeleteArticleHeaders headers) returns DeletedArticleObject|error

Delete an article

Parameters

headers DeleteArticleHeaders (default {}) - Headers to be sent with the request

Return Type

DeletedArticleObject|error - successful

get articles/search

Isolated FunctionResource Function

function get articles/search(SearchArticlesHeaders headers, *SearchArticlesQueries queries) returns ArticleSearchResponse|error

Search for articles

Parameters

headers SearchArticlesHeaders (default {}) - Headers to be sent with the request

queries *SearchArticlesQueries - Queries to be sent with the request

Return Type

ArticleSearchResponse|error - Search successful

get away_status_reasons

Isolated FunctionResource Function

function get away_status_reasons(ListAwayStatusReasonsHeaders headers) returns AwayStatusReason[]|error

List all away status reasons

Parameters

headers ListAwayStatusReasonsHeaders (default {}) - Headers to be sent with the request

Return Type

AwayStatusReason[]|error - Successful response

post export/reporting_data/enqueue

Isolated FunctionResource Function

function post export/reporting_data/enqueue(ReportingDataEnqueueBody payload, EnqueueReportingDataExportHeaders headers) returns ReportingJobResponse|error

Enqueue a new reporting data export job

Parameters

payload ReportingDataEnqueueBody -

headers EnqueueReportingDataExportHeaders (default {}) - Headers to be sent with the request

Return Type

ReportingJobResponse|error - Job enqueued successfully

get export/reporting_data/[string job_identifier]

Isolated FunctionResource Function

function get export/reporting_data/[string job_identifier](GetReportingDataExportStatusHeaders headers, *GetReportingDataExportStatusQueries queries) returns DataExportStatus|error

Get export job status

Parameters

headers GetReportingDataExportStatusHeaders (default {}) - Headers to be sent with the request

queries *GetReportingDataExportStatusQueries - Queries to be sent with the request

Return Type

DataExportStatus|error - Job status returned successfully

get export/reporting_data/get_datasets

Isolated FunctionResource Function

function get export/reporting_data/get_datasets(ListReportingDatasetsHeaders headers) returns DatasetListResponse|error

List available datasets and attributes

Parameters

headers ListReportingDatasetsHeaders (default {}) - Headers to be sent with the request

Return Type

DatasetListResponse|error - List of datasets

get download/reporting_data/[string job_identifier]

Isolated FunctionResource Function

function get download/reporting_data/[string job_identifier](DownloadReportingDataExportHeaders headers, *DownloadReportingDataExportQueries queries) returns error?

Download completed export job data

Parameters

headers DownloadReportingDataExportHeaders - Headers to be sent with the request

queries *DownloadReportingDataExportQueries - Queries to be sent with the request

Return Type

error? - Export file downloaded

get help_center/collections

Isolated FunctionResource Function

function get help_center/collections(ListAllCollectionsHeaders headers) returns CollectionList|error

List all collections

Parameters

headers ListAllCollectionsHeaders (default {}) - Headers to be sent with the request

Return Type

CollectionList|error - Successful

post help_center/collections

Isolated FunctionResource Function

function post help_center/collections(CreateCollectionRequest payload, CreateCollectionHeaders headers) returns Collection|error

Create a collection

Parameters

payload CreateCollectionRequest -

headers CreateCollectionHeaders (default {}) - Headers to be sent with the request

Return Type

Collection|error - collection created

get help_center/collections/[int collectionId]

Isolated FunctionResource Function

function get help_center/collections/[int collectionId](RetrieveCollectionHeaders headers) returns Collection|error

Retrieve a collection

Parameters

headers RetrieveCollectionHeaders (default {}) - Headers to be sent with the request

Return Type

Collection|error - Collection found

put help_center/collections/[int collectionId]

Isolated FunctionResource Function

function put help_center/collections/[int collectionId](UpdateCollectionRequest payload, UpdateCollectionHeaders headers) returns Collection|error

Update a collection

Parameters

payload UpdateCollectionRequest -

headers UpdateCollectionHeaders (default {}) - Headers to be sent with the request

Return Type

Collection|error - successful

delete help_center/collections/[int collectionId]

Isolated FunctionResource Function

function delete help_center/collections/[int collectionId](DeleteCollectionHeaders headers) returns DeletedCollectionObject|error

Delete a collection

Parameters

headers DeleteCollectionHeaders (default {}) - Headers to be sent with the request

Return Type

DeletedCollectionObject|error - successful

get help_center/help_centers/[int helpCenterId]

Isolated FunctionResource Function

function get help_center/help_centers/[int helpCenterId](RetrieveHelpCenterHeaders headers) returns HelpCenter|error

Retrieve a Help Center

Parameters

headers RetrieveHelpCenterHeaders (default {}) - Headers to be sent with the request

Return Type

HelpCenter|error - Collection found

get help_center/help_centers

Isolated FunctionResource Function

function get help_center/help_centers(ListHelpCentersHeaders headers) returns HelpCenterList|error

List all Help Centers

Parameters

headers ListHelpCentersHeaders (default {}) - Headers to be sent with the request

Return Type

HelpCenterList|error - Help Centers found

get internal_articles

Isolated FunctionResource Function

function get internal_articles(ListInternalArticlesHeaders headers) returns InternalArticleList|error

List all articles

Parameters

headers ListInternalArticlesHeaders (default {}) - Headers to be sent with the request

Return Type

InternalArticleList|error - successful

post internal_articles

Isolated FunctionResource Function

function post internal_articles(CreateInternalArticleRequest payload, CreateInternalArticleHeaders headers) returns InternalArticle|error

Create an internal article

Parameters

payload CreateInternalArticleRequest -

headers CreateInternalArticleHeaders (default {}) - Headers to be sent with the request

Return Type

InternalArticle|error - internal article created

get internal_articles/[int internalArticleId]

Isolated FunctionResource Function

function get internal_articles/[int internalArticleId](RetrieveInternalArticleHeaders headers) returns InternalArticle|error

Retrieve an internal article

Parameters

headers RetrieveInternalArticleHeaders (default {}) - Headers to be sent with the request

Return Type

InternalArticle|error - Internal article found

put internal_articles/[int internalArticleId]

Isolated FunctionResource Function

function put internal_articles/[int internalArticleId](UpdateInternalArticleRequest payload, UpdateInternalArticleHeaders headers) returns InternalArticle|error

Update an internal article

Parameters

payload UpdateInternalArticleRequest -

headers UpdateInternalArticleHeaders (default {}) - Headers to be sent with the request

Return Type

InternalArticle|error - successful

delete internal_articles/[int internalArticleId]

Isolated FunctionResource Function

function delete internal_articles/[int internalArticleId](DeleteInternalArticleHeaders headers) returns DeletedInternalArticleObject|error

Delete an internal article

Parameters

headers DeleteInternalArticleHeaders (default {}) - Headers to be sent with the request

Return Type

DeletedInternalArticleObject|error - successful

get internal_articles/search

Isolated FunctionResource Function

function get internal_articles/search(SearchInternalArticlesHeaders headers, *SearchInternalArticlesQueries queries) returns InternalArticleSearchResponse|error

Search for internal articles

Parameters

headers SearchInternalArticlesHeaders (default {}) - Headers to be sent with the request

queries *SearchInternalArticlesQueries - Queries to be sent with the request

Return Type

InternalArticleSearchResponse|error - Search successful

get ip_allowlist

Isolated FunctionResource Function

function get ip_allowlist(GetIpAllowlistHeaders headers) returns IpAllowlist|error

Get IP allowlist settings

Parameters

headers GetIpAllowlistHeaders (default {}) - Headers to be sent with the request

Return Type

IpAllowlist|error - Successful response

put ip_allowlist

Isolated FunctionResource Function

function put ip_allowlist(IpAllowlist payload, UpdateIpAllowlistHeaders headers) returns IpAllowlist|error

Update IP allowlist settings

Parameters

payload IpAllowlist -

headers UpdateIpAllowlistHeaders (default {}) - Headers to be sent with the request

Return Type

IpAllowlist|error - Successful response

get companies

Isolated FunctionResource Function

function get companies(RetrieveCompanyHeaders headers, *RetrieveCompanyQueries queries) returns CompanyList|error

Retrieve companies

Parameters

headers RetrieveCompanyHeaders (default {}) - Headers to be sent with the request

queries *RetrieveCompanyQueries - Queries to be sent with the request

Return Type

CompanyList|error - Successful

post companies

Isolated FunctionResource Function

function post companies(CreateOrUpdateCompanyRequest payload, CreateOrUpdateCompanyHeaders headers) returns Company|error

Create or Update a company

Parameters

payload CreateOrUpdateCompanyRequest -

headers CreateOrUpdateCompanyHeaders (default {}) - Headers to be sent with the request

Return Type

Company|error - Successful

get companies/[string companyId]

Isolated FunctionResource Function

function get companies/[string companyId](RetrieveACompanyByIdHeaders headers) returns Company|error

Retrieve a company by ID

Parameters

headers RetrieveACompanyByIdHeaders (default {}) - Headers to be sent with the request

Return Type

Company|error - Successful

put companies/[string companyId]

Isolated FunctionResource Function

function put companies/[string companyId](UpdateCompanyRequest payload, UpdateCompanyHeaders headers) returns Company|error

Update a company

Parameters

payload UpdateCompanyRequest -

headers UpdateCompanyHeaders (default {}) - Headers to be sent with the request

Return Type

Company|error - Successful

delete companies/[string companyId]

Isolated FunctionResource Function

function delete companies/[string companyId](DeleteCompanyHeaders headers) returns DeletedCompanyObject|error

Delete a company

Parameters

headers DeleteCompanyHeaders (default {}) - Headers to be sent with the request

Return Type

DeletedCompanyObject|error - Successful

get companies/[string companyId]/contacts

Isolated FunctionResource Function

function get companies/[string companyId]/contacts(ListAttachedContactsHeaders headers) returns CompanyAttachedContacts|error

List attached contacts

Parameters

headers ListAttachedContactsHeaders (default {}) - Headers to be sent with the request

Return Type

CompanyAttachedContacts|error - Successful

get companies/[string companyId]/segments

Isolated FunctionResource Function

function get companies/[string companyId]/segments(ListAttachedSegmentsForCompaniesHeaders headers) returns CompanyAttachedSegments|error

List attached segments for companies

Parameters

headers ListAttachedSegmentsForCompaniesHeaders (default {}) - Headers to be sent with the request

Return Type

CompanyAttachedSegments|error - Successful

get companies/[string companyId]/notes

Isolated FunctionResource Function

function get companies/[string companyId]/notes(ListCompanyNotesHeaders headers) returns NoteList|error

List all company notes

Parameters

headers ListCompanyNotesHeaders (default {}) - Headers to be sent with the request

Return Type

NoteList|error - Successful response

post companies/list

Isolated FunctionResource Function

function post companies/list(ListAllCompaniesHeaders headers, *ListAllCompaniesQueries queries) returns CompanyList|error

List all companies

Parameters

headers ListAllCompaniesHeaders (default {}) - Headers to be sent with the request

queries *ListAllCompaniesQueries - Queries to be sent with the request

Return Type

CompanyList|error - Successful

get companies/scroll

Isolated FunctionResource Function

function get companies/scroll(ScrollOverAllCompaniesHeaders headers, *ScrollOverAllCompaniesQueries queries) returns CompanyScroll|error

Scroll over all companies

Parameters

headers ScrollOverAllCompaniesHeaders (default {}) - Headers to be sent with the request

queries *ScrollOverAllCompaniesQueries - Queries to be sent with the request

Return Type

CompanyScroll|error - Successful

get contacts/[string contactId]/companies

Isolated FunctionResource Function

function get contacts/[string contactId]/companies(ListCompaniesForAContactHeaders headers) returns ContactAttachedCompanies|error

List attached companies for contact

Parameters

headers ListCompaniesForAContactHeaders (default {}) - Headers to be sent with the request

Return Type

ContactAttachedCompanies|error - successful

post contacts/[string contactId]/companies

Isolated FunctionResource Function

function post contacts/[string contactId]/companies(ContactIdCompaniesBody payload, AttachContactToACompanyHeaders headers) returns Company|error

Attach a Contact to a Company

Parameters

payload ContactIdCompaniesBody -

headers AttachContactToACompanyHeaders (default {}) - Headers to be sent with the request

Return Type

Company|error - Successful

delete contacts/[string contactId]/companies/[string companyId]

Isolated FunctionResource Function

function delete contacts/[string contactId]/companies/[string companyId](DetachContactFromACompanyHeaders headers) returns Company|error

Detach a contact from a company

Parameters

headers DetachContactFromACompanyHeaders (default {}) - Headers to be sent with the request

Return Type

Company|error - Successful

get contacts/[string contactId]/notes

Isolated FunctionResource Function

function get contacts/[string contactId]/notes(ListNotesHeaders headers) returns NoteList|error

List all notes

Parameters

headers ListNotesHeaders (default {}) - Headers to be sent with the request

Return Type

NoteList|error - Successful response

post contacts/[int contactId]/notes

Isolated FunctionResource Function

function post contacts/[int contactId]/notes(ContactIdNotesBody payload, CreateNoteHeaders headers) returns Note|error

Create a note

Parameters

payload ContactIdNotesBody -

headers CreateNoteHeaders (default {}) - Headers to be sent with the request

Return Type

Note|error - Successful response

get contacts/[string contactId]/segments

Isolated FunctionResource Function

function get contacts/[string contactId]/segments(ListSegmentsForAContactHeaders headers) returns ContactSegments|error

List attached segments for contact

Parameters

headers ListSegmentsForAContactHeaders (default {}) - Headers to be sent with the request

Return Type

ContactSegments|error - successful

get contacts/[string contactId]/subscriptions

Isolated FunctionResource Function

function get contacts/[string contactId]/subscriptions(ListSubscriptionsForAContactHeaders headers) returns SubscriptionTypeList|error

List subscriptions for a contact

Parameters

headers ListSubscriptionsForAContactHeaders (default {}) - Headers to be sent with the request

Return Type

SubscriptionTypeList|error - Successful

post contacts/[string contactId]/subscriptions

Isolated FunctionResource Function

function post contacts/[string contactId]/subscriptions(ContactIdSubscriptionsBody payload, AttachSubscriptionTypeToContactHeaders headers) returns SubscriptionType|error

Add subscription to a contact

Parameters

payload ContactIdSubscriptionsBody -

headers AttachSubscriptionTypeToContactHeaders (default {}) - Headers to be sent with the request

Return Type

SubscriptionType|error - Successful

delete contacts/[string contactId]/subscriptions/[string subscriptionId]

Isolated FunctionResource Function

function delete contacts/[string contactId]/subscriptions/[string subscriptionId](DetachSubscriptionTypeToContactHeaders headers) returns SubscriptionType|error

Remove subscription from a contact

Parameters

headers DetachSubscriptionTypeToContactHeaders (default {}) - Headers to be sent with the request

Return Type

SubscriptionType|error - Successful

get contacts/[string contactId]/tags

Isolated FunctionResource Function

function get contacts/[string contactId]/tags(ListTagsForAContactHeaders headers) returns TagList|error

List tags attached to a contact

Parameters

headers ListTagsForAContactHeaders (default {}) - Headers to be sent with the request

Return Type

TagList|error - successful

post contacts/[string contactId]/tags

Isolated FunctionResource Function

function post contacts/[string contactId]/tags(ContactIdTagsBody payload, AttachTagToContactHeaders headers) returns Tag|error

Add tag to a contact

Parameters

payload ContactIdTagsBody -

headers AttachTagToContactHeaders (default {}) - Headers to be sent with the request

Return Type

Tag|error - successful

delete contacts/[string contactId]/tags/[string tagId]

Isolated FunctionResource Function

function delete contacts/[string contactId]/tags/[string tagId](DetachTagFromContactHeaders headers) returns Tag|error

Remove tag from a contact

Parameters

headers DetachTagFromContactHeaders (default {}) - Headers to be sent with the request

Return Type

Tag|error - successful

get contacts/[string contactId]

Isolated FunctionResource Function

function get contacts/[string contactId](ShowContactHeaders headers) returns ContactWithPush|error

Get a contact

Parameters

headers ShowContactHeaders (default {}) - Headers to be sent with the request

Return Type

ContactWithPush|error - successful

put contacts/[string contactId]

Isolated FunctionResource Function

function put contacts/[string contactId](ContactscontactIdBody payload, UpdateContactHeaders headers) returns ContactWithPush|error

Update a contact

Parameters

payload ContactscontactIdBody -

headers UpdateContactHeaders (default {}) - Headers to be sent with the request

Return Type

ContactWithPush|error - successful

delete contacts/[string contactId]

Isolated FunctionResource Function

function delete contacts/[string contactId](DeleteContactHeaders headers) returns ContactDeleted|error

Delete a contact

Parameters

headers DeleteContactHeaders (default {}) - Headers to be sent with the request

Return Type

ContactDeleted|error - successful

post contacts/merge

Isolated FunctionResource Function

function post contacts/merge(MergeContactsRequest payload, MergeContactHeaders headers) returns ContactWithPush|error

Merge a lead and a user

Parameters

payload MergeContactsRequest -

headers MergeContactHeaders (default {}) - Headers to be sent with the request

Return Type

ContactWithPush|error - successful

post contacts/search

Isolated FunctionResource Function

function post contacts/search(SearchRequest payload, SearchContactsHeaders headers) returns ContactList|error

Search contacts

Parameters

payload SearchRequest -

headers SearchContactsHeaders (default {}) - Headers to be sent with the request

Return Type

ContactList|error - successful

get contacts

Isolated FunctionResource Function

function get contacts(ListContactsHeaders headers) returns ContactList|error

List all contacts

Parameters

headers ListContactsHeaders (default {}) - Headers to be sent with the request

Return Type

ContactList|error - successful

post contacts

Isolated FunctionResource Function

function post contacts(ContactsBody payload, CreateContactHeaders headers) returns ContactWithPush|error

Create contact

Parameters

payload ContactsBody -

headers CreateContactHeaders (default {}) - Headers to be sent with the request

Return Type

ContactWithPush|error - successful

get contacts/find_by_external_id/[string externalId]

Isolated FunctionResource Function

function get contacts/find_by_external_id/[string externalId](ShowContactByExternalIdHeaders headers) returns ContactWithPush|error

Get a contact by External ID

Parameters

headers ShowContactByExternalIdHeaders (default {}) - Headers to be sent with the request

Return Type

ContactWithPush|error - successful

post contacts/[string contactId]/archive

Isolated FunctionResource Function

function post contacts/[string contactId]/archive(ArchiveContactHeaders headers) returns ContactArchived|error

Archive contact

Parameters

headers ArchiveContactHeaders (default {}) - Headers to be sent with the request

Return Type

ContactArchived|error - successful

post contacts/[string contactId]/unarchive

Isolated FunctionResource Function

function post contacts/[string contactId]/unarchive(UnarchiveContactHeaders headers) returns ContactUnarchived|error

Unarchive contact

Parameters

headers UnarchiveContactHeaders (default {}) - Headers to be sent with the request

Return Type

ContactUnarchived|error - successful

post contacts/[string contactId]/block

Isolated FunctionResource Function

function post contacts/[string contactId]/block(BlockContactHeaders headers) returns ContactBlocked|error

Block contact

Parameters

headers BlockContactHeaders (default {}) - Headers to be sent with the request

Return Type

ContactBlocked|error - successful

post conversations/[string conversationId]/tags

Isolated FunctionResource Function

function post conversations/[string conversationId]/tags(ConversationIdTagsBody payload, AttachTagToConversationHeaders headers) returns Tag|error

Add tag to a conversation

Parameters

payload ConversationIdTagsBody -

headers AttachTagToConversationHeaders (default {}) - Headers to be sent with the request

Return Type

Tag|error - successful

delete conversations/[string conversationId]/tags/[string tagId]

Isolated FunctionResource Function

function delete conversations/[string conversationId]/tags/[string tagId](TagstagIdBody payload, DetachTagFromConversationHeaders headers) returns Tag|error

Remove tag from a conversation

Parameters

payload TagstagIdBody -

headers DetachTagFromConversationHeaders (default {}) - Headers to be sent with the request

Return Type

Tag|error - successful

get conversations

Isolated FunctionResource Function

function get conversations(ListConversationsHeaders headers, *ListConversationsQueries queries) returns ConversationList|error

List all conversations

Parameters

headers ListConversationsHeaders (default {}) - Headers to be sent with the request

queries *ListConversationsQueries - Queries to be sent with the request

Return Type

ConversationList|error - successful

post conversations

Isolated FunctionResource Function

function post conversations(CreateConversationRequest payload, CreateConversationHeaders headers) returns ConversationMessage|error

Creates a conversation

Parameters

payload CreateConversationRequest -

headers CreateConversationHeaders (default {}) - Headers to be sent with the request

Return Type

ConversationMessage|error - conversation created

get conversations/[int conversationId]

Isolated FunctionResource Function

function get conversations/[int conversationId](RetrieveConversationHeaders headers, *RetrieveConversationQueries queries) returns Conversation|error

Retrieve a conversation

Parameters

headers RetrieveConversationHeaders (default {}) - Headers to be sent with the request

queries *RetrieveConversationQueries - Queries to be sent with the request

Return Type

Conversation|error - conversation found

put conversations/[int conversationId]

Isolated FunctionResource Function

function put conversations/[int conversationId](UpdateConversationRequest payload, UpdateConversationHeaders headers, *UpdateConversationQueries queries) returns Conversation|error

Update a conversation

Parameters

payload UpdateConversationRequest -

headers UpdateConversationHeaders (default {}) - Headers to be sent with the request

queries *UpdateConversationQueries - Queries to be sent with the request

Return Type

Conversation|error - update a conversation with an association to a custom object instance

delete conversations/[int conversationId]

Isolated FunctionResource Function

function delete conversations/[int conversationId](DeleteConversationHeaders headers) returns ConversationDeleted|error

Delete a conversation

Parameters

headers DeleteConversationHeaders (default {}) - Headers to be sent with the request

Return Type

ConversationDeleted|error - successful

post conversations/search

Isolated FunctionResource Function

function post conversations/search(SearchRequest payload, SearchConversationsHeaders headers) returns ConversationList|error

Search conversations

Parameters

payload SearchRequest -

headers SearchConversationsHeaders (default {}) - Headers to be sent with the request

Return Type

ConversationList|error - successful

post conversations/[string conversationId]/reply

Isolated FunctionResource Function

function post conversations/[string conversationId]/reply(ReplyConversationRequest payload, ReplyConversationHeaders headers) returns Conversation|error

Reply to a conversation

Parameters

payload ReplyConversationRequest -

headers ReplyConversationHeaders (default {}) - Headers to be sent with the request

Return Type

Conversation|error - User last conversation reply

post conversations/[string conversationId]/parts

Isolated FunctionResource Function

function post conversations/[string conversationId]/parts(ConversationIdPartsBody payload, ManageConversationHeaders headers) returns Conversation|error

Manage a conversation

Parameters

payload ConversationIdPartsBody -

headers ManageConversationHeaders (default {}) - Headers to be sent with the request

Return Type

Conversation|error - Assign a conversation

post conversations/[string conversationId]/customers

Isolated FunctionResource Function

function post conversations/[string conversationId]/customers(AttachContactToConversationRequest payload, AttachContactToConversationHeaders headers) returns Conversation|error

Attach a contact to a conversation

Parameters

payload AttachContactToConversationRequest -

headers AttachContactToConversationHeaders (default {}) - Headers to be sent with the request

Return Type

Conversation|error - Attach a contact to a conversation

delete conversations/[string conversationId]/customers/[string contactId]

Isolated FunctionResource Function

function delete conversations/[string conversationId]/customers/[string contactId](DetachContactFromConversationRequest payload, DetachContactFromConversationHeaders headers) returns Conversation|error

Detach a contact from a group conversation

Parameters

payload DetachContactFromConversationRequest -

headers DetachContactFromConversationHeaders (default {}) - Headers to be sent with the request

Return Type

Conversation|error - Detach a contact from a group conversation

post conversations/redact

Isolated FunctionResource Function

function post conversations/redact(RedactConversationRequest payload, RedactConversationHeaders headers) returns Conversation|error

Redact a conversation part

Parameters

payload RedactConversationRequest -

headers RedactConversationHeaders (default {}) - Headers to be sent with the request

Return Type

Conversation|error - Redact a conversation part

post conversations/[int conversationId]/convert

Isolated FunctionResource Function

function post conversations/[int conversationId]/convert(ConvertConversationToTicketRequest payload, ConvertConversationToTicketHeaders headers) returns Ticket|error

Convert a conversation to a ticket

Parameters

payload ConvertConversationToTicketRequest -

headers ConvertConversationToTicketHeaders (default {}) - Headers to be sent with the request

Return Type

Ticket|error - successful

post custom_channel_events/notify_new_conversation

Isolated FunctionResource Function

function post custom_channel_events/notify_new_conversation(CustomChannelBaseEvent payload, NotifyNewConversationHeaders headers) returns CustomChannelNotificationResponse|error

Notify Intercom of a new conversation created in a custom channel

Parameters

payload CustomChannelBaseEvent -

headers NotifyNewConversationHeaders (default {}) - Headers to be sent with the request

Return Type

CustomChannelNotificationResponse|error - Successfully notified Intercom

post custom_channel_events/notify_new_message

Isolated FunctionResource Function

function post custom_channel_events/notify_new_message(CustomChannelEventsNotifyNewMessageBody payload, NotifyNewMessageHeaders headers) returns CustomChannelNotificationResponse|error

Notify Intercom of a new message in a custom channel conversation

Parameters

payload CustomChannelEventsNotifyNewMessageBody -

headers NotifyNewMessageHeaders (default {}) - Headers to be sent with the request

Return Type

CustomChannelNotificationResponse|error - Successfully notified Intercom

post custom_channel_events/notify_quick_reply_selected

Isolated FunctionResource Function

function post custom_channel_events/notify_quick_reply_selected(CustomChannelEventsNotifyQuickReplySelectedBody payload, NotifyQuickReplySelectedHeaders headers) returns CustomChannelNotificationResponse|error

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

Parameters

payload CustomChannelEventsNotifyQuickReplySelectedBody -

headers NotifyQuickReplySelectedHeaders (default {}) - Headers to be sent with the request

Return Type

CustomChannelNotificationResponse|error - Successfully notified Intercom

post custom_channel_events/notify_attribute_collected

Isolated FunctionResource Function

function post custom_channel_events/notify_attribute_collected(CustomChannelEventsNotifyAttributeCollectedBody payload, NotifyAttributeCollectedHeaders headers) returns CustomChannelNotificationResponse|error

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

Parameters

payload CustomChannelEventsNotifyAttributeCollectedBody -

headers NotifyAttributeCollectedHeaders (default {}) - Headers to be sent with the request

Return Type

CustomChannelNotificationResponse|error - Successfully notified Intercom

get custom_object_instances/[string customObjectTypeIdentifier]

Isolated FunctionResource Function

function get custom_object_instances/[string customObjectTypeIdentifier](GetCustomObjectInstancesByExternalIdHeaders headers, *GetCustomObjectInstancesByExternalIdQueries queries) returns CustomObjectInstance|error

Get Custom Object Instance by External ID

Parameters

headers GetCustomObjectInstancesByExternalIdHeaders (default {}) - Headers to be sent with the request

queries *GetCustomObjectInstancesByExternalIdQueries - Queries to be sent with the request

Return Type

CustomObjectInstance|error - successful

post custom_object_instances/[string customObjectTypeIdentifier]

Isolated FunctionResource Function

function post custom_object_instances/[string customObjectTypeIdentifier](CreateOrUpdateCustomObjectInstanceRequest payload, CreateCustomObjectInstancesHeaders headers) returns CustomObjectInstance|error

Create or Update a Custom Object Instance

Parameters

payload CreateOrUpdateCustomObjectInstanceRequest -

headers CreateCustomObjectInstancesHeaders (default {}) - Headers to be sent with the request

Return Type

CustomObjectInstance|error - successful

delete custom_object_instances/[string customObjectTypeIdentifier]

Isolated FunctionResource Function

function delete custom_object_instances/[string customObjectTypeIdentifier](DeleteCustomObjectInstancesByIdHeaders headers, *DeleteCustomObjectInstancesByIdQueries queries) returns CustomObjectInstanceDeleted|error

Delete a Custom Object Instance by External ID

Parameters

headers DeleteCustomObjectInstancesByIdHeaders (default {}) - Headers to be sent with the request

queries *DeleteCustomObjectInstancesByIdQueries - Queries to be sent with the request

Return Type

CustomObjectInstanceDeleted|error - successful

get custom_object_instances/[string customObjectTypeIdentifier]/[string customObjectInstanceId]

Isolated FunctionResource Function

function get custom_object_instances/[string customObjectTypeIdentifier]/[string customObjectInstanceId](GetCustomObjectInstancesByIdHeaders headers) returns CustomObjectInstance|error

Get Custom Object Instance by ID

Parameters

headers GetCustomObjectInstancesByIdHeaders (default {}) - Headers to be sent with the request

Return Type

CustomObjectInstance|error - successful

delete custom_object_instances/[string customObjectTypeIdentifier]/[string customObjectInstanceId]

Isolated FunctionResource Function

function delete custom_object_instances/[string customObjectTypeIdentifier]/[string customObjectInstanceId](DeleteCustomObjectInstancesByExternalIdHeaders headers) returns CustomObjectInstanceDeleted|error

Delete a Custom Object Instance by ID

Parameters

headers DeleteCustomObjectInstancesByExternalIdHeaders (default {}) - Headers to be sent with the request

Return Type

CustomObjectInstanceDeleted|error - successful

get data_attributes

Isolated FunctionResource Function

function get data_attributes(LisDataAttributesHeaders headers, *LisDataAttributesQueries queries) returns DataAttributeList|error

List all data attributes

Parameters

headers LisDataAttributesHeaders (default {}) - Headers to be sent with the request

queries *LisDataAttributesQueries - Queries to be sent with the request

Return Type

DataAttributeList|error - Successful response

post data_attributes

Isolated FunctionResource Function

function post data_attributes(CreateDataAttributeRequest payload, CreateDataAttributeHeaders headers) returns DataAttribute|error

Create a data attribute

Parameters

payload CreateDataAttributeRequest -

headers CreateDataAttributeHeaders (default {}) - Headers to be sent with the request

Return Type

DataAttribute|error - Successful

put data_attributes/[int dataAttributeId]

Isolated FunctionResource Function

function put data_attributes/[int dataAttributeId](UpdateDataAttributeRequest payload, UpdateDataAttributeHeaders headers) returns DataAttribute|error

Update a data attribute

Parameters

payload UpdateDataAttributeRequest -

headers UpdateDataAttributeHeaders (default {}) - Headers to be sent with the request

Return Type

DataAttribute|error - Successful

get events

Isolated FunctionResource Function

function get events(LisDataEventsHeaders headers, *LisDataEventsQueries queries) returns DataEventSummary|error

List all data events

Parameters

headers LisDataEventsHeaders (default {}) - Headers to be sent with the request

queries *LisDataEventsQueries - Queries to be sent with the request

Return Type

DataEventSummary|error - Successful response

post events

Isolated FunctionResource Function

function post events(CreateDataEventRequest payload, CreateDataEventHeaders headers) returns error?

Submit a data event

Parameters

payload CreateDataEventRequest -

headers CreateDataEventHeaders (default {}) - Headers to be sent with the request

Return Type

error? - successful

post events/summaries

Isolated FunctionResource Function

function post events/summaries(CreateDataEventSummariesRequest payload, DataEventSummariesHeaders headers) returns error?

Create event summaries

Parameters

payload CreateDataEventSummariesRequest -

headers DataEventSummariesHeaders (default {}) - Headers to be sent with the request

Return Type

error? - successful

post export/content/data

Isolated FunctionResource Function

function post export/content/data(CreateDataExportsRequest payload, CreateDataExportHeaders headers) returns DataExport|error

Create content data export

Parameters

payload CreateDataExportsRequest -

headers CreateDataExportHeaders (default {}) - Headers to be sent with the request

Return Type

DataExport|error - successful

get export/content/data/[string jobIdentifier]

Isolated FunctionResource Function

function get export/content/data/[string jobIdentifier](GetDataExportHeaders headers) returns DataExport|error

Show content data export

Parameters

headers GetDataExportHeaders (default {}) - Headers to be sent with the request

Return Type

DataExport|error - successful

post export/cancel/[string jobIdentifier]

Isolated FunctionResource Function

function post export/cancel/[string jobIdentifier](CancelDataExportHeaders headers) returns DataExport|error

Cancel content data export

Parameters

headers CancelDataExportHeaders (default {}) - Headers to be sent with the request

Return Type

DataExport|error - successful

get download/content/data/[string jobIdentifier]

Isolated FunctionResource Function

function get download/content/data/[string jobIdentifier](DownloadDataExportHeaders headers) returns error?

Download content data export

Parameters

headers DownloadDataExportHeaders (default {}) - Headers to be sent with the request

Return Type

error? - successful

get jobs/status/[string jobId]

Isolated FunctionResource Function

function get jobs/status/[string jobId](JobsStatusHeaders headers) returns Jobs|error

Retrieve job status

Parameters

headers JobsStatusHeaders (default {}) - Headers to be sent with the request

Return Type

Jobs|error - Job execution status

post messages

Isolated FunctionResource Function

function post messages(CreateMessageRequest payload, CreateMessageHeaders headers) returns Message|error

Create a message

Parameters

payload CreateMessageRequest -

headers CreateMessageHeaders (default {}) - Headers to be sent with the request

Return Type

Message|error - admin message created

get news/news_items

Isolated FunctionResource Function

function get news/news_items(ListNewsItemsHeaders headers) returns PaginatedResponse|error

List all news items

Parameters

headers ListNewsItemsHeaders (default {}) - Headers to be sent with the request

Return Type

PaginatedResponse|error - successful

post news/news_items

Isolated FunctionResource Function

function post news/news_items(NewsItemRequest payload, CreateNewsItemHeaders headers) returns NewsItem|error

Create a news item

Parameters

payload NewsItemRequest -

headers CreateNewsItemHeaders (default {}) - Headers to be sent with the request

Return Type

NewsItem|error - successful

get news/news_items/[int newsItemId]

Isolated FunctionResource Function

function get news/news_items/[int newsItemId](RetrieveNewsItemHeaders headers) returns NewsItem|error

Retrieve a news item

Parameters

headers RetrieveNewsItemHeaders (default {}) - Headers to be sent with the request

Return Type

NewsItem|error - successful

put news/news_items/[int newsItemId]

Isolated FunctionResource Function

function put news/news_items/[int newsItemId](NewsItemRequest payload, UpdateNewsItemHeaders headers) returns NewsItem|error

Update a news item

Parameters

payload NewsItemRequest -

headers UpdateNewsItemHeaders (default {}) - Headers to be sent with the request

Return Type

NewsItem|error - successful

delete news/news_items/[int newsItemId]

Isolated FunctionResource Function

function delete news/news_items/[int newsItemId](DeleteNewsItemHeaders headers) returns DeletedObject|error

Delete a news item

Parameters

headers DeleteNewsItemHeaders (default {}) - Headers to be sent with the request

Return Type

DeletedObject|error - successful

get news/newsfeeds/[string newsfeedId]/items

Isolated FunctionResource Function

function get news/newsfeeds/[string newsfeedId]/items(ListLiveNewsfeedItemsHeaders headers) returns PaginatedResponse|error

List all live newsfeed items

Parameters

headers ListLiveNewsfeedItemsHeaders (default {}) - Headers to be sent with the request

Return Type

PaginatedResponse|error - successful

get news/newsfeeds

Isolated FunctionResource Function

function get news/newsfeeds(ListNewsfeedsHeaders headers) returns PaginatedResponse|error

List all newsfeeds

Parameters

headers ListNewsfeedsHeaders (default {}) - Headers to be sent with the request

Return Type

PaginatedResponse|error - successful

get news/newsfeeds/[string newsfeedId]

Isolated FunctionResource Function

function get news/newsfeeds/[string newsfeedId](RetrieveNewsfeedHeaders headers) returns Newsfeed|error

Retrieve a newsfeed

Parameters

headers RetrieveNewsfeedHeaders (default {}) - Headers to be sent with the request

Return Type

Newsfeed|error - successful

get notes/[int noteId]

Isolated FunctionResource Function

function get notes/[int noteId](RetrieveNoteHeaders headers) returns Note|error

Retrieve a note

Parameters

headers RetrieveNoteHeaders (default {}) - Headers to be sent with the request

Return Type

Note|error - Note found

get segments

Isolated FunctionResource Function

function get segments(ListSegmentsHeaders headers, *ListSegmentsQueries queries) returns SegmentList|error

List all segments

Parameters

headers ListSegmentsHeaders (default {}) - Headers to be sent with the request

queries *ListSegmentsQueries - Queries to be sent with the request

Return Type

SegmentList|error - Successful response

get segments/[string segmentId]

Isolated FunctionResource Function

function get segments/[string segmentId](RetrieveSegmentHeaders headers) returns Segment|error

Retrieve a segment

Parameters

headers RetrieveSegmentHeaders (default {}) - Headers to be sent with the request

Return Type

Segment|error - Successful response

get subscription_types

Isolated FunctionResource Function

function get subscription_types(ListSubscriptionTypesHeaders headers) returns SubscriptionTypeList|error

List subscription types

Parameters

headers ListSubscriptionTypesHeaders (default {}) - Headers to be sent with the request

Return Type

SubscriptionTypeList|error - Successful

post phone_call_redirects

Isolated FunctionResource Function

function post phone_call_redirects(CreatePhoneSwitchRequest payload, CreatePhoneSwitchHeaders headers) returns PhoneSwitch|error

Create a phone Switch

Parameters

payload CreatePhoneSwitchRequest -

headers CreatePhoneSwitchHeaders (default {}) - Headers to be sent with the request

Return Type

PhoneSwitch|error - successful

get calls

Isolated FunctionResource Function

function get calls(ListCallsHeaders headers, *ListCallsQueries queries) returns CallList|error

List all calls

Parameters

headers ListCallsHeaders (default {}) - Headers to be sent with the request

queries *ListCallsQueries - Queries to be sent with the request

Return Type

CallList|error - successful

get calls/[string callId]

Isolated FunctionResource Function

function get calls/[string callId](ShowCallHeaders headers) returns Call|error

Get a call

Parameters

headers ShowCallHeaders (default {}) - Headers to be sent with the request

Return Type

Call|error - successful

get calls/[string callId]/recording

Isolated FunctionResource Function

function get calls/[string callId]/recording(ShowCallRecordingHeaders headers) returns error?

Get call recording by call id

Parameters

headers ShowCallRecordingHeaders (default {}) - Headers to be sent with the request

Return Type

error? - Redirect to signed recording URL

get calls/[string callId]/transcript

Isolated FunctionResource Function

function get calls/[string callId]/transcript(ShowCallTranscriptHeaders headers) returns string|error

Get call transcript by call id

Parameters

headers ShowCallTranscriptHeaders (default {}) - Headers to be sent with the request

Return Type

string|error - successful

post calls/search

Isolated FunctionResource Function

function post calls/search(CallsSearchBody payload, ListCallsWithTranscriptsHeaders headers) returns CallTranscriptList|error

List calls with transcripts

Parameters

payload CallsSearchBody -

headers ListCallsWithTranscriptsHeaders (default {}) - Headers to be sent with the request

Return Type

CallTranscriptList|error - successful

get tags

Isolated FunctionResource Function

function get tags(ListTagsHeaders headers) returns TagList|error

List all tags

Parameters

headers ListTagsHeaders (default {}) - Headers to be sent with the request

Return Type

TagList|error - successful

post tags

Isolated FunctionResource Function

function post tags(TagsBody payload, CreateTagHeaders headers) returns TagBasic|error

Create or update a tag, Tag or untag companies, Tag contacts

Parameters

payload TagsBody -

headers CreateTagHeaders (default {}) - Headers to be sent with the request

Return Type

TagBasic|error - Action successful

get tags/[string tagId]

Isolated FunctionResource Function

function get tags/[string tagId](FindTagHeaders headers) returns TagBasic|error

Find a specific tag

Parameters

headers FindTagHeaders (default {}) - Headers to be sent with the request

Return Type

TagBasic|error - Tag found

delete tags/[string tagId]

Isolated FunctionResource Function

function delete tags/[string tagId](DeleteTagHeaders headers) returns error?

Delete tag

Parameters

headers DeleteTagHeaders (default {}) - Headers to be sent with the request

Return Type

error? - Successful

get teams

Isolated FunctionResource Function

function get teams(ListTeamsHeaders headers) returns TeamList|error

List all teams

Parameters

headers ListTeamsHeaders (default {}) - Headers to be sent with the request

Return Type

TeamList|error - successful

get teams/[string teamId]

Isolated FunctionResource Function

function get teams/[string teamId](RetrieveTeamHeaders headers) returns Team|error

Retrieve a team

Parameters

headers RetrieveTeamHeaders (default {}) - Headers to be sent with the request

Return Type

Team|error - successful

get ticket_states

Isolated FunctionResource Function

function get ticket_states(ListTicketStatesHeaders headers) returns TicketStateList|error

List all ticket states

Parameters

headers ListTicketStatesHeaders (default {}) - Headers to be sent with the request

Return Type

TicketStateList|error - successful

post ticket_types/[string ticketTypeId]/attributes

Isolated FunctionResource Function

function post ticket_types/[string ticketTypeId]/attributes(CreateTicketTypeAttributeRequest payload, CreateTicketTypeAttributeHeaders headers) returns TicketTypeAttribute|error

Create a new attribute for a ticket type

Parameters

payload CreateTicketTypeAttributeRequest -

headers CreateTicketTypeAttributeHeaders (default {}) - Headers to be sent with the request

Return Type

TicketTypeAttribute|error - Ticket Type Attribute created

put ticket_types/[string ticketTypeId]/attributes/[string attributeId]

Isolated FunctionResource Function

function put ticket_types/[string ticketTypeId]/attributes/[string attributeId](UpdateTicketTypeAttributeRequest payload, UpdateTicketTypeAttributeHeaders headers) returns TicketTypeAttribute|error

Update an existing attribute for a ticket type

Parameters

payload UpdateTicketTypeAttributeRequest -

headers UpdateTicketTypeAttributeHeaders (default {}) - Headers to be sent with the request

Return Type

TicketTypeAttribute|error - Ticket Type Attribute updated

get ticket_types

Isolated FunctionResource Function

function get ticket_types(ListTicketTypesHeaders headers) returns TicketTypeList|error

List all ticket types

Parameters

headers ListTicketTypesHeaders (default {}) - Headers to be sent with the request

Return Type

TicketTypeList|error - successful

post ticket_types

Isolated FunctionResource Function

function post ticket_types(CreateTicketTypeRequest payload, CreateTicketTypeHeaders headers) returns TicketType|error

Create a ticket type

Parameters

payload CreateTicketTypeRequest -

headers CreateTicketTypeHeaders (default {}) - Headers to be sent with the request

Return Type

TicketType|error - Ticket type created

get ticket_types/[string ticketTypeId]

Isolated FunctionResource Function

function get ticket_types/[string ticketTypeId](GetTicketTypeHeaders headers) returns TicketType|error

Retrieve a ticket type

Parameters

headers GetTicketTypeHeaders (default {}) - Headers to be sent with the request

Return Type

TicketType|error - Ticket type found

put ticket_types/[string ticketTypeId]

Isolated FunctionResource Function

function put ticket_types/[string ticketTypeId](UpdateTicketTypeRequest payload, UpdateTicketTypeHeaders headers) returns TicketType|error

Update a ticket type

Parameters

payload UpdateTicketTypeRequest -

headers UpdateTicketTypeHeaders (default {}) - Headers to be sent with the request

Return Type

TicketType|error - Ticket type updated

post tickets/[string ticketId]/reply

Isolated FunctionResource Function

function post tickets/[string ticketId]/reply(TicketIdReplyBody payload, ReplyTicketHeaders headers) returns TicketReply|error

Reply to a ticket

Parameters

payload TicketIdReplyBody -

headers ReplyTicketHeaders (default {}) - Headers to be sent with the request

Return Type

TicketReply|error - User reply

post tickets/[string ticketId]/tags

Isolated FunctionResource Function

function post tickets/[string ticketId]/tags(ConversationIdTagsBody payload, AttachTagToTicketHeaders headers) returns Tag|error

Add tag to a ticket

Parameters

payload ConversationIdTagsBody -

headers AttachTagToTicketHeaders (default {}) - Headers to be sent with the request

Return Type

Tag|error - successful

delete tickets/[string ticketId]/tags/[string tagId]

Isolated FunctionResource Function

function delete tickets/[string ticketId]/tags/[string tagId](TagstagIdBody payload, DetachTagFromTicketHeaders headers) returns Tag|error

Remove tag from a ticket

Parameters

payload TagstagIdBody -

headers DetachTagFromTicketHeaders (default {}) - Headers to be sent with the request

Return Type

Tag|error - successful

post tickets

Isolated FunctionResource Function

function post tickets(TicketsBody payload, CreateTicketHeaders headers) returns Ticket|error

Create a ticket

Parameters

payload TicketsBody -

headers CreateTicketHeaders (default {}) - Headers to be sent with the request

Return Type

Ticket|error - Successful response

post tickets/enqueue

Isolated FunctionResource Function

function post tickets/enqueue(TicketsBody payload, EnqueueCreateTicketHeaders headers) returns Jobs|error

Enqueue create ticket

Parameters

payload TicketsBody -

headers EnqueueCreateTicketHeaders (default {}) - Headers to be sent with the request

Return Type

Jobs|error - Successful response

get tickets/[string ticketId]

Isolated FunctionResource Function

function get tickets/[string ticketId](GetTicketHeaders headers) returns Ticket|error

Retrieve a ticket

Parameters

headers GetTicketHeaders (default {}) - Headers to be sent with the request

Return Type

Ticket|error - Ticket found

put tickets/[string ticketId]

Isolated FunctionResource Function

function put tickets/[string ticketId](TicketsticketIdBody payload, UpdateTicketHeaders headers) returns Ticket|error

Update a ticket

Parameters

payload TicketsticketIdBody -

headers UpdateTicketHeaders (default {}) - Headers to be sent with the request

Return Type

Ticket|error - Successful response

delete tickets/[string ticketId]

Isolated FunctionResource Function

function delete tickets/[string ticketId](DeleteTicketHeaders headers) returns TicketDeleted|error

Delete a ticket

Parameters

headers DeleteTicketHeaders (default {}) - Headers to be sent with the request

Return Type

TicketDeleted|error - successful

post tickets/search

Isolated FunctionResource Function

function post tickets/search(SearchRequest payload, SearchTicketsHeaders headers) returns TicketList|error

Search tickets

Parameters

payload SearchRequest -

headers SearchTicketsHeaders (default {}) - Headers to be sent with the request

Return Type

TicketList|error - successful

get visitors

Isolated FunctionResource Function

function get visitors(RetrieveVisitorWithUserIdHeaders headers, *RetrieveVisitorWithUserIdQueries queries) returns Visitor|error

Retrieve a visitor with User ID

Parameters

headers RetrieveVisitorWithUserIdHeaders (default {}) - Headers to be sent with the request

queries *RetrieveVisitorWithUserIdQueries - Queries to be sent with the request

Return Type

Visitor|error - successful

put visitors

Isolated FunctionResource Function

function put visitors(UpdateVisitorRequest payload, UpdateVisitorHeaders headers) returns Visitor|error

Update a visitor

Parameters

payload UpdateVisitorRequest -

headers UpdateVisitorHeaders (default {}) - Headers to be sent with the request

Return Type

Visitor|error - successful

post visitors/convert

Isolated FunctionResource Function

function post visitors/convert(ConvertVisitorRequest payload, ConvertVisitorHeaders headers) returns Contact|error

Convert a visitor

Parameters

payload ConvertVisitorRequest -

headers ConvertVisitorHeaders (default {}) - Headers to be sent with the request

Return Type

Contact|error - successful

get brands

Isolated FunctionResource Function

function get brands(ListBrandsHeaders headers) returns BrandList|error

List all brands

Parameters

headers ListBrandsHeaders (default {}) - Headers to be sent with the request

Return Type

BrandList|error - Successful response

get brands/[string id]

Isolated FunctionResource Function

function get brands/[string id](RetrieveBrandHeaders headers) returns Brand|error

Retrieve a brand

Parameters

headers RetrieveBrandHeaders (default {}) - Headers to be sent with the request

Return Type

Brand|error - Successful response

get emails

Isolated FunctionResource Function

function get emails(ListEmailsHeaders headers) returns EmailList|error

List all email settings

Parameters

headers ListEmailsHeaders (default {}) - Headers to be sent with the request

Return Type

EmailList|error - Successful response

get emails/[string id]

Isolated FunctionResource Function

function get emails/[string id](RetrieveEmailHeaders headers) returns EmailSetting|error

Retrieve an email setting

Parameters

headers RetrieveEmailHeaders (default {}) - Headers to be sent with the request

Return Type

EmailSetting|error - Successful response

post fin_voice/register

Isolated FunctionResource Function

function post fin_voice/register(RegisterFinVoiceCallRequest payload, RegisterFinVoiceCallHeaders headers) returns AiCallResponse|error

Parameters

payload RegisterFinVoiceCallRequest -

headers RegisterFinVoiceCallHeaders (default {}) - Headers to be sent with the request

Return Type

AiCallResponse|error - successful

get fin_voice/collect/[int id]

Isolated FunctionResource Function

function get fin_voice/collect/[int id](CollectFinVoiceCallByIdHeaders headers) returns AiCallResponse|error

Collect Fin Voice call by ID

Parameters

headers CollectFinVoiceCallByIdHeaders (default {}) - Headers to be sent with the request

Return Type

AiCallResponse|error - successful

get fin_voice/external_id/[string externalId]

Isolated FunctionResource Function

function get fin_voice/external_id/[string externalId](CollectFinVoiceCallByExternalIdHeaders headers) returns AiCallResponse|error

Collect Fin Voice call by external ID

Parameters

headers CollectFinVoiceCallByExternalIdHeaders (default {}) - Headers to be sent with the request

Return Type

AiCallResponse|error - successful

get fin_voice/phone_number/[string phoneNumber]

Isolated FunctionResource Function

function get fin_voice/phone_number/[string phoneNumber](CollectFinVoiceCallByPhoneNumberHeaders headers) returns Response|error

Collect Fin Voice call by phone number

Parameters

headers CollectFinVoiceCallByPhoneNumberHeaders (default {}) - Headers to be sent with the request

Return Type

Response|error - Unauthorized

get fin_voice/conversation/[string conversationId]

Isolated FunctionResource Function

function get fin_voice/conversation/[string conversationId](CollectFinVoiceCallsByConversationIdHeaders headers) returns AiCallResponse[]|error

Collect Fin Voice calls by conversation ID

Parameters

headers CollectFinVoiceCallsByConversationIdHeaders (default {}) - Headers to be sent with the request

Return Type

AiCallResponse[]|error - successful

get export/workflows/[string id]

Isolated FunctionResource Function

function get export/workflows/[string id](ExportWorkflowHeaders headers) returns WorkflowExport|error

Export a workflow

Parameters

headers ExportWorkflowHeaders (default {}) - Headers to be sent with the request

Return Type

WorkflowExport|error - Workflow exported successfully

Records

intercom: ActivityLog

Activities performed by Admins

Fields

metadata? ActivityLogMetadata? - Additional data provided about Admin activity

performedBy? ActivityLogPerformedBy - The user or system that performed the logged activity

activityType? "admin_conversation_assignment_limit_change"|"admin_ticket_assignment_limit_change"|"admin_away_mode_change"|"admin_deletion"|"admin_deprovisioned"|"admin_impersonation_end"|"admin_impersonation_start"|"admin_impersonation_consent_approved"|"admin_impersonation_consent_revoked"|"admin_invite_change"|"admin_invite_creation"|"admin_invite_deletion"|"admin_login_failure"|"admin_login_success"|"admin_logout"|"admin_password_reset_request"|"admin_password_reset_success"|"admin_permission_change"|"admin_provisioned"|"admin_two_factor_auth_change"|"admin_unauthorized_sign_in_method"|"app_admin_join"|"app_authentication_method_change"|"app_data_deletion"|"app_data_export"|"app_google_sso_domain_change"|"app_identity_verification_change"|"app_name_change"|"app_outbound_address_change"|"app_package_installation"|"app_package_token_regeneration"|"app_package_uninstallation"|"app_team_creation"|"app_team_deletion"|"app_team_membership_modification"|"app_timezone_change"|"app_webhook_creation"|"app_webhook_deletion"|"articles_in_messenger_enabled_change"|"automatic_away_mode_setting_change"|"bulk_delete"|"bulk_export"|"campaign_deletion"|"campaign_state_change"|"conversation_deletion_schedule_creation"|"conversation_deletion_schedule_deletion"|"conversation_deletion_schedule_state_change"|"conversation_deletion_schedule_update"|"conversation_part_deletion"|"conversation_topic_change"|"conversation_topic_creation"|"conversation_topic_deletion"|"content_redaction_rule_creation"|"content_redaction_rule_deletion"|"content_redaction_rule_update"|"csv_import_completion"|"csv_import_creation"|"custom_authentication_token_creation"|"help_center_settings_change"|"inbound_conversations_change"|"inbox_access_change"|"macro_creation"|"macro_deletion"|"macro_update"|"malicious_domains_setting_change"|"message_deletion"|"message_state_change"|"messenger_api_secret_creation"|"messenger_api_secret_deletion"|"messenger_look_and_feel_change"|"messenger_search_required_change"|"messenger_spaces_change"|"oauth_token_revocation"|"office_hours_change"|"role_change"|"role_creation"|"role_deletion"|"ruleset_activation_title_preview"|"ruleset_creation"|"ruleset_deletion"|"search_browse_enabled_change"|"search_browse_required_change"|"seat_change"|"seat_revoke"|"security_settings_change"|"series_creation"|"series_deletion"|"series_settings_update"|"series_status_change"|"series_update"|"strip_inbound_email_links_change"|"temporary_expectation_change"|"team_assignment_limit_change"|"trusted_domains_setting_change"|"unassign_unsnoozed_at_capacity_setting_change"|"unassign_unsnoozed_when_away_setting_change"|"upfront_email_collection_change"|"allowed_attachment_filetypes_setting_change"|"attach_uploads_inline_setting_change"|"teammate_gifs_setting_change"|"user_camera_attachments_setting_change"|"user_conversation_attachments_setting_change"|"user_file_attachments_setting_change"|"user_gifs_setting_change"|"user_media_attachments_setting_change"|"user_voice_notes_setting_change"|"welcome_message_change"|"workspace_deletion_request" - The type of activity that was performed and logged

createdAt? int - The time the activity was created

activityDescription? string - A sentence or two describing the activity

id? string - The id representing the activity

intercom: ActivityLogList

A paginated list of activity logs

Fields

pages? CursorPages? - Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed

activityLogs? ActivityLog[] - An array of activity logs

'type? string - String representing the object's type. Always has the value activity_log.list

intercom: ActivityLogMetadata

Additional data provided about Admin activity

Fields

teamAssignmentLimit? int? - The team assignment limit value (null if limit was removed)

updateByName? string? - The name of the Admin who initiated the activity

before? record {}? - The state of settings or values before the change. Structure varies by activity type

autoChanged? string? - Indicates if the status was changed automatically or manually

reassignConversations? boolean? - Indicates if conversations should be reassigned while an Admin is away

externalId? string? - The unique identifier for the contact which is provided by the Client

awayMode? boolean? - The away mode status which is set to true when away and false when returned

'source? string? - The action that initiated the status change

team? ActivityLogMetadataTeam? - Details about the team whose assignment limit was changed

expiredAt? string? - The timestamp when the impersonation consent expires

enabled? boolean? - Indicates if the setting is enabled or disabled

mode? string? - The mode of the setting (e.g., when_away_only, when_away_and_reassign)

awayStatusReason? string? - The reason the Admin is away

conversationAssignmentLimit? int? - The conversation assignment limit value for an admin

ticketAssignmentLimit? int? - The ticket assignment limit value for an admin

after? record {}? - The state of settings or values after the change. Structure varies by activity type

updateBy? int? - The ID of the Admin who initiated the activity

signInMethod? string? - The way the admin signed in

consentId? int? - The ID of the impersonation consent

intercom: ActivityLogMetadataTeam

Details about the team whose assignment limit was changed

Fields

name? string - The name of the team

id? int - The ID of the team

intercom: ActivityLogPerformedBy

Details about the Admin involved in the activity

Fields

ip? string - The IP address of the admin

id? string - The id representing the admin

'type? string - String representing the object's type. Always has the value admin

email? string - The email of the admin

intercom: AddressableList

A list used to access other resources from a parent model

Fields

id? string - The id of the addressable object

'type? string - The addressable object type

url? string - Url to get more company resources for this contact

intercom: Admin

Admins are teammate accounts that have access to a workspace

Fields

awayStatusReasonId? int? - The unique identifier of the away status reason

teamIds? int[] - This object represents the avatar associated with the admin

teamPriorityLevel? TeamPriorityLevel? - Priority level assigned to the admin's team

name? string - The name of the admin

awayModeEnabled? boolean - Identifies if this admin is currently set in away mode

awayModeReassign? boolean - Identifies if this admin is set to automatically reassign new conversations to the apps default inbox

id? string - The id representing the admin

avatar? string? - Image for the associated team or teammate

'type? string - String representing the object's type. Always has the value admin

hasInboxSeat? boolean - Identifies if this admin has a paid inbox seat to restrict/allow features that require them

jobTitle? string - The job title of the admin

email? string - The email of the admin

intercom: AdminIdAwayBody

Request body for setting admin away status and reassignment preferences

Fields

awayStatusReasonId? int - The unique identifier of the away status reason

awayModeEnabled boolean(default true) - Set to "true" to change the status of the admin to away

awayModeReassign boolean(default false) - Set to "true" to assign any new conversation replies to your default inbox

intercom: AdminList

A list of admins associated with a given workspace

Fields

'type? string - String representing the object's type. Always has the value admin.list

admins? Admin[] - A list of admins associated with a given workspace

intercom: AdminPriorityLevel

Admin priority levels for the team

Fields

secondaryAdminIds? int[]? - The secondary admin ids for the team

primaryAdminIds? int[]? - The primary admin ids for the team

intercom: AdminReplyConversationRequest

Payload of the request to reply on behalf of an admin

Fields

attachmentUrls? string[] - A list of image URLs that will be added as attachments. You can include up to 10 URLs

adminId string - The id of the admin who is authoring the comment

skipNotifications? boolean - Option to disable notifications when replying to a conversation

createdAt? int - The time the reply was created. If not provided, the current time will be used

messageType "comment"|"note"|"quick_reply" - Type of message being sent (comment, note, or quick_reply)

'type "admin" - Type of user sending the reply (admin)

body? string - The text body of the reply. Notes accept some HTML formatting. Must be present for comment and note message types

replyOptions? QuickReplyOption[] - The quick reply options to display to the end user. Must be present for quick_reply message types

attachmentFiles? ConversationAttachmentFiles[] - A list of files that will be added as attachments. You can include up to 10 files

intercom: AdminReplyTicketRequest

Payload of the request to reply on behalf of an admin

Fields

attachmentUrls? string[] - A list of image URLs that will be added as attachments. You can include up to 10 URLs

adminId string - The id of the admin who is authoring the comment

createdAt? int - The time the reply was created. If not provided, the current time will be used

messageType "comment"|"note"|"quick_reply" - Type of message being sent (comment, note, or quick_reply)

'type "admin" - Type of user sending the reply (admin)

body? string - The text body of the reply. Notes accept some HTML formatting. Must be present for comment and note message types

replyOptions? QuickReplyOption1[] - The quick reply options to display. Must be present for quick_reply message types

intercom: AdminWithApp

Admins are the teammate accounts that have access to a workspace

Fields

app? App? - App is a workspace on Intercom

emailVerified? boolean? - Identifies if this admin's email is verified

teamIds? int[] - This is a list of ids of the teams that this admin is part of

name? string - The name of the admin

awayModeEnabled? boolean - Identifies if this admin is currently set in away mode

awayModeReassign? boolean - Identifies if this admin is set to automatically reassign new conversations to the apps default inbox

id? string - The id representing the admin

avatar? AdminWithAppAvatar - This object represents the avatar associated with the admin

'type? string - String representing the object's type. Always has the value admin

hasInboxSeat? boolean - Identifies if this admin has a paid inbox seat to restrict/allow features that require them

jobTitle? string - The job title of the admin

email? string - The email of the admin

intercom: AdminWithAppAvatar

This object represents the avatar associated with the admin

Fields

imageUrl? string? - This object represents the avatar associated with the admin

'type string(default "avatar") - This is a string that identifies the type of the object. It will always have the value avatar

intercom: AiAgent

Data related to AI Agent involvement in the conversation

Fields

resolutionState? "assumed_resolution"|"confirmed_resolution"|"escalated"|"negative_feedback"|"procedure_handoff"? - The resolution state of AI Agent. If no AI or custom answer has been delivered then this will return null

updatedAt? int? - The time when the AI agent rating was last updated

contentSources? ContentSourcesList - List of content sources available to the AI agent

ratingRemark? string? - The customer satisfaction rating remark given to AI Agent

rating? int? - The customer satisfaction rating given to AI Agent, from 1-5

createdAt? int? - The time when the AI agent rating was created

sourceType? "essentials_plan_setup"|"profile"|"workflow"|"workflow_preview"|"fin_preview"? - The type of the source that triggered AI Agent involvement in the conversation

lastAnswerType? "ai_answer"|"custom_answer"? - The type of the last answer delivered by AI Agent. If no answer was delivered then this will return null

sourceTitle? string? - The title of the source that triggered AI Agent involvement in the conversation. If this is essentials_plan_setup then it will return null

intercom: AiCallResponse

Response containing information about a Fin Voice call

Fields

userPhoneNumber? string - Phone number in E.164 format for the call

intercomCallId? string? - The Intercom call identifier, if the call has been matched

externalCallId? string - The external call identifier from the call provider

callTranscript? record {}[] - Array of transcript entries for the call

id? int - The unique identifier for the external reference

intercomConversationId? string? - The Intercom conversation identifier, if a conversation has been created

appId? int - The workspace identifier

intent? record {}[] - Array of intent classifications for the call

callSummary? string - Summary of the call conversation, truncated to 256 characters. Empty string if no summary available

status? string - Status of the call. Can be "registered", "in-progress", or a resolution state

intercom: App

App is a workspace on Intercom

Fields

identityVerification? boolean - Whether or not the app uses identity verification

timezone? string - The timezone of the region where the app is located

name? string - The name of the app

createdAt? int - When the app was created

'type string(default "app") -

region? string - The Intercom region the app is located in

idCode? string - The id of the app

intercom: ArchiveContactHeaders

Represents the Headers record for the operation: ArchiveContact

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: ArticleContent

The Content of an Article

Fields

updatedAt? int - The time when the article was last updated (seconds)

description? string - The description of the article

createdAt? int - The time when the article was created (seconds)

state? "published"|"draft" - Whether the article is published or is a draft

'type? "article_content"? - The type of object - article_content

title? string - The title of the article

body? string - The body of the article

authorId? int - The ID of the author of the article

url? string - The URL of the article

intercom: ArticleList

This will return a list of articles for the App

Fields

pages? CursorPages? - Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed

data? ArticleListItem[] - An array of Article objects

totalCount? int - A count of the total number of articles

'type? "list" - The type of the object - list

intercom: ArticleListItem

The data returned about your articles when you list them

Fields

description? string? - The description of the article. For multilingual articles, this will be the description of the default language's content

createdAt? int - The time when the article was created. For multilingual articles, this will be the timestamp of creation of the default language's content in seconds

'type "article" (default "article") - The type of object - article

title? string - The title of the article. For multilingual articles, this will be the title of the default language's content

body? string? - The body of the article in HTML. For multilingual articles, this will be the body of the default language's content

parentIds? int[] - The ids of the article's parent collections or sections. An article without this field stands alone

parentType? string? - The type of parent, which can either be a collection or section

url? string? - The URL of the article. For multilingual articles, this will be the URL of the default language's content

tags? Tags - A list of tags objects associated with a conversation

workspaceId? string - The id of the workspace which the article belongs to

translatedContent? ArticleTranslatedContent? - Localized content versions of the article

updatedAt? int - The time when the article was last updated. For multilingual articles, this will be the timestamp of last update of the default language's content in seconds

parentId? int? - The id of the article's parent collection or section. An article without this field stands alone

defaultLocale? string - The default locale of the help center. This field is only returned for multilingual help centers

id? string - The unique identifier for the article which is given by Intercom

state "published"|"draft" (default "draft") - Whether the article is published or is a draft. For multilingual articles, this will be the state of the default language's content

authorId? int - The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace

intercom: ArticleSearchHighlights

The highlighted results of an Article search. In the examples provided my search query is always "my query"

Fields

articleId? string - The ID of the corresponding article

highlightedTitle? ArticleSearchHighlightsHighlightedTitle[] - An Article title highlighted

highlightedSummary? record { 'type "highlight"|"plain" , text string }[][] - An Article description and body text highlighted

intercom: ArticleSearchHighlightsHighlightedTitle

A highlighted article title

Fields

text? string - The text of the title

'type? "highlight"|"plain" - The type of text - highlight or plain

intercom: ArticleSearchResponse

The results of an Article search

Fields

pages? CursorPages? - Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed

data? ArticleSearchResponseData - An object containing the results of the search

totalCount? int - The total number of Articles matching the search query

'type? "list" - The type of the object - list

intercom: ArticleSearchResponseData

An object containing the results of the search

Fields

highlights? ArticleSearchHighlights[] - A corresponding array of highlighted Article content

articles? Article[] - An array of Article objects

intercom: ArticleTranslatedContent

The Translated Content of an Article. The keys are the locale codes and the values are the translated content of the article

Fields

de? ArticleContent? - The Content of an Article

fi? ArticleContent? - The Content of an Article

ru? ArticleContent? - The Content of an Article

pt? ArticleContent? - The Content of an Article

bg? ArticleContent? - The Content of an Article

lt? ArticleContent? - The Content of an Article

hr? ArticleContent? - The Content of an Article

lv? ArticleContent? - The Content of an Article

'type? "article_translated_content"? - The type of object - article_translated_content

fr? ArticleContent? - The Content of an Article

hu? ArticleContent? - The Content of an Article

zhCN? ArticleContent? - Simplified Chinese translation content for the article

bs? ArticleContent? - The Content of an Article

sl? ArticleContent? - The Content of an Article

id? ArticleContent? - The Content of an Article

ca? ArticleContent? - The Content of an Article

sr? ArticleContent? - The Content of an Article

mn? ArticleContent? - The Content of an Article

sv? ArticleContent? - The Content of an Article

ko? ArticleContent? - The Content of an Article

zhTW? ArticleContent? - Traditional Chinese translation content for the article

ptBR? ArticleContent? - Article content translated to Portuguese (Brazil)

el? ArticleContent? - The Content of an Article

en? ArticleContent? - The Content of an Article

it? ArticleContent? - The Content of an Article

es? ArticleContent? - The Content of an Article

et? ArticleContent? - The Content of an Article

cs? ArticleContent? - The Content of an Article

ar? ArticleContent? - The Content of an Article

vi? ArticleContent? - The Content of an Article

nb? ArticleContent? - The Content of an Article

ja? ArticleContent? - The Content of an Article

pl? ArticleContent? - The Content of an Article

da? ArticleContent? - The Content of an Article

he? ArticleContent? - The Content of an Article

ro? ArticleContent? - The Content of an Article

nl? ArticleContent? - The Content of an Article

tr? ArticleContent? - The Content of an Article

intercom: AssignConversationRequest

Payload of the request to assign a conversation

Fields

adminId string - The id of the admin who is performing the action

messageType "assignment" - Message type identifier for assignment operations

'type "admin"|"team" - Assignment target type (admin or team)

body? string - Optionally you can send a response in the conversation when it is assigned

assigneeId string - The id of the admin or team which will be assigned the conversation. A conversation can be assigned both an admin and a team.\nSet 0 if you want this assign to no admin or team (ie. Unassigned)

intercom: AttachContactToACompanyHeaders

Represents the Headers record for the operation: attachContactToACompany

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: AttachContactToConversationHeaders

Represents the Headers record for the operation: attachContactToConversation

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: AttachContactToConversationRequest

Payload of the request to assign a conversation

Fields

adminId? string - The id of the admin who is adding the new participant

customer? record { intercom_user_id string, customer CustomerRequest? }|record { user_id string, customer CustomerRequest? }|record { email string, customer CustomerRequest? } - Customer identification object using Intercom ID, user ID, or email

intercom: AttachSubscriptionTypeToContactHeaders

Represents the Headers record for the operation: attachSubscriptionTypeToContact

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: AttachTagToContactHeaders

Represents the Headers record for the operation: attachTagToContact

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: AttachTagToConversationHeaders

Represents the Headers record for the operation: attachTagToConversation

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: AttachTagToTicketHeaders

Represents the Headers record for the operation: attachTagToTicket

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: AwayStatusReason

Admin away status reason with display properties and metadata

Fields

deleted? boolean - Whether the status reason has been soft deleted

emoji? string - The emoji associated with the status reason

updatedAt? int - The Unix timestamp when the status reason was last updated

createdAt? int - The Unix timestamp when the status reason was created

id? string - The unique identifier for the away status reason

label? string - The display text for the away status reason

'type? string - Object type identifier for away status reason

'order? int - The display order of the status reason

intercom: BlockContactHeaders

Represents the Headers record for the operation: BlockContact

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: Brand

Represents a branding configuration for the workspace

Fields

defaultAddressSettingsId? string - Default email settings ID for this brand

updatedAt? int - Unix timestamp of last modification

name? string - Display name of the brand

createdAt? int - Unix timestamp of brand creation

helpCenterId? string - Associated help center identifier

id? string - Unique brand identifier. For default brand, matches the workspace ID

'type? string - The type of object

isDefault? boolean - Whether this is the workspace's default brand

intercom: BrandList

A list of brands

Fields

data? Brand[] - Array of brand objects in the response

'type? string - The type of object

intercom: Call

Represents a phone call in Intercom

Fields

recordingUrl? string? - API URL to download or redirect to the call recording if available

answeredAt? Datetime - Timestamp when the call was answered

createdAt? Datetime - Timestamp when the call record was created

'type? string - String representing the object's type. Always has the value call

contactId? string? - The id of the contact associated with the call, if any

initiatedAt? Datetime - Timestamp when the call was initiated

transcriptionUrl? string? - API URL to download or redirect to the call transcript if available

updatedAt? Datetime - Timestamp when the call record was last updated

phone? string? - The phone number involved in the call, in E.164 format

finTranscriptionUrl? string? - API URL to the AI Agent (Fin) call transcript if available

conversationId? string? - The id of the conversation associated with the call, if any

finRecordingUrl? string? - API URL to the AI Agent (Fin) call recording if available

adminId? string? - The id of the admin associated with the call, if any

id? string - The id of the call

state? string - The current state of the call

callType? string - The type of call

endedAt? Datetime - Timestamp when the call ended

direction? string - The direction of the call

endedReason? string? - The reason for the call end, if applicable

intercom: CallList

A paginated list of calls

Fields

pages? CursorPages? - Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed

data? Call[] - A list of calls

totalCount? int - Total number of items available

'type? string - String representing the object's type. Always has the value list

intercom: CallsSearchBody

Request body for searching calls by conversation IDs (max 20)

Fields

conversationIds string[] - A list of conversation ids to fetch calls for. Maximum 20

intercom: CallTranscriptList

Response containing a list of calls with transcripts

Fields

data? CallWithTranscript[] - Array of call objects with transcript data

'type? string - Response type identifier

intercom: CallWithTranscript

Call object extended with transcript data and status

Fields

Fields Included from *Call

recordingUrl string|()
answeredAt Datetime
createdAt Datetime
type string
contactId string|()
initiatedAt Datetime
transcriptionUrl string|()
updatedAt Datetime
phone string|()
finTranscriptionUrl string|()
conversationId string|()
finRecordingUrl string|()
adminId string|()
id string
state string
callType string
endedAt Datetime
direction string
endedReason string|()
anydata...

transcriptStatus? string? - The status of the transcript if available

transcript? record {}[] - The call transcript if available, otherwise an empty array

intercom: CancelDataExportHeaders

Represents the Headers record for the operation: cancelDataExport

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: CloseConversationRequest

Payload of the request to close a conversation

Fields

adminId string - The id of the admin who is performing the action

messageType "close" - The type of message, must be 'close' for closing conversations

'type "admin" - The type of user closing the conversation, must be 'admin'

body? string - Optionally you can leave a message in the conversation to provide additional context to the user and other teammates

intercom: CollectFinVoiceCallByExternalIdHeaders

Represents the Headers record for the operation: collectFinVoiceCallByExternalId

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercom: CollectFinVoiceCallByIdHeaders

Represents the Headers record for the operation: collectFinVoiceCallById

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercom: CollectFinVoiceCallByPhoneNumberHeaders

Represents the Headers record for the operation: collectFinVoiceCallByPhoneNumber

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercom: CollectFinVoiceCallsByConversationIdHeaders

Represents the Headers record for the operation: collectFinVoiceCallsByConversationId

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercom: Collection

Collections are top level containers for Articles within the Help Center

Fields

icon? string? - The icon of the collection

description? string? - The description of the collection. For multilingual help centers, this will be the description of the collection for the default language

createdAt? int - The time when the article was created (seconds). For multilingual articles, this will be the timestamp of creation of the default language's content

url? string? - The URL of the collection. For multilingual help centers, this will be the URL of the collection for the default language

workspaceId? string - The id of the workspace which the collection belongs to

translatedContent? GroupTranslatedContent? - Translated content for the collection in different languages

updatedAt? int - The time when the article was last updated (seconds). For multilingual articles, this will be the timestamp of last update of the default language's content

parentId? string? - The id of the parent collection. If null then it is the first level collection

name? string - The name of the collection. For multilingual collections, this will be the name of the default language's content

defaultLocale? string - The default locale of the help center. This field is only returned for multilingual help centers

helpCenterId? int? - The id of the help center the collection is in

id? string - The unique identifier for the collection which is given by Intercom

'order? int - The order of the section in relation to others sections within a collection. Values go from 0 upwards. 0 is the default if there's no order

intercom: CollectionList

This will return a list of Collections for the App

Fields

pages? CursorPages? - Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed

data? Collection[] - An array of collection objects

totalCount? int - A count of the total number of collections

'type? "list" - The type of the object - list

intercom: Company

Companies allow you to represent organizations using your product. Each company will have its own description and be associated with contacts. You can fetch, create, update and list companies

Fields

website? string - The URL for the company website

companyId? string - The company id you have defined for the company

lastRequestAt? int - The time the company last recorded making a request

createdAt? int - The time the company was added in Intercom

industry? string - The industry that the company operates in

'type? "company" - Value is company

customAttributes? record { string... } - The custom attributes you have set on the company

tags? CompanyTags - The list of tags associated with the company

segments? CompanySegments - The list of segments associated with the company

monthlySpend? int - How much revenue the company generates for your business

updatedAt? int - The last time the company was updated

size? int - The number of employees in the company

userCount? int - The number of users in the company

sessionCount? int - How many sessions the company has recorded

name? string - The name of the company

id? string - The Intercom defined id representing the company

remoteCreatedAt? int - The time the company was created by you

appId? string - The Intercom defined code of the workspace the company is associated to

plan? CompanyPlan - Company subscription plan details

intercom: CompanyAttachedContacts

A list of Contact Objects

Fields

pages? CursorPages? - Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed

data? Contact[] - An array containing Contact Objects

totalCount? int - The total number of contacts

'type? "list" - The type of object - list

intercom: CompanyAttachedSegments

A list of Segment Objects

Fields

data? Segment[] - An array containing Segment Objects

'type? "list" - The type of object - list

intercom: CompanyData

An object containing data about the companies that a contact is associated with

Fields

id? string - The unique identifier for the company which is given by Intercom

'type? "company" - The type of the object. Always company

url? string - The relative URL of the company

intercom: CompanyList

This will return a list of companies for the App

Fields

pages? CursorPages? - Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed

data? Company[] - An array containing Company Objects

totalCount? int - The total number of companies

'type? "list" - The type of object - list

intercom: CompanyPlan

Company subscription plan details

Fields

name? string - The name of the plan

id? string - The id of the plan

'type? string - Value is always "plan"

intercom: CompanyScroll

Companies allow you to represent organizations using your product. Each company will have its own description and be associated with contacts. You can fetch, create, update and list companies

Fields

pages? CursorPages? - Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed

data? Company[] - Array of company objects returned in the scroll response

totalCount? int? - The total number of companies

scrollParam? string - The scroll parameter to use in the next request to fetch the next page of results

'type? "list" - The type of object - list

intercom: CompanySegments

The list of segments associated with the company

Fields

'type? "segment.list" - The type of the object

segments? Segment[] - Array of segments associated with the company

intercom: CompanyTags

The list of tags associated with the company

Fields

'type? "tag.list" - The type of the object

tags? TagBasic[] - Array of tags associated with the company

intercom: ConnectionConfig

Closed record

Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.

Fields

auth BearerTokenConfig - Configurations related to client authentication

httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client

http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol

http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol

timeout decimal(default 30) - The maximum time to wait (in seconds) for a response before closing the connection

forwarded string(default "disable") - The choice of setting forwarded/x-forwarded header

followRedirects? FollowRedirects - Configurations associated with Redirection

poolConfig? PoolConfiguration - Configurations associated with request pooling

cache CacheConfig(default {}) - HTTP caching related configurations

compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (accept-encoding) header

circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker

retryConfig? RetryConfig - Configurations associated with retrying

cookieConfig? CookieConfig - Configurations associated with cookies

responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits

secureSocket? ClientSecureSocket - SSL/TLS-related options

proxy? ProxyConfig - Proxy server related options

socketConfig ClientSocketConfig(default {}) - Provides settings related to client socket configuration

validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

laxDataBinding boolean(default true) - Enables relaxed data binding on the client side. When enabled, nil values are treated as optional, and absent fields are handled as nilable types. Enabled by default.

intercom: Contact

Contacts represent your leads and users in Intercom

Fields

lastEmailClickedAt? int? - (UNIX timestamp) The time when the contact last clicked a link in an email

role? string - The role of the contact

notes? ContactNotes - An object containing notes meta data about the notes that a contact has. Up to 10 will be displayed here. Use the url to get more

androidLastSeenAt? int? - (UNIX timestamp) The time when the contact was last seen on an Android device

iosDevice? string? - The iOS device which the contact is using

ownerId? int? - The id of an admin that has been assigned account ownership of the contact

createdAt? int - (UNIX timestamp) The time when the contact was created

externalId? string? - The unique identifier for the contact which is provided by the Client

'type? string - The type of object

androidSdkVersion? string? - The version of the Android SDK which the contact is using

languageOverride? string? - A preferred language setting for the contact, used by the Intercom Messenger even if their browser settings change

customAttributes? record {} - The custom attributes which are set for the contact

workspaceId? string - The id of the workspace which the contact belongs to

companies? ContactCompanies - An object with metadata about companies attached to a contact . Up to 10 will be displayed here. Use the url to get more

unsubscribedFromEmails? boolean - Whether the contact is unsubscribed from emails

lastEmailOpenedAt? int? - (UNIX timestamp) The time when the contact last opened an email

updatedAt? int - (UNIX timestamp) The time when the contact was last updated

lastRepliedAt? int? - (UNIX timestamp) The time when the contact last messaged in

browser? string? - The name of the browser which the contact is using

iosAppName? string? - The name of the iOS app which the contact is using

id? string - The unique identifier for the contact which is given by Intercom

browserVersion? string? - The version of the browser which the contact is using

browserLanguage? string? - The language set by the browser which the contact is using

iosSdkVersion? string? - The version of the iOS SDK which the contact is using

email? string - The contact's email

signedUpAt? int? - (UNIX timestamp) The time specified for when a contact signed up

iosOsVersion? string? - The version of iOS which the contact is using

hasHardBounced? boolean - Whether the contact has had an email sent to them hard bounce

os? string? - The operating system which the contact is using

iosAppVersion? string? - The version of the iOS app which the contact is using

lastContactedAt? int? - (UNIX timestamp) The time when the contact was last messaged

androidDevice? string? - The Android device which the contact is using

iosLastSeenAt? int? - (UNIX timestamp) The last time the contact used the iOS app

androidAppVersion? string? - The version of the Android app which the contact is using

avatar? ContactAvatar? - Avatar image information for a contact

tags? ContactTags? - An object containing tags meta data about the tags that a contact has. Up to 10 will be displayed here. Use the url to get more

markedEmailAsSpam? boolean - Whether the contact has marked an email sent to them as spam

socialProfiles? ContactSocialProfiles - Contact's social media profile information and links

androidAppName? string? - The name of the Android app which the contact is using

androidOsVersion? string? - The version of the Android OS which the contact is using

phone? string? - The contacts phone

name? string? - The contacts name

emailDomain? string - The contact's email domain

location? ContactLocation - An object containing location meta data about a Intercom contact

lastSeenAt? int? - (UNIX timestamp) The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually)

intercom: ContactAttachedCompanies

A list of Company Objects

Fields

companies? Company[] - An array containing Company Objects

pages? PagesLink - The majority of list resources in the API are paginated to allow clients to traverse data over multiple requests. Their responses are likely to contain a pages object that hosts pagination links which a client can use to paginate through the data without having to construct a query. The link relations for the pages field are as follows

totalCount? int - The total number of companies associated to this contact

'type? "list" - The type of object

intercom: ContactAvatar

Avatar image information for a contact

Fields

imageUrl? string? - An image URL containing the avatar of a contact

'type? string - The type of object

intercom: ContactCompanies

An object with metadata about companies attached to a contact . Up to 10 will be displayed here. Use the url to get more

Fields

data? CompanyData[] - An array of company data objects attached to the contact

totalCount? int - Integer representing the total number of companies attached to this contact

hasMore? boolean - Whether there's more Addressable Objects to be viewed. If true, use the url to view all

url? string - Url to get more company resources for this contact

intercom: ContactIdCompaniesBody

Request body schema for associating a company with a contact

Fields

id string - The unique identifier for the company which is given by Intercom

intercom: ContactIdNotesBody

Request body schema for creating notes on a contact

Fields

adminId? string - The unique identifier of a given admin

body string - The text of the note

intercom: ContactIdSubscriptionsBody

Request body for managing contact subscription preferences

Fields

id string - The unique identifier for the subscription which is given by Intercom

consentType string - The consent_type of a subscription, opt_out or opt_in

intercom: ContactIdTagsBody

Request body containing tag identifier for contact tagging operations

Fields

id string - The unique identifier for the tag which is given by Intercom

intercom: ContactList

Contacts are your users in Intercom

Fields

pages? CursorPages? - Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed

data? Contact[] - The list of contact objects

totalCount? int - A count of the total number of objects

'type? "list" - Always list

intercom: ContactLocation

An object containing location meta data about a Intercom contact

Fields

country? string? - The country that the contact is located in

city? string? - The city that the contact is located in

'type? string? - Always location

region? string? - The overal region that the contact is located in

intercom: ContactNotes

An object containing notes meta data about the notes that a contact has. Up to 10 will be displayed here. Use the url to get more

Fields

data? AddressableList[] - This object represents the notes attached to a contact

totalCount? int - Int representing the total number of companyies attached to this contact

hasMore? boolean - Whether there's more Addressable Objects to be viewed. If true, use the url to view all

url? string - Url to get more company resources for this contact

intercom: ContactReference

reference to contact object

Fields

externalId? string? - The unique identifier for the contact which is provided by the Client

id? string - The unique identifier for the contact which is given by Intercom

'type? "contact" - always contact

intercom: ContactReplyBaseRequest

Base request object for creating contact replies with attachments and options

Fields

attachmentUrls? string[] - A list of image URLs that will be added as attachments. You can include up to 10 URLs

createdAt? int - The time the reply was created. If not provided, the current time will be used

messageType "comment" - The type of message being sent (always 'comment')

'type "user" - The sender type for the reply (always 'user')

body string - The text body of the comment

replyOptions? QuickReplyOption1[] - The quick reply selection the contact wishes to respond with. These map to buttons displayed in the Messenger UI if sent by a bot, or the reply options sent by an Admin via the API

intercom: ContactSegments

A list of segments objects attached to a specific contact

Fields

data? Segment[] - Segment objects associated with the contact

'type? "list" - The type of the object

intercom: ContactSocialProfiles

An object containing social profiles that a contact has

Fields

data? SocialProfile[] - A list of social profiles objects associated with the contact

intercom: ContactTags

An object containing tags meta data about the tags that a contact has. Up to 10 will be displayed here. Use the url to get more

Fields

data? AddressableList[] - This object represents the tags attached to a contact

totalCount? int - Int representing the total number of tags attached to this contact

hasMore? boolean - Whether there's more Addressable Objects to be viewed. If true, use the url to view all

url? string - url to get more tag resources for this contact

intercom: ContentImportSource

An external source for External Pages that you add to your Fin Content Library

Fields

lastSyncedAt int - The time when the content import source was last synced

syncBehavior "api"|"automatic"|"manual" - If you intend to create or update External Pages via the API, this should be set to api

updatedAt int - The time when the content import source was last updated

createdAt int - The time when the content import source was created

id int - The unique identifier for the content import source which is given by Intercom

'type "content_import_source" (default "content_import_source") - Always external_page

url string - The URL of the root of the external source

status "active"|"deactivated" (default "active") - The status of the content import source

intercom: ContentImportSourcesList

This will return a list of the content import sources for the App

Fields

pages? PagesLink - The majority of list resources in the API are paginated to allow clients to traverse data over multiple requests. Their responses are likely to contain a pages object that hosts pagination links which a client can use to paginate through the data without having to construct a query. The link relations for the pages field are as follows

data? ContentImportSource[] - An array of Content Import Source objects

totalCount? int - A count of the total number of content import sources

'type? "list" - The type of the object - list

intercom: ContentSource

The content source used by AI Agent in the conversation

Fields

contentType? "file"|"article"|"external_content"|"content_snippet"|"workflow_connector_action" - The type of the content source

title? string - The title of the content source

locale? string - The ISO 639 language code of the content source

url? string - The internal URL linking to the content source for teammates

intercom: ContentSourcesList

Collection of content sources used by AI Agent in conversations

Fields

'type? "content_source.list" - Object type identifier for content source list

total_count? int - The total number of content sources used by AI Agent in the conversation.

content_sources? ContentSource[] - The content sources used by AI Agent in the conversation.

intercom: Conversation

Conversations are how you can communicate with users in Intercom. They are created when a contact replies to an outbound message, or when one admin directly sends a message to a single contact

Fields

createdAt? int - The time the conversation was created

snoozedUntil? int? - If set this is the time in the future when this conversation will be marked as open. i.e. it will be in a snoozed state until this time. i.e. it will be in a snoozed state until this time

conversationRating? ConversationRating? - Rating given to the conversation by participants

'source? ConversationSource - The type of the conversation part that started this conversation. Can be Contact, Admin, Campaign, Automated or Operator initiated

slaApplied? SlaApplied? - Service level agreement settings applied to this conversation

'type? string - Always conversation

title? string? - The title given to the conversation

aiAgent? AiAgent - AI agent configuration and details associated with the conversation

customAttributes? CustomAttributes - Custom attributes and metadata assigned to the conversation

adminAssigneeId? int? - The id of the admin assigned to the conversation. If it's not assigned to an admin it will return null

teammates? ConversationTeammates? - The list of teammates who participated in the conversation (wrote at least one conversation part)

updatedAt? int - The last time the conversation was updated

teamAssigneeId? string? - The id of the team assigned to the conversation. If it's not assigned to a team it will return null

aiAgentParticipated? boolean - Indicates whether the AI Agent participated in the conversation

company? Company - Companies allow you to represent organizations using your product. Each company will have its own description and be associated with contacts. You can fetch, create, update and list companies

id? string - The id representing the conversation

state? "open"|"closed"|"snoozed" - Can be set to "open", "closed" or "snoozed"

read? boolean - Indicates whether a conversation has been read

conversationParts? ConversationParts - Individual messages and parts that make up the conversation thread

waitingSince? int? - The last time a Contact responded to an Admin. In other words, the time a customer started waiting for a response. Set to null if last reply is from an Admin

priority? "priority"|"not_priority" - If marked as priority, it will return priority or else not_priority

tags? Tags - A list of tags objects associated with a conversation

firstContactReply? ConversationFirstContactReply? - Details about the first reply from a contact in the conversation

linkedObjects? LinkedObjectList - External objects and resources linked to this conversation

open? boolean - Indicates whether a conversation is open (true) or closed (false)

contacts? ConversationContacts - The list of contacts (users or leads) involved in this conversation. This will only contain one customer unless more were added via the group conversation feature

statistics? ConversationStatistics? - A Statistics object containing all information required for reporting, with timestamps and calculated metrics

intercom: ConversationAttachmentFiles

Properties of the attachment files in a conversation part

Fields

contentType? string - The content type of the file

data? string - The base64 encoded file data

name? string - The name of the file

intercom: ConversationAttributeUpdatedByAdmin

Contains details about Custom Data Attributes (CDAs) that were modified by an admin (operator) for conversation part type conversation_attribute_updated_by_admin

Fields

attribute? ConversationAttributeUpdatedByAdminAttribute - Attribute information when updated by an admin

value? ConversationAttributeUpdatedByAdminValue - Schema representing conversation attribute changes made by administrators

intercom: ConversationAttributeUpdatedByAdminAttribute

Attribute information when updated by an admin

Fields

name? string - Name of the CDA updated

intercom: ConversationAttributeUpdatedByAdminValue

Schema representing conversation attribute changes made by administrators

Fields

previous? string? - Previous value of the CDA

name? string - Current value of the CDA updated

intercom: ConversationAttributeUpdatedByUser

Contains details about Custom Data Attributes (CDAs) that were modified by a user for conversation part type conversation_attribute_updated_by_user

Fields

attribute? ConversationAttributeUpdatedByUserAttribute - Attribute information when updated by a user

value? ConversationAttributeUpdatedByUserValue - Value changes for conversation attributes updated by users

intercom: ConversationAttributeUpdatedByUserAttribute

Attribute information when updated by a user

Fields

name? string - Name of the CDA updated

intercom: ConversationAttributeUpdatedByUserValue

Value changes for conversation attributes updated by users

Fields

previous? string? - Previous value of the CDA (null for older events)

name? string - Current value of the CDA updated

intercom: ConversationAttributeUpdatedByWorkflow

Contains details about the workflow that was triggered and any Custom Data Attributes (CDAs) that were modified during the workflow execution for conversation part type conversation_attribute_updated_by_workflow

Fields

workflow? ConversationAttributeUpdatedByWorkflowWorkflow - Workflow information for conversation attribute updates

attribute? ConversationAttributeUpdatedByWorkflowAttribute - Attribute information for conversation data updated by workflow

value? ConversationAttributeUpdatedByWorkflowValue - Value information for conversation data updated by workflow

intercom: ConversationAttributeUpdatedByWorkflowAttribute

Attribute information for conversation data updated by workflow

Fields

name? string - Name of the CDA updated

intercom: ConversationAttributeUpdatedByWorkflowValue

Value information for conversation data updated by workflow

Fields

name? string - Value of the CDA updated

intercom: ConversationAttributeUpdatedByWorkflowWorkflow

Workflow information for conversation attribute updates

Fields

name? string - Name of the workflow

intercom: ConversationContacts

The list of contacts (users or leads) involved in this conversation. This will only contain one customer unless more were added via the group conversation feature

Fields

'type? "contact.list" -

contacts? ContactReference[] - The list of contacts (users or leads) involved in this conversation. This will only contain one customer unless more were added via the group conversation feature

intercom: ConversationDeleted

deleted conversation object

Fields

deleted? boolean - Whether the conversation is deleted or not

id? string - The unique identifier for the conversation

'object? "conversation" - always conversation

intercom: ConversationFirstContactReply

An object containing information on the first users message. For a contact initiated message this will represent the users original message

Fields

createdAt? int -

'type? string -

url? string? -

intercom: ConversationIdTagsBody

Request body for tagging conversations with admin and tag identifiers

Fields

adminId string - The unique identifier for the admin which is given by Intercom

id string - The unique identifier for the tag which is given by Intercom

intercom: ConversationList

Conversations are how you can communicate with users in Intercom. They are created when a contact replies to an outbound message, or when one admin directly sends a message to a single contact

Fields

pages? CursorPages? - Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed

totalCount? int - A count of the total number of objects

'type? "conversation.list" - Always conversation.list

conversations? ConversationListItem[] - The list of conversation objects

intercom: ConversationListItem

The data returned about your conversations when you list or search them

Fields

createdAt? int - The time the conversation was created

snoozedUntil? int? - If set this is the time in the future when this conversation will be marked as open. i.e. it will be in a snoozed state until this time. i.e. it will be in a snoozed state until this time

conversationRating? ConversationRating? - The rating given to this conversation

'source? ConversationSource - The type of the conversation part that started this conversation. Can be Contact, Admin, Campaign, Automated or Operator initiated

slaApplied? SlaApplied? - The service level agreement applied to this conversation

'type? string - Always conversation

title? string? - The title given to the conversation

aiAgent? AiAgent - The AI agent associated with this conversation

customAttributes? CustomAttributes - Custom attributes attached to the conversation

adminAssigneeId? int? - The id of the admin assigned to the conversation. If it's not assigned to an admin it will return null

teammates? ConversationTeammates? - The list of teammates who participated in the conversation (wrote at least one conversation part)

updatedAt? int - The last time the conversation was updated

teamAssigneeId? string? - The id of the team assigned to the conversation. If it's not assigned to a team it will return null

aiAgentParticipated? boolean - Indicates whether the AI Agent participated in the conversation

company? Company - Companies allow you to represent organizations using your product. Each company will have its own description and be associated with contacts. You can fetch, create, update and list companies

id? string - The id representing the conversation

state? "open"|"closed"|"snoozed" - Can be set to "open", "closed" or "snoozed"

read? boolean - Indicates whether a conversation has been read

waitingSince? int? - The last time a Contact responded to an Admin. In other words, the time a customer started waiting for a response. Set to null if last reply is from an Admin

priority? "priority"|"not_priority" - If marked as priority, it will return priority or else not_priority

tags? Tags - A list of tags objects associated with a conversation

firstContactReply? ConversationFirstContactReply? - Details of the first reply from a contact in the conversation

linkedObjects? LinkedObjectList - List of objects linked to the conversation

open? boolean - Indicates whether a conversation is open (true) or closed (false)

contacts? ConversationContacts - The list of contacts (users or leads) involved in this conversation. This will only contain one customer unless more were added via the group conversation feature

statistics? ConversationStatistics? - A Statistics object containing all information required for reporting, with timestamps and calculated metrics

intercom: ConversationPart

A Conversation Part represents a message in the conversation

Fields

metadata? ConversationPartMetadata - Metadata for a conversation part

attachments? PartAttachment[] - A list of attachments for the part

redacted? boolean - Whether or not the conversation part has been redacted

author? ConversationPartAuthor - The object who initiated the conversation, which can be a Contact, Admin or Team. Bots and campaigns send messages on behalf of Admins or Teams. For Twitter, this will be blank

appPackageCode? string? - The app package code if this part was created via API. null if the part was not created via API

createdAt? int - The time the conversation part was created

partType? string - The type of conversation part

externalId? string? - The external id of the conversation part

'type? string - Always conversation_part

body? string? - The message body, which may contain HTML. For Twitter, this will show a generic message regarding why the body is obscured. In webhook payloads for API version 2.15+, this field returns plain text

tags? TagBasic[]? - A list of tags objects associated with the conversation part

updatedAt? int - The last time the conversation part was updated

eventDetails? EventDetails - Detailed information about events associated with the conversation part

id? string - The id representing the conversation part

notifiedAt? int - The time the user was notified with the conversation part

state? "open"|"closed"|"snoozed" - Indicates the current state of conversation when the conversation part was created

emailMessageMetadata? EmailMessageMetadata - Metadata specific to email messages in the conversation part

assignedTo? Reference - The user or team assigned to handle the conversation part

intercom: ConversationPartAuthor

The object who initiated the conversation, which can be a Contact, Admin or Team. Bots and campaigns send messages on behalf of Admins or Teams. For Twitter, this will be blank

Fields

name? string? - The name of the author

id? string - The id of the author

fromAiAgent? boolean - If this conversation part was sent by the AI Agent

'type? string - The type of the author

isAiAnswer? boolean - If this conversation part body was generated by the AI Agent

email? string - The email of the author

intercom: ConversationPartMetadata

Metadata for a conversation part

Fields

quickReplyUuid? string - The unique identifier for the quick reply option that was clicked by the end user

quickReplyOptions? ConversationPartMetadataQuickReplyOptions[] - The quick reply options sent by the Admin or bot, presented in this conversation part

intercom: ConversationParts

A list of Conversation Part objects for each part message in the conversation. This is only returned when Retrieving a Conversation, and ignored when Listing all Conversations. There is a limit of 500 parts

Fields

totalCount? int -

conversationParts? ConversationPart[] - A list of Conversation Part objects for each part message in the conversation. This is only returned when Retrieving a Conversation, and ignored when Listing all Conversations. There is a limit of 500 parts

'type? "conversation_part.list" -

intercom: ConversationRating

The Conversation Rating object which contains information on the rating and/or remark added by a Contact and the Admin assigned to the conversation

Fields

updatedAt? int - The time the rating was last updated

teammate? Reference - reference to another object

contact? ContactReference - reference to contact object

rating? int - The rating, between 1 and 5, for the conversation

createdAt? int - The time the rating was requested in the conversation being rated

remark? string - An optional field to add a remark to correspond to the number rating

intercom: ConversationResponseTime

Details of first response time of assigned team in seconds

Fields

responseTime? int - First response time of assigned team in seconds

teamId? int - Id of the assigned team

teamName? string - Name of the assigned Team, null if team does not exist, Unassigned if no team is assigned

intercom: ConversationSource

The type of the conversation part that started this conversation. Can be Contact, Admin, Campaign, Automated or Operator initiated

Fields

attachments? PartAttachment[] - A list of attachments for the part

redacted? boolean - Whether or not the source message has been redacted. Only applicable for contact initiated messages

subject? string - Optional. The message subject. For Twitter, this will show a generic message regarding why the subject is obscured. In webhook payloads for API version 2.15+, this field returns plain text

author? ConversationPartAuthor - The object who initiated the conversation, which can be a Contact, Admin or Team. Bots and campaigns send messages on behalf of Admins or Teams. For Twitter, this will be blank

id? string - The id representing the message

'type? "conversation"|"email"|"facebook"|"instagram"|"phone_call"|"phone_switch"|"push"|"sms"|"twitter"|"whatsapp" - This includes conversation, email, facebook, instagram, phone_call, phone_switch, push, sms, twitter and whatsapp

body? string - The message body, which may contain HTML. For Twitter, this will show a generic message regarding why the body is obscured. In webhook payloads for API version 2.15+, this field returns plain text

deliveredAs? string - The conversation's initiation type. Possible values are customer_initiated, campaigns_initiated (legacy campaigns), operator_initiated (Custom bot), automated (Series and other outbounds with dynamic audience message) and admin_initiated (fixed audience message, ticket initiated by an admin, group email)

url? string? - The URL where the conversation was started. For Twitter, Email, and Bots, this will be blank

intercom: ConversationStatistics

A Statistics object containing all information required for reporting, with timestamps and calculated metrics

Fields

timeToAdminReply? int - Duration until first admin reply. Subtracts out of business hours. In seconds

lastContactReplyAt? int - Time of the last conversation part from a contact

lastCloseAt? int - Time of the last conversation close

countAssignments? int - Number of assignments after first_contact_reply_at

countConversationParts? int - Total number of conversation parts

firstCloseAt? int - Time of first close after first_contact_reply_at

timeToLastClose? int - Duration until conversation was closed last time. Subtracts out of business hours. In seconds

'type? string -

firstAssignmentAt? int - Time of first assignment after first_contact_reply_at

countReopens? int - Number of reopens after first_contact_reply_at

timeToAssignment? int - Duration until last assignment before first admin reply. In seconds

medianTimeToReply? int - Median based on all admin replies after a contact reply. Subtracts out of business hours. In seconds

firstAdminReplyAt? int - Time of first admin reply after first_contact_reply_at

assignedTeamFirstResponseTimeByTeam? ConversationResponseTime[] - An array of conversation response time objects

adjustedHandlingTime? int? - Adjusted handling time for conversation in seconds. This is the active handling time excluding idle periods when teammates are not actively working on the conversation

timeToFirstClose? int - Duration until conversation was closed first time. Subtracts out of business hours. In seconds

assignedTeamFirstResponseTimeInOfficeHours? ConversationResponseTime[] - An array of conversation response time objects within office hours

lastAssignmentAdminReplyAt? int - Time of first admin reply since most recent assignment

lastAssignmentAt? int - Time of last assignment after first_contact_reply_at

firstContactReplyAt? int - Time of first text conversation part from a contact

lastClosedById? string - The last admin who closed the conversation. Returns a reference to an Admin object

handlingTime? int - Time from conversation assignment to conversation close in seconds

lastAdminReplyAt? int - Time of the last conversation part from an admin

intercom: ConversationTeammates

The list of teammates who participated in the conversation (wrote at least one conversation part)

Fields

teammates? Reference[] - The list of teammates who participated in the conversation (wrote at least one conversation part)

'type? string - The type of the object - admin.list

intercom: ConvertConversationToTicketHeaders

Represents the Headers record for the operation: convertConversationToTicket

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: ConvertConversationToTicketRequest

You can convert a Conversation to a Ticket

Fields

ticketTypeId string - The ID of the type of ticket you want to convert the conversation to

attributes? TicketRequestCustomAttributes - The attributes set on the ticket. When setting the default title and description attributes, the attribute keys that should be used are _default_title_ and _default_description_. When setting ticket type attributes of the list attribute type, the key should be the attribute name and the value of the attribute should be the list item id, obtainable by listing the ticket type. For example, if the ticket type has an attribute called priority of type list, the key should be priority and the value of the attribute should be the guid of the list item (e.g. de1825a0-0164-4070-8ca6-13e22462fa7e)

intercom: ConvertVisitorHeaders

Represents the Headers record for the operation: convertVisitor

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: ConvertVisitorRequest

You can merge a Visitor to a Contact of role type lead or user

Fields

'type string - Represents the role of the Contact model. Accepts lead or user

visitor ConvertVisitorRequestVisitor - The unique identifiers to convert a single Visitor

user ConvertVisitorRequestUser - The unique identifiers retained after converting or merging

intercom: CreateArticleHeaders

Represents the Headers record for the operation: createArticle

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: CreateArticleRequest

You can create an Article

Fields

translatedContent? ArticleTranslatedContent? - Translated content for the article in multiple languages

parentId? int - The id of the article's parent collection or section. An article without this field stands alone

description? string - The description of the article. For multilingual articles, this will be the description of the default language's content

state? "published"|"draft" - Whether the article will be published or will be a draft. Defaults to draft. For multilingual articles, this will be the state of the default language's content

title string - The title of the article.For multilingual articles, this will be the title of the default language's content

body? string - The content of the article. For multilingual articles, this will be the body of the default language's content

authorId int - The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace

parentType? string - The type of parent, which can either be a collection or section

intercom: CreateCollectionHeaders

Represents the Headers record for the operation: createCollection

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: CreateCollectionRequest

You can create a collection

Fields

translatedContent? GroupTranslatedContent? - Translated content for the collection in multiple languages

parentId? string? - The id of the parent collection. If null then it will be created as the first level collection

name string - The name of the collection. For multilingual collections, this will be the name of the default language's content

description? string - The description of the collection. For multilingual collections, this will be the description of the default language's content

helpCenterId? int? - The id of the help center where the collection will be created. If null then it will be created in the default help center

intercom: CreateContactHeaders

Represents the Headers record for the operation: CreateContact

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: CreateContentImportSourceHeaders

Represents the Headers record for the operation: createContentImportSource

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: CreateContentImportSourceRequest

You can add an Content Import Source to your Fin Content Library

Fields

syncBehavior "api" - If you intend to create or update External Pages via the API, this should be set to api

url string - The URL of the content import source

status "active"|"deactivated" (default "active") - The status of the content import source

intercom: CreateConversationHeaders

Represents the Headers record for the operation: createConversation

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: CreateConversationRequest

Conversations are how you can communicate with users in Intercom. They are created when a contact replies to an outbound message, or when one admin directly sends a message to a single contact

Fields

attachmentUrls? string[] - A list of image URLs that will be added as attachments. You can include up to 10 URLs

createdAt? int - The time the conversation was created as a UTC Unix timestamp. If not provided, the current time will be used. This field is only recommneded for migrating past conversations from another source into Intercom

'from CreateConversationRequestFrom - Contact information for conversation originator

body string - The content of the message. HTML is not supported

intercom: CreateConversationRequestFrom

Contact information for conversation originator

Fields

id string - The identifier for the contact which is given by Intercom

'type "lead"|"user"|"contact" - The role associated to the contact - user or lead

intercom: CreateCustomObjectInstancesHeaders

Represents the Headers record for the operation: createCustomObjectInstances

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: CreateDataAttributeHeaders

Represents the Headers record for the operation: createDataAttribute

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: CreateDataEventHeaders

Represents the Headers record for the operation: createDataEvent

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: CreateDataEventSummariesRequest

You can send a list of event summaries for a user. Each event summary should contain the event name, the time the event occurred, and the number of times the event occurred. The event name should be a past tense "verb-noun" combination, to improve readability, for example updated-plan

Fields

eventSummaries? CreateDataEventSummariesRequestEventSummaries - Collection of event summary data to be created

userId? string - Your identifier for the user

intercom: CreateDataEventSummariesRequestEventSummaries

A list of event summaries for the user. Each event summary should contain the event name, the time the event occurred, and the number of times the event occurred. The event name should be a past tense 'verb-noun' combination, to improve readability, for example updated-plan

Fields

last? int - The last time the event was sent

count? int - The number of times the event occurred

eventName? string - The name of the event that occurred. A good event name is typically a past tense 'verb-noun' combination, to improve readability, for example updated-plan

first? int - The first time the event was sent

intercom: CreateDataExportHeaders

Represents the Headers record for the operation: createDataExport

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: CreateDataExportsRequest

Request for creating a data export

Fields

createdAtBefore int - The end date that you request data for. It must be formatted as a unix timestamp

createdAtAfter int - The start date that you request data for. It must be formatted as a unix timestamp

intercom: CreateExternalPageHeaders

Represents the Headers record for the operation: createExternalPage

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: CreateExternalPageRequest

You can add an External Page to your Fin Content Library

Fields

html string - The body of the external page in HTML

externalId string - The identifier for the external page which was given by the source. Must be unique for the source

sourceId int - The unique identifier for the source of the external page which was given by Intercom. Every external page must be associated with a Content Import Source which represents the place it comes from and from which it inherits a default audience (configured in the UI). For a new source, make a POST request to the Content Import Source endpoint and an ID for the source will be returned in the response

title string - The title of the external page

locale "en" (default "en") - Always en

aiCopilotAvailability boolean(default false) - Whether the external page should be used to answer questions by AI Copilot. Will not default when updating an existing external page

url? string - The URL of the external page. This will be used by Fin to link end users to the page it based its answer on. When a URL is not present, Fin will not reference the source

aiAgentAvailability boolean(default false) - Whether the external page should be used to answer questions by AI Agent. Will not default when updating an existing external page

intercom: CreateInternalArticleHeaders

Represents the Headers record for the operation: createInternalArticle

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: CreateInternalArticleRequest

You can create an Internal Article

Fields

ownerId int - The id of the owner of the article

title string - The title of the article

body? string - The content of the article

authorId int - The id of the author of the article

intercom: CreateMessageHeaders

Represents the Headers record for the operation: createMessage

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: CreateNewsItemHeaders

Represents the Headers record for the operation: createNewsItem

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: CreateNoteHeaders

Represents the Headers record for the operation: createNote

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: CreateOrUpdateCompanyHeaders

Represents the Headers record for the operation: createOrUpdateCompany

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: CreateOrUpdateCompanyRequest

You can create or update a Company

Fields

website? string - The URL for this company's website. Please note that the value specified here is not validated. Accepts any string

monthlySpend? int - How much revenue the company generates for your business. Note that this will truncate floats. i.e. it only allow for whole integers, 155.98 will be truncated to 155. Note that this has an upper limit of 2**31-1 or 2147483647.

companyId? string - The company id you have defined for the company. Can't be updated

size? int - The number of employees in this company

name? string - The name of the Company

industry? string - The industry that this company operates in

remoteCreatedAt? int - The time the company was created by you

plan? string - The name of the plan you have associated with the company

customAttributes? record { string... } - A hash of key/value pairs containing any other data about the company you want Intercom to store

intercom: CreateOrUpdateCustomObjectInstanceRequest

Payload to create or update a Custom Object instance

Fields

externalUpdatedAt? int? - The time when the Custom Object instance was last updated in the external system it originated from

externalCreatedAt? int? - The time when the Custom Object instance was created in the external system it originated from

externalId? string - A unique identifier for the Custom Object instance in the external system it originated from

customAttributes? record { string... }? - The custom attributes which are set for the Custom Object instance

intercom: CreateOrUpdateTagRequest

You can create or update an existing tag

Fields

name string - The name of the tag, which will be created if not found, or the new name for the tag if this is an update request. Names are case insensitive

id? string - The id of tag to updates

intercom: CreatePhoneSwitchHeaders

Represents the Headers record for the operation: createPhoneSwitch

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: CreatePhoneSwitchRequest

You can create an phone switch

Fields

phone string - Phone number in E.164 format, that will receive the SMS to continue the conversation in the Messenger

customAttributes? CustomAttributes - Custom attributes to associate with the phone switch request

intercom: CreateTagHeaders

Represents the Headers record for the operation: createTag

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: CreateTicketHeaders

Represents the Headers record for the operation: createTicket

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: CreateTicketRequest

You can create a Ticket

Fields

ticketTypeId? string - The ID of the type of ticket you want to create

companyId? string - The ID of the company that the ticket is associated with. The unique identifier for the company which is given by Intercom

assignment? CreateTicketRequestAssignment - Assignment configuration for creating tickets with admin or team assignees

createdAt? int - The time the ticket was created. If not provided, the current time will be used

ticketAttributes? TicketRequestCustomAttributes - Custom attributes to be applied to the ticket

contacts CreateTicketRequestContacts[] - The list of contacts (users or leads) affected by this ticket. Currently only one is allowed

conversationToLinkId? string - The ID of the conversation you want to link to the ticket. Here are the valid ways of linking two tickets:
- conversation | back-office ticket
- customer tickets | non-shared back-office ticket
- conversation | tracker ticket
- customer ticket | tracker ticket

intercom: CreateTicketRequestAssignment

Assignment configuration for creating tickets with admin or team assignees

Fields

adminAssigneeId? string - The ID of the admin to which the ticket is assigned. If not provided, the ticket will be unassigned

teamAssigneeId? string - The ID of the team to which the ticket is assigned. If not provided, the ticket will be unassigned

intercom: CreateTicketTypeAttributeHeaders

Represents the Headers record for the operation: createTicketTypeAttribute

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: CreateTicketTypeAttributeRequest

You can create a Ticket Type Attribute

Fields

visibleToContacts boolean(default true) - Whether the attribute is visible to contacts when creating a ticket in Messenger

allowMultipleValues? boolean - Whether the attribute allows multiple files to be attached to it (only applicable to file attributes)

multiline? boolean - Whether the attribute allows multiple lines of text (only applicable to string attributes)

name string - The name of the ticket type attribute

dataType "string"|"list"|"integer"|"decimal"|"boolean"|"datetime"|"files" - The data type of the attribute

requiredToCreateForContacts boolean(default false) - Whether the attribute is required to be filled in when contacts are creating the ticket in Messenger

description string - The description of the attribute presented to the teammate or contact

requiredToCreate boolean(default false) - Whether the attribute is required to be filled in when teammates are creating the ticket in Inbox

visibleOnCreate boolean(default true) - Whether the attribute is visible to teammates when creating a ticket in Inbox

listItems? string - A comma delimited list of items for the attribute value (only applicable to list attributes)

intercom: CreateTicketTypeHeaders

Represents the Headers record for the operation: createTicketType

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: CreateTicketTypeRequest

The request payload for creating a ticket type. You can copy the icon property for your ticket type from Twemoji Cheatsheet

Fields

isInternal boolean(default false) - Whether the tickets associated with this ticket type are intended for internal use only or will be shared with customers. This is currently a limited attribute

name string - The name of the ticket type

icon string(default "🎟️") - The icon of the ticket type

description? string - The description of the ticket type

category? "Customer"|"Back-office"|"Tracker" - Category of the Ticket Type

intercom: CursorPages

Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed

Fields

next? StartingAfterPaging? - Cursor-based pagination configuration for result navigation

perPage? int|string - Number of results per page

page? int - The current page

totalPages? int - Total number of pages

'type? "pages" - the type of object pages

intercom: CustomActionFinished

Contains details about final status of the completed action for conversation part type custom_action_finished

Fields

action? CustomActionFinishedAction - Schema for completed custom action results with status and name details

intercom: CustomActionFinishedAction

Schema for completed custom action results with status and name details

Fields

result? "success"|"failed" - Status of the action

name? string - Name of the action

intercom: CustomActionStarted

Contains details about name of the action that was initiated for conversation part type custom_action_started

Fields

action? CustomActionStartedAction - Information about a custom action that has been initiated

intercom: CustomActionStartedAction

Information about a custom action that has been initiated

Fields

name? string - Name of the action

intercom: CustomAttributes

An object containing the different custom attributes associated to the conversation as key-value pairs. For relationship attributes the value will be a list of custom object instance models

intercom: CustomChannelAttribute

Custom channel attribute with identifier and user-provided value

Fields

id string - Identifier for the attribute being collected

value string - Value provided by the user for the attribute

intercom: CustomChannelBaseEvent

Base event structure for custom channel interactions

Fields

eventId string - Unique identifier for the event

contact CustomChannelContact - Simplified contact object for custom channel integrations

externalConversationId string - Identifier for the conversation in your application

intercom: CustomChannelContact

Simplified contact object for custom channel integrations

Fields

name? string - Name of the contact. Required for user type

externalId string - External identifier for the contact. Intercom will take care of the mapping of your external_id with our internal ones so you don't have to worry about it

'type "user"|"lead" - Type of contact, must be "user" or "lead"

email? string - Email address of the contact. Required for user type

intercom: CustomChannelEventsNotifyAttributeCollectedBody

Event notification body for custom channel attribute collection

Fields

Fields Included from *CustomChannelBaseEvent

eventId string
contact CustomChannelContact
externalConversationId string
anydata...

attribute CustomChannelAttribute - Custom channel attribute with identifier and user-provided value

intercom: CustomChannelEventsNotifyNewMessageBody

Event notification for new message in custom channel

Fields

Fields Included from *CustomChannelBaseEvent

eventId string
contact CustomChannelContact
externalConversationId string
anydata...

body string - The message content sent by the user

intercom: CustomChannelEventsNotifyQuickReplySelectedBody

Event data for quick reply option selection in custom channels

Fields

Fields Included from *CustomChannelBaseEvent

eventId string
contact CustomChannelContact
externalConversationId string
anydata...

quickReplyOptionId string - Id of the selected quick reply option

intercom: CustomChannelNotificationResponse

Response containing mapped IDs for custom channel notifications

Fields

externalContactId string - The external contact ID provided in the notification request

conversationId string - The Intercom conversation ID mapped to the external conversation ID

externalConversationId string - The external conversation ID provided in the notification request

contactId string - The Intercom contact ID mapped to the external contact ID

intercom: CustomObjectInstance

A Custom Object Instance represents an instance of a custom object type. This allows you to create and set custom attributes to store data about your customers that is not already captured by Intercom. The parent object includes recommended default attributes and you can add your own custom attributes

Fields

externalUpdatedAt? int? - The time when the Custom Object instance was last updated in the external system it originated from

externalCreatedAt? int? - The time when the Custom Object instance was created in the external system it originated from

updatedAt? int - The time the attribute was last updated as a UTC Unix timestamp

createdAt? int - The time the attribute was created as a UTC Unix timestamp

externalId? string - The id you have defined for the custom object instance

id? string - The Intercom defined id representing the custom object instance

'type? string - The identifier of the custom object type that defines the structure of the custom object instance

customAttributes? record { string... } - The custom attributes you have set on the custom object instance

intercom: CustomObjectInstanceDeleted

deleted custom object instance object

Fields

deleted? boolean - Whether the Custom Object instance is deleted or not

id? string - The Intercom defined id representing the Custom Object instance

'object? string - The unique identifier of the Custom Object type that defines the structure of the Custom Object instance

intercom: DataAttribute

Data Attributes are metadata used to describe your contact, company and conversation models. These include standard and custom attributes. By using the data attributes endpoint, you can get the global list of attributes for your workspace, as well as create and archive custom attributes

Fields

custom? boolean - Set to true if this is a CDA

description? string - Readable description of the attribute

createdAt? int - The time the attribute was created as a UTC Unix timestamp

label? string - Readable name of the attribute (i.e. name you see in the UI)

'type? "data_attribute" - Value is data_attribute

messengerWritable? boolean - Can this attribute be updated by the Messenger

archived? boolean - Is this attribute archived. (Only applicable to CDAs)

uiWritable? boolean - Can this attribute be updated in the UI

fullName? string - Full name of the attribute. Should match the name unless it's a nested attribute. We can split full_name on . to access nested user object values

apiWritable? boolean - Can this attribute be updated through API

updatedAt? int - The time the attribute was last updated as a UTC Unix timestamp

adminId? string - Teammate who created the attribute. Only applicable to CDAs

name? string - Name of the attribute

dataType? "string"|"integer"|"float"|"boolean"|"date" - The data type of the attribute

options? string[] - List of predefined options for attribute value

model? "contact"|"company" - Value is contact for user/lead attributes and company for company attributes

id? int - The unique identifier for the data attribute which is given by Intercom. Only available for custom attributes

intercom: DataAttributeList

A list of all data attributes belonging to a workspace for contacts, companies or conversations

Fields

data? DataAttribute[] - A list of data attributes

'type? "list" - The type of the object

intercom: DataEventSummariesHeaders

Represents the Headers record for the operation: dataEventSummaries

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: DataEventSummary

This will return a summary of data events for the App

Fields

userId? string - The user ID of the user

intercomUserId? string - The Intercom user ID of the user

'type? "event.summary" - The type of the object

email? string - The email address of the user

events? DataEventSummaryItem[] - A summary of data events

intercom: DataEventSummaryItem

This will return a summary of a data event for the App

Fields

last? string - The last time the event was sent

name? string - The name of the event

count? int - The number of times the event was sent

description? string - The description of the event

first? string - The first time the event was sent

intercom: DataExport

The data export api is used to view all message sent & viewed in a given timeframe

Fields

jobIdentifier? string - The identifier for your job

downloadExpiresAt? string - The time after which you will not be able to access the data

downloadUrl? string - The location where you can download your data

status? "pending"|"in_progress"|"failed"|"completed"|"no_data"|"canceled" - The current state of your job

intercom: DataExportStatus

Status information for a data export job including download details

Fields

jobIdentifier? string - Unique identifier for the data export job

downloadExpiresAt? string - Timestamp when the download URL expires

downloadUrl? string - URL to download the exported data file

status? string - Current status of the data export job

intercom: DatasetAttribute

Represents a dataset attribute with name and identifier properties

Fields

name? string - Human-readable name of the dataset attribute

id? string - Unique identifier for the dataset attribute

intercom: DatasetDetails

Schema containing detailed information about a dataset

Fields

defaultTimeAttributeId? string - Default time attribute identifier for the dataset

name? string - The name of the dataset

description? string - A detailed description of the dataset's contents and purpose

attributes? DatasetAttribute[] - Array of attributes contained within the dataset

id? string - Unique identifier for the dataset

intercom: DatasetListResponse

Response containing a list of dataset details

Fields

data? DatasetDetails[] - Array of dataset detail objects

'type? string - Response type identifier

intercom: DeleteArticleHeaders

Represents the Headers record for the operation: deleteArticle

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: DeleteCollectionHeaders

Represents the Headers record for the operation: deleteCollection

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: DeleteCompanyHeaders

Represents the Headers record for the operation: deleteCompany

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: DeleteContactHeaders

Represents the Headers record for the operation: DeleteContact

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: DeleteContentImportSourceHeaders

Represents the Headers record for the operation: deleteContentImportSource

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: DeleteConversationHeaders

Represents the Headers record for the operation: deleteConversation

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: DeleteCustomObjectInstancesByExternalIdHeaders

Represents the Headers record for the operation: deleteCustomObjectInstancesByExternalId

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: DeleteCustomObjectInstancesByIdHeaders

Represents the Headers record for the operation: deleteCustomObjectInstancesById

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: DeleteCustomObjectInstancesByIdQueries

Represents the Queries record for the operation: deleteCustomObjectInstancesById

Fields

externalId record { external_id string } - The unique identifier for the instance in the external system it originated from.

intercom: DeletedArticleObject

Response returned when an object is deleted

Fields

deleted? boolean - Whether the article was deleted successfully or not

id? string - The unique identifier for the article which you provided in the URL

'object? "article" - The type of object which was deleted. - article

intercom: DeletedCollectionObject

Response returned when an object is deleted

Fields

deleted? boolean - Whether the collection was deleted successfully or not

id? string - The unique identifier for the collection which you provided in the URL

'object? "collection" - The type of object which was deleted. - collection

intercom: DeletedCompanyObject

Response returned when an object is deleted

Fields

deleted? boolean - Whether the company was deleted successfully or not

id? string - The unique identifier for the company which is given by Intercom

'object? "company" - The type of object which was deleted. - company

intercom: DeletedInternalArticleObject

Response returned when an object is deleted

Fields

deleted? boolean - Whether the internal article was deleted successfully or not

id? string - The unique identifier for the internal article which you provided in the URL

'object? "internal_article" - The type of object which was deleted. - internal_article

intercom: DeletedObject

Response returned when an object is deleted

Fields

deleted? boolean - Whether the news item was deleted successfully or not

id? string - The unique identifier for the news item which you provided in the URL

'object? "news-item" - The type of object which was deleted - news-item

intercom: DeleteExternalPageHeaders

Represents the Headers record for the operation: deleteExternalPage

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: DeleteInternalArticleHeaders

Represents the Headers record for the operation: deleteInternalArticle

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: DeleteNewsItemHeaders

Represents the Headers record for the operation: deleteNewsItem

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: DeleteTagHeaders

Represents the Headers record for the operation: deleteTag

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: DeleteTicketHeaders

Represents the Headers record for the operation: deleteTicket

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: DetachContactFromACompanyHeaders

Represents the Headers record for the operation: detachContactFromACompany

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: DetachContactFromConversationHeaders

Represents the Headers record for the operation: detachContactFromConversation

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: DetachContactFromConversationRequest

Request to detach a contact from a conversation

Fields

admin_id string - The id of the admin who is performing the action.

intercom: DetachSubscriptionTypeToContactHeaders

Represents the Headers record for the operation: detachSubscriptionTypeToContact

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: DetachTagFromContactHeaders

Represents the Headers record for the operation: detachTagFromContact

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: DetachTagFromConversationHeaders

Represents the Headers record for the operation: detachTagFromConversation

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: DetachTagFromTicketHeaders

Represents the Headers record for the operation: detachTagFromTicket

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: DownloadDataExportHeaders

Represents the Headers record for the operation: downloadDataExport

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: DownloadReportingDataExportHeaders

Represents the Headers record for the operation: downloadReportingDataExport

Fields

accept "application/octet-stream" - Required header for downloading the export file

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: DownloadReportingDataExportQueries

Represents the Queries record for the operation: downloadReportingDataExport

Fields

appId string -

intercom: Email

Email address for contact identification and participant addition

Fields

email string - The email you have defined for the contact who is being added as a participant. If a contact with this email does not exist, one will be created.

intercom: Email1

Email schema containing the contact's email address

Fields

email string - The email you have defined for the contact who is being added as a participant.

intercom: EmailAddressHeader

Contains data for an email address header for a conversation part that was sent as an email

Fields

emailAddress? string - The email address

name? string? - The name associated with the email address

'type? string - The type of email address header

intercom: EmailList

A list of email settings

Fields

data? EmailSetting[] - Array of email settings in the list

'type? string - The type of object

intercom: EmailMessageMetadata

Contains metadata if the message was sent as an email

Fields

subject? string - The subject of the email

emailAddressHeaders? EmailAddressHeader[] - A list of an email address headers

messageId? string? - The unique identifier for the email message as specified in the Message-ID header

intercom: EmailQueryParameter

Closed record

Query parameter object containing an email address

Fields

email string - The email address used for querying

intercom: EmailSetting

Represents a sender email address configuration

Fields

updatedAt? int - Unix timestamp of last modification

forwardedEmailLastReceivedAt? int? - Unix timestamp of last forwarded email received (null if never)

domain? string - Domain portion of the email address

verified? boolean - Whether the email address has been verified

createdAt? int - Unix timestamp of creation

forwardingEnabled? boolean - Whether email forwarding is active

id? string - Unique email setting identifier

'type? string - The type of object

email? string - Full sender email address

brandId? string - Associated brand identifier

intercom: EnqueueCreateTicketHeaders

Represents the Headers record for the operation: enqueueCreateTicket

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: EnqueueReportingDataExportHeaders

Represents the Headers record for the operation: enqueueReportingDataExport

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: ExportWorkflowHeaders

Represents the Headers record for the operation: exportWorkflow

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: ExternalID

External identifier for referencing contacts

Fields

external_id string - The external_id you have defined for the contact who is being added as a participant.

intercom: ExternalPage

External pages that you have added to your Fin Content Library

Fields

createdAt int - The time when the external page was created

externalId string - The identifier for the external page which was given by the source. Must be unique for the source

'type "external_page" (default "external_page") - Always external_page

title string - The title of the external page

locale "en" (default "en") - Always en

url? string - The URL of the external page. This will be used by Fin to link end users to the page it based its answer on

updatedAt int - The time when the external page was last updated

finAvailability? boolean - Deprecated. Use ai_agent_availability and ai_copilot_availability instead

lastIngestedAt int - The time when the external page was last ingested

html string - The body of the external page in HTML

id string - The unique identifier for the external page which is given by Intercom

sourceId int - The unique identifier for the source of the external page which was given by Intercom. Every external page must be associated with a Content Import Source which represents the place it comes from and from which it inherits a default audience (configured in the UI). For a new source, make a POST request to the Content Import Source endpoint and an ID for the source will be returned in the response

aiCopilotAvailability boolean - Whether the external page should be used to answer questions by AI Copilot

aiAgentAvailability boolean - Whether the external page should be used to answer questions by AI Agent

intercom: ExternalPagesList

This will return a list of external pages for the App

Fields

pages? PagesLink - The majority of list resources in the API are paginated to allow clients to traverse data over multiple requests. Their responses are likely to contain a pages object that hosts pagination links which a client can use to paginate through the data without having to construct a query. The link relations for the pages field are as follows

data? ExternalPage[] - An array of External Page objects

totalCount? int - A count of the total number of external pages

'type? "list" - The type of the object - list

intercom: FindTagHeaders

Represents the Headers record for the operation: findTag

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: GetContentImportSourceHeaders

Represents the Headers record for the operation: getContentImportSource

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: GetCustomObjectInstancesByExternalIdHeaders

Represents the Headers record for the operation: getCustomObjectInstancesByExternalId

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: GetCustomObjectInstancesByExternalIdQueries

Represents the Queries record for the operation: getCustomObjectInstancesByExternalId

Fields

externalId record { external_id string } - The unique identifier for the instance in the external system it originated from.

intercom: GetCustomObjectInstancesByIdHeaders

Represents the Headers record for the operation: getCustomObjectInstancesById

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: GetDataExportHeaders

Represents the Headers record for the operation: getDataExport

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: GetExternalPageHeaders

Represents the Headers record for the operation: getExternalPage

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: GetIpAllowlistHeaders

Represents the Headers record for the operation: getIpAllowlist

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: GetReportingDataExportStatusHeaders

Represents the Headers record for the operation: getReportingDataExportStatus

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: GetReportingDataExportStatusQueries

Represents the Queries record for the operation: getReportingDataExportStatus

Fields

appId string - The Intercom defined code of the workspace the company is associated to

clientId string -

intercom: GetTicketHeaders

Represents the Headers record for the operation: getTicket

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: GetTicketTypeHeaders

Represents the Headers record for the operation: getTicketType

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: GroupContent

The Content of a Group

Fields

name? string - The name of the collection or section

description? string - The description of the collection. Only available for collections

'type? "group_content"? - The type of object - group_content

intercom: GroupTranslatedContent

The Translated Content of an Group. The keys are the locale codes and the values are the translated content of the Group

Fields

de? GroupContent? - The Content of a Group

fi? GroupContent? - The Content of a Group

ru? GroupContent? - The Content of a Group

pt? GroupContent? - The Content of a Group

bg? GroupContent? - The Content of a Group

lt? GroupContent? - The Content of a Group

hr? GroupContent? - The Content of a Group

lv? GroupContent? - The Content of a Group

'type? "group_translated_content"? - The type of object - group_translated_content

fr? GroupContent? - The Content of a Group

hu? GroupContent? - The Content of a Group

zhCN? GroupContent? - Chinese (Simplified) language content for the group

bs? GroupContent? - The Content of a Group

sl? GroupContent? - The Content of a Group

id? GroupContent? - The Content of a Group

ca? GroupContent? - The Content of a Group

sr? GroupContent? - The Content of a Group

mn? GroupContent? - The Content of a Group

sv? GroupContent? - The Content of a Group

ko? GroupContent? - The Content of a Group

zhTW? GroupContent? - Group content in Traditional Chinese language

ptBR? GroupContent? - Group content in Brazilian Portuguese language

el? GroupContent? - The Content of a Group

en? GroupContent? - The Content of a Group

it? GroupContent? - The Content of a Group

es? GroupContent? - The Content of a Group

et? GroupContent? - The Content of a Group

cs? GroupContent? - The Content of a Group

ar? GroupContent? - The Content of a Group

vi? GroupContent? - The Content of a Group

nb? GroupContent? - The Content of a Group

ja? GroupContent? - The Content of a Group

pl? GroupContent? - The Content of a Group

da? GroupContent? - The Content of a Group

he? GroupContent? - The Content of a Group

ro? GroupContent? - The Content of a Group

nl? GroupContent? - The Content of a Group

tr? GroupContent? - The Content of a Group

intercom: HelpCenter

Help Centers contain collections

Fields

workspaceId? string - The id of the workspace which the Help Center belongs to

identifier? string - The identifier of the Help Center. This is used in the URL of the Help Center

updatedAt? int - The time when the Help Center was last updated

createdAt? int - The time when the Help Center was created

id? string - The unique identifier for the Help Center which is given by Intercom

displayName? string - The display name of the Help Center only seen by teammates

customDomain? string? - Custom domain configured for the help center

websiteTurnedOn? boolean - Whether the Help Center is turned on or not. This is controlled in your Help Center settings

url? string - The URL for the help center, if you have a custom domain then this will show the URL using the custom domain

intercom: HelpCenterList

A list of Help Centers belonging to the App

Fields

data? HelpCenter[] - An array of Help Center objects

'type? "list" - The type of the object - list

intercom: ID

Identifier object containing the Intercom-generated contact ID

Fields

id string - The identifier for the contact as given by Intercom.

intercom: IdentifyAdminHeaders

Represents the Headers record for the operation: identifyAdmin

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: IntercomUserID

Schema containing the unique Intercom contact identifier

Fields

intercom_user_id string - The identifier for the contact as given by Intercom.

intercom: IntercomUserIdQueryParameter

Closed record

Query parameter containing the Intercom user identifier

Fields

intercomUserId string - The unique identifier for the Intercom user

intercom: InternalArticleList

This will return a list of internal articles for the App

Fields

pages? CursorPages? - Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed

data? InternalArticleListItem[] - An array of Internal Article objects

totalCount? int - A count of the total number of internal articles

'type? "list" - The type of the object - list

intercom: InternalArticleListItem

The data returned about your internal articles when you list them

Fields

updatedAt? int - The time when the article was last updated

ownerId? int - The id of the owner of the article

createdAt? int - The time when the article was created

id? string - The unique identifier for the article which is given by Intercom

'type "internal_article" (default "internal_article") - The type of object - internal_article

title? string - The title of the article

body? string? - The body of the article in HTML

authorId? int - The id of the author of the article

locale? string - The default locale of the article

intercom: InternalArticleSearchResponse

The results of an Internal Article search

Fields

pages? CursorPages? - Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed

data? InternalArticleSearchResponseData - An object containing the results of the search

totalCount? int - The total number of Internal Articles matching the search query

'type? "list" - The type of the object - list

intercom: InternalArticleSearchResponseData

An object containing the results of the search

Fields

internalArticles? InternalArticle[] - An array of Internal Article objects

intercom: IpAllowlist

IP allowlist settings for the workspace

Fields

'type? string - String representing the object's type. Always has the value ip_allowlist

ipAllowlist? string[] - List of allowed IP addresses and/or IP ranges in CIDR notation. Examples:
- Single IP: 192.168.0.1
- IP range: 192.168.0.1/24 (allows 192.168.0.0 - 192.168.0.255)

enabled? boolean - Whether the IP allowlist is enabled for the workspace

intercom: Jobs

Jobs are tasks that are processed asynchronously by the Intercom system after being enqueued via the API. This allows for efficient handling of operations that may take time to complete, such as data imports or exports. You can check the status of your jobs to monitor their progress and ensure they are completed successfully

Fields

resourceUrl? string? - The url of the resource created during job exeuction. Use this url to fetch the resource

resourceType? string - The type of resource created during job execution

resourceId? string? - The id of the resource created during job execution (e.g. ticket id)

id string - The id of the job that's currently being processed or has completed

'type? "job" - The type of the object

url? string - API endpoint URL to check the job status

status? "pending"|"success"|"failed" - The status of the job execution

intercom: JobsStatusHeaders

Represents the Headers record for the operation: jobsStatus

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: LinkedObject

A linked conversation or ticket

Fields

id? string - The ID of the linked object

'type? "ticket"|"conversation" - ticket or conversation

category? "Customer"|"Back-office"|"Tracker"? - Category of the Linked Ticket Object

intercom: LinkedObjectList

An object containing metadata about linked conversations and linked tickets. Up to 1000 can be returned

Fields

data? LinkedObject[] - An array containing the linked conversations and linked tickets

totalCount? int - The total number of linked objects

hasMore? boolean - Whether or not there are more linked objects than returned

'type? "list" - Always list

intercom: LisDataAttributesHeaders

Represents the Headers record for the operation: lisDataAttributes

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: LisDataAttributesQueries

Represents the Queries record for the operation: lisDataAttributes

Fields

includeArchived? boolean - Include archived attributes in the list. By default we return only non archived data attributes

model? "contact"|"company"|"conversation" - Specify the data attribute model to return

intercom: LisDataEventsHeaders

Represents the Headers record for the operation: lisDataEvents

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: LisDataEventsQueries

Represents the Queries record for the operation: lisDataEvents

Fields

filter Filter - User filtering criteria using ID, Intercom ID, or email

summary? boolean - summary flag

'type string - The value must be user

intercom: ListActivityLogsHeaders

Represents the Headers record for the operation: listActivityLogs

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: ListActivityLogsQueries

Represents the Queries record for the operation: listActivityLogs

Fields

createdAtBefore? string - The end date that you request data for. It must be formatted as a UNIX timestamp

createdAtAfter string - The start date that you request data for. It must be formatted as a UNIX timestamp

intercom: ListAdminsHeaders

Represents the Headers record for the operation: listAdmins

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: ListAllCollectionsHeaders

Represents the Headers record for the operation: listAllCollections

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: ListAllCompaniesHeaders

Represents the Headers record for the operation: listAllCompanies

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: ListAllCompaniesQueries

Represents the Queries record for the operation: listAllCompanies

Fields

perPage? int - How many results to return per page. Defaults to 15

page? int - The page of results to fetch. Defaults to first page

'order? string - asc or desc. Return the companies in ascending or descending order. Defaults to desc

intercom: ListArticlesHeaders

Represents the Headers record for the operation: listArticles

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: ListAttachedContactsHeaders

Represents the Headers record for the operation: ListAttachedContacts

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: ListAttachedSegmentsForCompaniesHeaders

Represents the Headers record for the operation: ListAttachedSegmentsForCompanies

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: ListAwayStatusReasonsHeaders

Represents the Headers record for the operation: listAwayStatusReasons

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: ListBrandsHeaders

Represents the Headers record for the operation: listBrands

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: ListCallsHeaders

Represents the Headers record for the operation: listCalls

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: ListCallsQueries

Represents the Queries record for the operation: listCalls

Fields

perPage? int - How many results to display per page. Defaults to 25. Max 25

page? int - The page of results to fetch. Defaults to first page

intercom: ListCallsWithTranscriptsHeaders

Represents the Headers record for the operation: listCallsWithTranscripts

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: ListCompaniesForAContactHeaders

Represents the Headers record for the operation: listCompaniesForAContact

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: ListCompanyNotesHeaders

Represents the Headers record for the operation: listCompanyNotes

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: ListContactsHeaders

Represents the Headers record for the operation: ListContacts

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: ListContentImportSourcesHeaders

Represents the Headers record for the operation: listContentImportSources

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: ListConversationsHeaders

Represents the Headers record for the operation: listConversations

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: ListConversationsQueries

Represents the Queries record for the operation: listConversations

Fields

perPage int(default 20) - How many results per page

startingAfter? string - String used to get the next page of conversations

intercom: ListEmailsHeaders

Represents the Headers record for the operation: listEmails

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: ListExternalPagesHeaders

Represents the Headers record for the operation: listExternalPages

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: ListHelpCentersHeaders

Represents the Headers record for the operation: listHelpCenters

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: ListInternalArticlesHeaders

Represents the Headers record for the operation: listInternalArticles

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: ListLiveNewsfeedItemsHeaders

Represents the Headers record for the operation: listLiveNewsfeedItems

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: ListNewsfeedsHeaders

Represents the Headers record for the operation: listNewsfeeds

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: ListNewsItemsHeaders

Represents the Headers record for the operation: listNewsItems

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: ListNotesHeaders

Represents the Headers record for the operation: listNotes

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: ListReportingDatasetsHeaders

Represents the Headers record for the operation: listReportingDatasets

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: ListSegmentsForAContactHeaders

Represents the Headers record for the operation: listSegmentsForAContact

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: ListSegmentsHeaders

Represents the Headers record for the operation: listSegments

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: ListSegmentsQueries

Represents the Queries record for the operation: listSegments

Fields

includeCount? boolean - It includes the count of contacts that belong to each segment

intercom: ListSubscriptionsForAContactHeaders

Represents the Headers record for the operation: listSubscriptionsForAContact

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: ListSubscriptionTypesHeaders

Represents the Headers record for the operation: listSubscriptionTypes

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: ListTagsForAContactHeaders

Represents the Headers record for the operation: listTagsForAContact

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: ListTagsHeaders

Represents the Headers record for the operation: listTags

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: ListTeamsHeaders

Represents the Headers record for the operation: listTeams

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: ListTicketStatesHeaders

Represents the Headers record for the operation: listTicketStates

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: ListTicketTypesHeaders

Represents the Headers record for the operation: listTicketTypes

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: ManageConversationHeaders

Represents the Headers record for the operation: manageConversation

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: MergeContactHeaders

Represents the Headers record for the operation: MergeContact

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: MergeContactsRequest

Merge contact data

Fields

into? string - The unique identifier for the contact to merge into. Must be a user

'from? string - The unique identifier for the contact to merge away from. Must be a lead

intercom: Message

Message are how you reach out to contacts in Intercom. They are created when an admin sends an outbound message to a contact

Fields

subject? string - The subject of the message. Only present if message_type: email

conversationId? string - The associated conversation_id

createdAt? int - The time the conversation was created

messageType? "email"|"inapp"|"facebook"|"twitter" - The type of message that was sent. Can be email, inapp, facebook or twitter

id string - The id representing the message

'type string - The type of the message

body string - The message body, which may contain HTML

intercom: MultipleFilterSearchRequest

Search using Intercoms Search APIs with more than one filter

Fields

value? MultipleFilterSearchRequest[]|SingleFilterSearchRequest[] - Filter values supporting multiple or single filter configurations

operator? "AND"|"OR" - An operator to allow boolean inspection between multiple fields

intercom: Newsfeed

A newsfeed is a collection of news items, targeted to a specific audience.

Newsfeeds currently cannot be edited through the API, please refer to this article to set up your newsfeeds in Intercom

Fields

updatedAt? int - Timestamp for when the newsfeed was last updated

name? string - The name of the newsfeed. This name will never be visible to your users

createdAt? int - Timestamp for when the newsfeed was created

id? string - The unique identifier for the newsfeed which is given by Intercom

'type? "newsfeed" - The type of object

intercom: NewsfeedAssignment

Assigns a news item to a newsfeed

Fields

newsfeedId? int - The unique identifier for the newsfeed which is given by Intercom. Publish dates cannot be in the future, to schedule news items use the dedicated feature in app (see this article)

publishedAt? int - Publish date of the news item on the newsfeed, use this field if you want to set a publish date in the past (e.g. when importing existing news items). On write, this field will be ignored if the news item state is "draft"

intercom: NewsItem

A News Item is a content type in Intercom enabling you to announce product updates, company news, promotions, events and more with your customers

Fields

coverImageUrl? string? - URL of the image used as cover. Must have .jpg or .png extension

deliverSilently? boolean - When set to true, the news item will appear in the messenger newsfeed without showing a notification badge

newsfeedAssignments? NewsfeedAssignment[] - A list of newsfeed_assignments to assign to the specified newsfeed

createdAt? int - Timestamp for when the news item was created

'type? "news-item" - The type of object

title? string - The title of the news item

body? string - The news item body, which may contain HTML

senderId? int - The id of the sender of the news item. Must be a teammate on the workspace

labels? string[] - Label names displayed to users to categorize the news item

workspaceId? string - The id of the workspace which the news item belongs to

updatedAt? int - Timestamp for when the news item was last updated

reactions? string[] - Ordered list of emoji reactions to the news item. When empty, reactions are disabled

id? string - The unique identifier for the news item which is given by Intercom

state? "draft"|"live" - News items will not be visible to your users in the assigned newsfeeds until they are set live

intercom: NewsItemRequest

A News Item is a content type in Intercom enabling you to announce product updates, company news, promotions, events and more with your customers

Fields

deliverSilently? boolean - When set to true, the news item will appear in the messenger newsfeed without showing a notification badge

newsfeedAssignments? NewsfeedAssignment[] - A list of newsfeed_assignments to assign to the specified newsfeed

reactions? string[] - Ordered list of emoji reactions to the news item. When empty, reactions are disabled

state? "draft"|"live" - News items will not be visible to your users in the assigned newsfeeds until they are set live

title string - The title of the news item

body? string - The news item body, which may contain HTML

senderId int - The id of the sender of the news item. Must be a teammate on the workspace

labels? string[] - Label names displayed to users to categorize the news item

intercom: Note

Notes allow you to annotate and comment on your contacts

Fields

author? Admin? - Admins are teammate accounts that have access to a workspace

contact? NoteContact? - Represents the contact that the note was created about

createdAt? int - The time the note was created

id? string - The id of the note

'type? string - String representing the object's type. Always has the value note

body? string - The body text of the note

intercom: NoteContact

Represents the contact that the note was created about

Fields

id? string - The id of the contact

'type? string - String representing the object's type. Always has the value contact

intercom: NoteList

A paginated list of notes associated with a contact

Fields

pages? CursorPages? - Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed

data? Note[] - An array of notes

totalCount? int - A count of the total number of notes

'type? string - String representing the object's type. Always has the value list

intercom: NotifyAttributeCollectedHeaders

Represents the Headers record for the operation: notifyAttributeCollected

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercom: NotifyNewConversationHeaders

Represents the Headers record for the operation: notifyNewConversation

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercom: NotifyNewMessageHeaders

Represents the Headers record for the operation: notifyNewMessage

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercom: NotifyQuickReplySelectedHeaders

Represents the Headers record for the operation: notifyQuickReplySelected

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercom: OpenConversationRequest

Payload of the request to open a conversation

Fields

adminId string - The id of the admin who is performing the action

messageType "open" - The message type for opening a conversation (always 'open')

intercom: OperatorWorkflowEvent

Contains details about name of the workflow for conversation part type operator_workflow_event

Fields

workflow? OperatorWorkflowEventWorkflow - Workflow details for operator workflow events

event? OperatorWorkflowEventEvent - Workflow event details triggered by an operator action

intercom: OperatorWorkflowEventEvent

Workflow event details triggered by an operator action

Fields

result? string - Result of the workflow event

'type? string - Type of the workflow event initiated

intercom: OperatorWorkflowEventWorkflow

Workflow details for operator workflow events

Fields

name? string - The name of the workflow

intercom: PagesLink

The majority of list resources in the API are paginated to allow clients to traverse data over multiple requests.

Their responses are likely to contain a pages object that hosts pagination links which a client can use to paginate through the data without having to construct a query. The link relations for the pages field are as follows

Fields

next? string? - A link to the next page of results. A response that does not contain a next link does not have further data to fetch

perPage? int - Number of items displayed per page

page? int - Current page number in pagination sequence

totalPages? int - Total number of available pages

'type? "pages" - Pagination type identifier

intercom: PaginatedResponse

Paginated Response

Fields

pages? CursorPages? - Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed

data? PaginatedResponseData[] - An array of Objects

totalCount? int - A count of the total number of objects

'type? "list"|"conversation.list" - The type of object

intercom: PartAttachment

The file attached to a part

Fields

contentType? string - The content type of the attachment

name? string - The name of the attachment

width? int - The width of the attachment

filesize? int - The size of the attachment

'type? string - The type of attachment

url? string - The URL of the attachment

height? int - The height of the attachment

intercom: PhoneSwitch

Phone Switch Response

Fields

phone? string - Phone number in E.164 format, that has received the SMS to continue the conversation in the Messenger

'type "phone_call_redirect" (default "phone_call_redirect") -

intercom: QuickReplyOption

Quick reply button option with display text and unique identifier

Fields

text string - The text to display in this quick reply option

uuid string - A unique identifier for this quick reply option. This value will be available within the metadata of the comment conversation part that is created when a user clicks on this reply option

intercom: QuickReplyOption1

Quick reply option with text and unique identifier

Fields

text string - The text to display in this quick reply option

uuid string - A unique identifier for this quick reply option. This value will be available within the metadata of the comment ticket part that is created when a user clicks on this reply option

intercom: RedactConversationHeaders

Represents the Headers record for the operation: redactConversation

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: RedactConversationPartRequest

Payload of the request to redact a conversation part

Fields

conversationId string - The id of the conversation

conversationPartId string - The id of the conversation_part

'type "conversation_part" - The type of resource being redacted

intercom: RedactConversationSourceRequest

Payload of the request to redact a conversation source

Fields

conversationId string - The id of the conversation

sourceId string - The id of the source

'type "source" - The type of resource being redacted

intercom: Reference

reference to another object

Fields

id? string? -

'type? string -

intercom: RegisterFinVoiceCallHeaders

Represents the Headers record for the operation: registerFinVoiceCall

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercom: RegisterFinVoiceCallRequest

Fields

data? record {}? - Additional metadata about the call

phoneNumber string - Phone number in E.164 format for the call

'source? "five9"|"zoom_phone"|"aws_connect" - Source of the call. Can be "five9", "zoom_phone", or defaults to "aws_connect"

callId string - External call identifier from the call provider

intercom: ReplyConversationHeaders

Represents the Headers record for the operation: replyConversation

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: ReplyTicketHeaders

Represents the Headers record for the operation: replyTicket

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: ReportingDataEnqueueBody

Request body for enqueuing reporting data extraction jobs

Fields

attributeIds string[] - Array of attribute identifiers to include in the report dataset

startTime int - Unix timestamp marking the beginning of the reporting time range

datasetId string - Identifier of the dataset to generate the report from

endTime int - Unix timestamp marking the end of the reporting time range

intercom: ReportingJobResponse

Response containing reporting job details and download information

Fields

jobIdentifier? string - Unique identifier for the reporting job

downloadExpiresAt? string - Timestamp when the download link expires

downloadUrl? string - URL to download the generated report

status? string - Current status of the reporting job

intercom: RetrieveACompanyByIdHeaders

Represents the Headers record for the operation: RetrieveACompanyById

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: RetrieveAdminHeaders

Represents the Headers record for the operation: retrieveAdmin

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: RetrieveArticleHeaders

Represents the Headers record for the operation: retrieveArticle

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: RetrieveBrandHeaders

Represents the Headers record for the operation: retrieveBrand

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: RetrieveCollectionHeaders

Represents the Headers record for the operation: retrieveCollection

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: RetrieveCompanyHeaders

Represents the Headers record for the operation: retrieveCompany

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: RetrieveCompanyQueries

Represents the Queries record for the operation: retrieveCompany

Fields

perPage? int - How many results to display per page. Defaults to 15

companyId? string - The company_id of the company to filter by

name? string - The name of the company to filter by

tagId? string - The tag_id of the company to filter by

page? int - The page of results to fetch. Defaults to first page

segmentId? string - The segment_id of the company to filter by

intercom: RetrieveConversationHeaders

Represents the Headers record for the operation: retrieveConversation

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: RetrieveConversationQueries

Represents the Queries record for the operation: retrieveConversation

Fields

displayAs? string - Set to plaintext to retrieve conversation messages in plain text

includeTranslations? boolean - If set to true, conversation parts will be translated to the detected language of the conversation

intercom: RetrieveEmailHeaders

Represents the Headers record for the operation: retrieveEmail

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: RetrieveHelpCenterHeaders

Represents the Headers record for the operation: retrieveHelpCenter

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: RetrieveInternalArticleHeaders

Represents the Headers record for the operation: retrieveInternalArticle

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: RetrieveNewsfeedHeaders

Represents the Headers record for the operation: retrieveNewsfeed

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: RetrieveNewsItemHeaders

Represents the Headers record for the operation: retrieveNewsItem

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: RetrieveNoteHeaders

Represents the Headers record for the operation: retrieveNote

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: RetrieveSegmentHeaders

Represents the Headers record for the operation: retrieveSegment

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: RetrieveTeamHeaders

Represents the Headers record for the operation: retrieveTeam

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: RetrieveVisitorWithUserIdHeaders

Represents the Headers record for the operation: retrieveVisitorWithUserId

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: RetrieveVisitorWithUserIdQueries

Represents the Queries record for the operation: retrieveVisitorWithUserId

Fields

userId string - The user_id of the Visitor you want to retrieve

intercom: ScrollOverAllCompaniesHeaders

Represents the Headers record for the operation: scrollOverAllCompanies

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: ScrollOverAllCompaniesQueries

Represents the Queries record for the operation: scrollOverAllCompanies

Fields

scrollParam? string -

intercom: SearchArticlesHeaders

Represents the Headers record for the operation: searchArticles

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: SearchArticlesQueries

Represents the Queries record for the operation: searchArticles

Fields

highlight? boolean - Return a highlighted version of the matching content within your articles. Refer to the response schema for more details

phrase? string - The phrase within your articles to search for

helpCenterId? int - The ID of the Help Center to search in

state? string - The state of the Articles returned. One of published, draft or all

intercom: SearchContactsHeaders

Represents the Headers record for the operation: SearchContacts

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: SearchConversationsHeaders

Represents the Headers record for the operation: searchConversations

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: SearchInternalArticlesHeaders

Represents the Headers record for the operation: searchInternalArticles

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: SearchInternalArticlesQueries

Represents the Queries record for the operation: searchInternalArticles

Fields

folderId? string - The ID of the folder to search in

intercom: SearchRequest

Search using Intercoms Search APIs

Fields

pagination? StartingAfterPaging? - Cursor-based pagination configuration for result navigation

query SingleFilterSearchRequest|MultipleFilterSearchRequest - Search query criteria supporting single or multiple filter conditions

intercom: SearchTicketsHeaders

Represents the Headers record for the operation: searchTickets

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: Segment

A segment is a group of your contacts defined by the rules that you set

Fields

updatedAt? int - The time the segment was updated

personType? "contact"|"user" - Type of the contact: contact (lead) or user

name? string - The name of the segment

count? int? - The number of items in the user segment. It's returned when include_count=true is included in the request

createdAt? int - The time the segment was created

id? string - The unique identifier representing the segment

'type? "segment" - The type of object

intercom: SegmentList

This will return a list of Segment Objects. The result may also have a pages object if the response is paginated

Fields

pages? record {} - A pagination object, which may be empty, indicating no further pages to fetch

'type? "segment.list" - The type of the object

segments? Segment[] - A list of Segment objects

intercom: SetAwayAdminHeaders

Represents the Headers record for the operation: setAwayAdmin

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: ShowCallHeaders

Represents the Headers record for the operation: showCall

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: ShowCallRecordingHeaders

Represents the Headers record for the operation: showCallRecording

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: ShowCallTranscriptHeaders

Represents the Headers record for the operation: showCallTranscript

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: ShowContactByExternalIdHeaders

Represents the Headers record for the operation: ShowContactByExternalId

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: ShowContactHeaders

Represents the Headers record for the operation: ShowContact

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: SingleFilterSearchRequest

Search using Intercoms Search APIs with a single filter

Fields

'field? string - The accepted field that you want to search on

value? string|int|(string|int)[]? - The value that you want to search on

operator? "="|"!="|"IN"|"NIN"|"<"|">"|"~"|"!~"|"^"|"$" - The accepted operators you can use to define how you want to search for the value

intercom: SlaApplied

The SLA Applied object contains the details for which SLA has been applied to this conversation. Important: if there are any canceled sla_events for the conversation - meaning an SLA has been manually removed from a conversation, the sla_status will always be returned as null

Fields

slaStatus? "hit"|"missed"|"cancelled"|"active" - SLA statuses:
- hit: If there’s at least one hit event in the underlying sla_events table, and no “missed” or “canceled” events for the conversation.
- missed: If there are any missed sla_events for the conversation and no canceled events. If there’s even a single missed sla event, the status will always be missed. A missed status is not applied when the SLA expires, only the next time a teammate replies.
- active: An SLA has been applied to a conversation, but has not yet been fulfilled. SLA status is active only if there are no “hit, “missed”, or “canceled” events

'type? string - object type

slaName? string - The name of the SLA as given by the teammate when it was created

intercom: SnoozeConversationRequest

Payload of the request to snooze a conversation

Fields

adminId string - The id of the admin who is performing the action

messageType "snoozed" - Message type identifier for snooze operations

snoozedUntil int - The time you want the conversation to reopen

intercom: SocialProfile

A Social Profile allows you to label your contacts, companies, and conversations and list them using that Social Profile

Fields

name? string - The name of the Social media profile

'type? string - value is "social_profile"

url? string - The name of the Social media profile

intercom: StartingAfterPaging

Cursor-based pagination configuration for result navigation

Fields

perPage? int - The number of results to fetch per page

startingAfter? string? - The cursor to use in the next request to get the next page of results

intercom: SubscriptionType

A subscription type lets customers easily opt out of non-essential communications without missing what's important to them

Fields

translations? Translation[] - An array of translations objects with the localised version of the subscription type in each available locale within your translation settings

contentTypes? ("email"|"sms_message")[] - The message types that this subscription supports - can contain email or sms_message

id? string - The unique identifier representing the subscription type

state? "live"|"draft"|"archived" - The state of the subscription type

'type? string - The type of the object - subscription

defaultTranslation? Translation - Default translation settings for the subscription type

consentType? "opt_out"|"opt_in" - Describes the type of consent

intercom: SubscriptionTypeList

A list of subscription type objects

Fields

data? SubscriptionType[] - A list of subscription type objects associated with the workspace

'type? "list" - The type of the object

intercom: Tag

A tag allows you to label your contacts, companies, and conversations and list them using that tag

Fields

appliedAt? int? - The time when the tag was applied to the object

name? string - The name of the tag

id? string - The id of the tag

'type? string - value is "tag"

appliedBy? Reference? - The admin who applied the tag

intercom: TagBasic

A tag allows you to label your contacts, companies, and conversations and list them using that tag

Fields

name? string - The name of the tag

id? string - The id of the tag

'type? string - value is "tag"

intercom: TagCompanyRequest

You can tag a single company or a list of companies

Fields

companies TagCompanyRequestCompanies[] - The id or company_id of the company can be passed as input parameters

name string - The name of the tag, which will be created if not found

intercom: TagCompanyRequestCompanies

Company identifier object for tagging operations

Fields

id? string - The Intercom defined id representing the company.

company_id? string - The company id you have defined for the company.

A list of tags objects in the workspace

Fields

data? Tag[] - A list of tags objects associated with the workspace

'type? "list" - The type of the object

intercom: TagMultipleUsersRequest

You can tag a list of users

Fields

name string - The name of the tag, which will be created if not found

users TagMultipleUsersRequestUsers[] - Array of users to apply tags to

intercom: TagMultipleUsersRequestUsers

User information for bulk tagging operations

Fields

id? string - The Intercom defined id representing the user.

intercom: Tags

A list of tags objects associated with a conversation

Fields

'type? "tag.list" - The type of the object

tags? Tag[] - A list of tags objects associated with the conversation

intercom: TagstagIdBody

Request body containing admin identifier for tag operations

Fields

adminId string - The unique identifier for the admin which is given by Intercom

intercom: Team

Teams are groups of admins in Intercom

Fields

adminPriorityLevel? AdminPriorityLevel? - Priority level assigned to team admins

assignmentLimit? int? - The assignment limit for the team. This field is only present when the team's distribution type is load balanced

name? string - The name of the team

distributionMethod? string? - Describes how assignments are distributed among the team members

adminIds? int[] - The list of admin IDs that are a part of the team

id? string - The id of the team

'type? string - Value is always "team"

intercom: TeamList

This will return a list of team objects for the App

Fields

teams? Team[] - A list of team objects

'type? "team.list" - The type of the object

intercom: TeamPriorityLevel

Admin priority levels for teams

Fields

secondaryTeamIds? int[]? - The secondary team ids for the team

primaryTeamIds? int[]? - The primary team ids for the team

intercom: Ticket

Tickets are how you track requests from your users

Fields

ticketState? TicketState? - Current state of the ticket

ticketType? TicketType? - Type classification of the ticket

ticketParts? TicketParts - Collection of ticket parts containing messages and updates

createdAt? int - The time the ticket was created as a UTC Unix timestamp

snoozedUntil? int - The time the ticket will be snoozed until as a UTC Unix timestamp. If null, the ticket is not currently snoozed

'type "ticket" (default "ticket") - Always ticket

ticketId? string - The ID of the Ticket used in the Intercom Inbox and Messenger. Do not use ticket_id for API queries

adminAssigneeId? string - The id representing the admin assigned to the ticket

teamAssigneeId? string - The id representing the team assigned to the ticket

updatedAt? int - The last time the ticket was updated as a UTC Unix timestamp

isShared? boolean - Whether or not the ticket is shared with the customer

id? string - The unique identifier for the ticket which is given by Intercom

category? "Customer"|"Back-office"|"Tracker" - Category of the Ticket

ticketAttributes? TicketCustomAttributes - Custom attributes associated with the ticket

linkedObjects? LinkedObjectList - List of objects linked to the ticket

contacts? TicketContacts - The list of contacts affected by a ticket

open? boolean - Whether or not the ticket is open. If false, the ticket is closed

intercom: TicketContacts

The list of contacts affected by a ticket

Fields

'type? "contact.list" - always contact.list

contacts? ContactReference[] - The list of contacts affected by this ticket

intercom: TicketCustomAttributes

An object containing the different attributes associated to the ticket as key-value pairs. For the default title and description attributes, the keys are _default_title_ and _default_description_

intercom: TicketDeleted

deleted ticket object

Fields

deleted? boolean - Whether the ticket is deleted or not

id? string - The unique identifier for the ticket

'object? "ticket" - always ticket

intercom: TicketList

Tickets are how you track requests from your users

Fields

tickets? Ticket[] - The list of ticket objects

pages? CursorPages? - Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed

totalCount? int - A count of the total number of objects

'type? "ticket.list" - Always ticket.list

intercom: TicketPart

A Ticket Part represents a message in the ticket

Fields

ticketState? "submitted"|"in_progress"|"waiting_on_customer"|"resolved" - The state of the ticket

previousTicketState? "submitted"|"in_progress"|"waiting_on_customer"|"resolved" - The previous state of the ticket

attachments? PartAttachment[] - A list of attachments for the part

redacted? boolean - Whether or not the ticket part has been redacted

author? TicketPartAuthor - The author that wrote or triggered the part. Can be a bot, admin, team or user

appPackageCode? string - The app package code if this part was created via API. Note this field won't show if the part was not created via API

createdAt? int - The time the ticket part was created

partType? string - The type of ticket part

externalId? string? - The external id of the ticket part

'type? string - Always ticket_part

body? string? - The message body, which may contain HTML

updatedAt? int - The last time the ticket part was updated

updatedAttributeData? UpdatedAttribute? - Data for attributes that were updated in this ticket part

id? string - The id representing the ticket part

assignedTo? Reference - Reference to the teammate or team assigned to handle the ticket

intercom: TicketPartAuthor

The author that wrote or triggered the part. Can be a bot, admin, team or user

Fields

name? string? - The name of the author

id? string - The id of the author

'type? "admin"|"bot"|"team"|"user" - The type of the author

email? string - The email of the author

intercom: TicketParts

A list of Ticket Part objects for each note and event in the ticket. There is a limit of 500 parts

Fields

ticketParts? TicketPart[] - A list of Ticket Part objects for each ticket. There is a limit of 500 parts

totalCount? int -

'type? "ticket_part.list" -

intercom: TicketReply

A Ticket Part representing a note, comment, or quick_reply on a ticket

Fields

attachments? PartAttachment[] - A list of attachments for the part

updatedAt? int - The last time the note was updated

redacted? boolean - Whether or not the ticket part has been redacted

author? TicketPartAuthor - The author that wrote or triggered the part. Can be a bot, admin, team or user

createdAt? int - The time the note was created

partType? string - Type of the part

id? string - The id representing the part

'type? "ticket_part" - Always ticket_part

body? string? - The message body, which may contain HTML

intercom: TicketRequestCustomAttributes

The attributes set on the ticket. When setting the default title and description attributes, the attribute keys that should be used are _default_title_ and _default_description_. When setting ticket type attributes of the list attribute type, the key should be the attribute name and the value of the attribute should be the list item id, obtainable by listing the ticket type. For example, if the ticket type has an attribute called priority of type list, the key should be priority and the value of the attribute should be the guid of the list item (e.g. de1825a0-0164-4070-8ca6-13e22462fa7e)

intercom: TicketState

A ticket state, used to define the state of a ticket

Fields

externalLabel? string - The state the ticket is currently in, in a human readable form - visible to customers, in the messenger, email and tickets portal

internalLabel? string - The state the ticket is currently in, in a human readable form - visible in Intercom

id? string - The id of the ticket state

'type? string - String representing the object's type. Always has the value ticket_state

category? "submitted"|"in_progress"|"waiting_on_customer"|"resolved" - The category of the ticket state

intercom: TicketStateDetailed

A ticket state, used to define the state of a ticket

Fields

externalLabel? string - The state the ticket is currently in, in a human readable form - visible to customers, in the messenger, email and tickets portal

archived? boolean - Whether the ticket state is archived

ticketTypes? TicketStateDetailedTicketTypes - Ticket types associated with this detailed ticket state

internalLabel? string - The state the ticket is currently in, in a human readable form - visible in Intercom

id? string - The id of the ticket state

'type? string - String representing the object's type. Always has the value ticket_state

category? "submitted"|"in_progress"|"waiting_on_customer"|"resolved" - The category of the ticket state

intercom: TicketStateDetailedTicketTypes

A list of ticket types associated with a given ticket state

Fields

data? TicketType[] - A list of ticket type attributes associated with a given ticket type

'type? string - String representing the object's type. Always has the value list

intercom: TicketStateList

A list of ticket states associated with a given ticket type

Fields

data? TicketStateDetailed[] - A list of ticket states associated with a given ticket type

'type? string - String representing the object's type. Always has the value list

intercom: TicketStates

A list of ticket states associated with a given ticket type

Fields

data? TicketState[] - A list of ticket states associated with a given ticket type

'type? string - String representing the object's type. Always has the value list

intercom: TicketType

A ticket type, used to define the data fields to be captured in a ticket

Fields

workspaceId? string - The id of the workspace that the ticket type belongs to

ticketStates? TicketStates - Available states for tickets of this type

archived? boolean - Whether the ticket type is archived or not

updatedAt? int - The date and time the ticket type was last updated

ticketTypeAttributes? TicketTypeAttributeList - Custom attributes defined for this ticket type

name? string - The name of the ticket type

icon? string - The icon of the ticket type

description? string - The description of the ticket type

createdAt? int - The date and time the ticket type was created

id? string - The id representing the ticket type

'type? string - String representing the object's type. Always has the value ticket_type

category? "Customer"|"Back-office"|"Tracker" - Category of the Ticket Type

intercom: TicketTypeAttribute

Ticket type attribute, used to define each data field to be captured in a ticket

Fields

inputOptions? record {} - Input options for the attribute

description? string - The description of the ticket type attribute

createdAt? int - The date and time the ticket type attribute was created

'type? string - String representing the object's type. Always has the value ticket_type_attribute

visibleOnCreate boolean(default true) - Whether the attribute is visible or not to teammates

workspaceId? string - The id of the workspace that the ticket type attribute belongs to

visibleToContacts boolean(default true) - Whether the attribute is visible or not to contacts

archived? boolean - Whether the ticket type attribute is archived or not

default? boolean - Whether the attribute is built in or not

ticketTypeId? int - The id of the ticket type that the attribute belongs to

updatedAt? int - The date and time the ticket type attribute was last updated

name? string - The name of the ticket type attribute

dataType? string - The type of the data attribute (allowed values: "string list integer decimal boolean datetime files")

requiredToCreateForContacts boolean(default false) - Whether the attribute is required or not for contacts

id? string - The id representing the ticket type attribute

requiredToCreate boolean(default false) - Whether the attribute is required or not for teammates

'order? int - The order of the attribute against other attributes

intercom: TicketTypeAttributeList

A list of attributes associated with a given ticket type

Fields

ticketTypeAttributes? TicketTypeAttribute[] - A list of ticket type attributes associated with a given ticket type

'type? string - String representing the object's type. Always has the value ticket_type_attributes.list

intercom: TicketTypeList

A list of ticket types associated with a given workspace

Fields

data? TicketType[] - A list of ticket_types associated with a given workspace

'type? string - String representing the object's type. Always has the value list

intercom: Translation

A translation object contains the localised details of a subscription type

Fields

name? string - The localised name of the subscription type

description? string - The localised description of the subscription type

locale? string - The two character identifier for the language of the translation object

intercom: UnarchiveContactHeaders

Represents the Headers record for the operation: UnarchiveContact

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: UntagCompanyRequest

You can tag a single company or a list of companies

Fields

companies UntagCompanyRequestCompanies[] - The id or company_id of the company can be passed as input parameters

name string - The name of the tag which will be untagged from the company

intercom: UntagCompanyRequestCompanies

Request schema for removing tags from companies with identification details

Fields

id? string - The Intercom defined id representing the company.

company_id? string - The company id you have defined for the company.

untag? boolean - Always set to true

intercom: UpdateArticleHeaders

Represents the Headers record for the operation: updateArticle

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: UpdateArticleRequest

You can Update an Article

Fields

translatedContent? ArticleTranslatedContent? - Translated content versions for the article update

parentId? string - The id of the article's parent collection or section. An article without this field stands alone

description? string - The description of the article. For multilingual articles, this will be the description of the default language's content

state? "published"|"draft" - Whether the article will be published or will be a draft. Defaults to draft. For multilingual articles, this will be the state of the default language's content

title? string - The title of the article.For multilingual articles, this will be the title of the default language's content

body? string - The content of the article. For multilingual articles, this will be the body of the default language's content

authorId? int - The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace

parentType? string - The type of parent, which can either be a collection or section

intercom: UpdateCollectionHeaders

Represents the Headers record for the operation: updateCollection

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: UpdateCollectionRequest

You can update a collection

Fields

translatedContent? GroupTranslatedContent? - Localized content translations for the collection

parentId? string? - The id of the parent collection. If null then it will be updated as the first level collection

name? string - The name of the collection. For multilingual collections, this will be the name of the default language's content

description? string - The description of the collection. For multilingual collections, this will be the description of the default language's content

intercom: UpdateCompanyHeaders

Represents the Headers record for the operation: UpdateCompany

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: UpdateCompanyRequest

You can update a Company

Fields

website? string - The URL for this company's website. Please note that the value specified here is not validated. Accepts any string

monthlySpend? int - How much revenue the company generates for your business. Note that this will truncate floats. i.e. it only allow for whole integers, 155.98 will be truncated to 155. Note that this has an upper limit of 2**31-1 or 2147483647.

size? int - The number of employees in this company

name? string - The name of the Company

industry? string - The industry that this company operates in

plan? string - The name of the plan you have associated with the company

customAttributes? record { string... } - A hash of key/value pairs containing any other data about the company you want Intercom to store

intercom: UpdateContactHeaders

Represents the Headers record for the operation: UpdateContact

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: UpdateContactRequest

You can update a contact

Fields

signedUpAt? int? - The time specified for when a contact signed up

role? string - The role of the contact

unsubscribedFromEmails? boolean? - Whether the contact is unsubscribed from emails

phone? string? - The contacts phone

ownerId? int? - The id of an admin that has been assigned account ownership of the contact

name? string? - The contacts name

externalId? string - A unique identifier for the contact which is given to Intercom

avatar? string? - An image URL containing the avatar of a contact

lastSeenAt? int? - The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually)

email? string - The contacts email

customAttributes? record {}? - The custom attributes which are set for the contact

intercom: UpdateContentImportSourceHeaders

Represents the Headers record for the operation: updateContentImportSource

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: UpdateContentImportSourceRequest

You can modify a Content Import Source of your Fin Content Library

Fields

syncBehavior "api"|"automated"|"manual" - If you intend to create or update External Pages via the API, this should be set to api. You can not change the value to or from api

url string - The URL of the content import source. This may only be different from the existing value if the sync behavior is API

status "active"|"deactivated" (default "active") - The status of the content import source

intercom: UpdateConversationHeaders

Represents the Headers record for the operation: updateConversation

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: UpdateConversationQueries

Represents the Queries record for the operation: updateConversation

Fields

displayAs? string - Set to plaintext to retrieve conversation messages in plain text

intercom: UpdateConversationRequest

Payload of the request to update a conversation

Fields

read? boolean - Mark a conversation as read within Intercom

companyId? string - The ID of the company that the conversation is associated with. The unique identifier for the company which is given by Intercom. Set to nil to remove company

title? string - The title given to the conversation

customAttributes? CustomAttributes - Custom attribute values to update for the conversation

intercom: UpdateDataAttributeHeaders

Represents the Headers record for the operation: updateDataAttribute

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: UpdatedAttribute

The updated attribute data of the ticket part. Only present for attribute update parts

Fields

attribute UpdatedAttributeAttribute - Information about the attribute that was updated

value UpdatedAttributeValue - The new value of the attribute

intercom: UpdatedAttributeAttribute

Information about the attribute that was updated

Fields

id string - The unique identifier of the attribute

label string - The human-readable name of the attribute

'type "attribute" - The type of the object. Always 'attribute'

intercom: UpdatedAttributeValue

The new value of the attribute

Fields

id string|int[]? - Attribute value identifier or file IDs depending on attribute type

label string|string[] - Display value for attributes or file names for file attributes

'type "value" - The type of the object. Always 'value'

intercom: UpdateExternalPageHeaders

Represents the Headers record for the operation: updateExternalPage

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: UpdateExternalPageRequest

You can update an External Page in your Fin Content Library

Fields

finAvailability boolean(default true) - Whether the external page should be used to answer questions by Fin

html string - The body of the external page in HTML

externalId? string - The identifier for the external page which was given by the source. Must be unique for the source

sourceId int - The unique identifier for the source of the external page which was given by Intercom. Every external page must be associated with a Content Import Source which represents the place it comes from and from which it inherits a default audience (configured in the UI). For a new source, make a POST request to the Content Import Source endpoint and an ID for the source will be returned in the response

title string - The title of the external page

locale "en" (default "en") - Always en

url string - The URL of the external page. This will be used by Fin to link end users to the page it based its answer on

intercom: UpdateInternalArticleHeaders

Represents the Headers record for the operation: updateInternalArticle

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: UpdateInternalArticleRequest

You can Update an Internal Article

Fields

ownerId? int - The id of the author of the article

title? string - The title of the article

body? string - The content of the article

authorId? int - The id of the author of the article

intercom: UpdateIpAllowlistHeaders

Represents the Headers record for the operation: updateIpAllowlist

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: UpdateNewsItemHeaders

Represents the Headers record for the operation: updateNewsItem

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: UpdateTicketHeaders

Represents the Headers record for the operation: updateTicket

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: UpdateTicketRequest

You can update a Ticket

Fields

ticketStateId? string - The ID of the ticket state associated with the ticket type

companyId? string - The ID of the company that the ticket is associated with. The unique identifier for the company which is given by Intercom. Set to nil to remove company

isShared? boolean - Specify whether the ticket is visible to users

adminId? int - The ID of the admin performing ticket update. Needed for workflows execution and attributing actions to specific admins

snoozedUntil? int - The time you want the ticket to reopen

ticketAttributes? record {} - The attributes set on the ticket

open? boolean - Specify if a ticket is open. Set to false to close a ticket. Closing a ticket will also unsnooze it

assigneeId? string - The ID of the admin or team to which the ticket is assigned. Set this 0 to unassign it

intercom: UpdateTicketTypeAttributeHeaders

Represents the Headers record for the operation: updateTicketTypeAttribute

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: UpdateTicketTypeAttributeRequest

You can update a Ticket Type Attribute

Fields

visibleToContacts boolean(default true) - Whether the attribute is visible to contacts when creating a ticket in Messenger

archived? boolean - Whether the attribute should be archived and not shown during creation of the ticket (it will still be present on previously created tickets)

allowMultipleValues? boolean - Whether the attribute allows multiple files to be attached to it (only applicable to file attributes)

multiline? boolean - Whether the attribute allows multiple lines of text (only applicable to string attributes)

name? string - The name of the ticket type attribute

requiredToCreateForContacts boolean(default false) - Whether the attribute is required to be filled in when contacts are creating the ticket in Messenger

description? string - The description of the attribute presented to the teammate or contact

requiredToCreate boolean(default false) - Whether the attribute is required to be filled in when teammates are creating the ticket in Inbox

visibleOnCreate boolean(default true) - Whether the attribute is visible to teammates when creating a ticket in Inbox

listItems? string - A comma delimited list of items for the attribute value (only applicable to list attributes)

intercom: UpdateTicketTypeHeaders

Represents the Headers record for the operation: updateTicketType

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: UpdateTicketTypeRequest

The request payload for updating a ticket type. You can copy the icon property for your ticket type from Twemoji Cheatsheet

Fields

archived? boolean - The archived status of the ticket type

isInternal boolean(default false) - Whether the tickets associated with this ticket type are intended for internal use only or will be shared with customers. This is currently a limited attribute

name? string - The name of the ticket type

icon string(default "🎟️") - The icon of the ticket type

description? string - The description of the ticket type

category? "Customer"|"Back-office"|"Tracker" - Category of the Ticket Type

intercom: UpdateVisitorHeaders

Represents the Headers record for the operation: updateVisitor

Fields

accept string(default "application/json") - Media type accepted by the client. Must be application/json.

intercomVersion? IntercomVersion - Intercom API version.By default, it's equal to the version set in the app package

intercom: UserID

User identifier schema containing the external user ID

Fields

user_id string - The external_id you have defined for the contact who is being added as a participant.

intercom: UserIdQueryParameter

Closed record

Query parameter schema for specifying user ID in requests

Fields

userId string - The user identifier for the query parameter

intercom: Visitor

Visitors are useful for representing anonymous people that have not yet been identified. They usually represent website visitors. Visitors are not visible in Intercom platform. The Visitors resource provides methods to fetch, update, convert and delete

Fields

ownerId? string? - The id of the admin that owns the Visitor

utmMedium? string? - The utm_medium of the visitor

createdAt? int - The time the Visitor was added to Intercom

doNotTrack? boolean? - Identifies if this visitor has do not track enabled

'type string(default "visitor") - Value is 'visitor'

pseudonym? string? - The pseudonym of the visitor

segments? VisitorSegments - Collection of segments associated with a visitor

customAttributes? record { string... } - The custom attributes you have set on the Visitor

companies? VisitorCompanies - List of companies associated with a visitor

unsubscribedFromEmails? boolean - Whether the Visitor is unsubscribed from emails

updatedAt? int - The last time the Visitor was updated

locationData? VisitorLocationData - Geographic location information for the visitor

id? string - The Intercom defined id representing the Visitor

appId? string - The id of the app the visitor is associated with

email? string - The email of the visitor

utmContent? string? - The utm_content of the visitor

signedUpAt? int - The time the Visitor signed up for your product

hasHardBounced? boolean - Identifies if this visitor has had a hard bounce

utmCampaign? string? - The utm_campaign of the visitor

avatar? VisitorAvatar - Avatar image information for a visitor

tags? VisitorTags - Collection of tags associated with a visitor

utmTerm? string? - The utm_term of the visitor

referrer? string? - The referer of the visitor

socialProfiles? VisitorSocialProfiles - Social media profiles associated with the visitor

markedEmailAsSpam? boolean - Identifies if this visitor has marked an email as spam

userId? string - Automatically generated identifier for the Visitor

phone? string? - The phone number of the visitor

sessionCount? int - The number of sessions the Visitor has had

name? string? - The name of the visitor

anonymous? boolean - Identifies if this visitor is anonymous

lasRequestAt? int - The time the Lead last recorded making a request

remoteCreatedAt? int - The time the Visitor was added to Intercom

utmSource? string? - The utm_source of the visitor

intercom: VisitorAvatar

Avatar image information for a visitor

Fields

imageUrl? string? - This object represents the avatar associated with the visitor

'type string(default "avatar") -

intercom: VisitorCompanies

List of companies associated with a visitor

Fields

companies? Company[] - Array of company objects linked to the visitor

'type? "company.list" - The type of the object

intercom: VisitorLocationData

Geographic and timezone information for a website visitor

Fields

countryCode? string - The country code of the visitor

cityName? string - The city name of the visitor

timezone? string - The timezone of the visitor

countryName? string - The country name of the visitor

continentCode? string - The continent code of the visitor

regionName? string - The region name of the visitor

'type string(default "location_data") -

postalCode? string - The postal code of the visitor

intercom: VisitorSegments

Collection of segments associated with a visitor

Fields

'type? "segment.list" - The type of the object

segments? string[] - Array of segment identifiers the visitor belongs to

intercom: VisitorSocialProfiles

Schema containing visitor's social media profile information

Fields

socialProfiles? string[] - Array of social media profile identifiers for the visitor

'type? "social_profile.list" - The type of the object

intercom: VisitorTags

Collection of tags associated with a visitor

Fields

'type? "tag.list" - The type of the object

tags? VisitorTagsTags[] - Array of tag objects assigned to the visitor

intercom: VisitorTagsTags

Tag information associated with visitors

Fields

'type? "tag" - The type of the object

id? string - The id of the tag.

name? string - The name of the tag.

intercom: WorkflowExport

A workflow export containing the complete workflow configuration

Fields

workflow? WorkflowExportWorkflow - The workflow configuration

exportVersion? string - The version of the export format

appId? int - The workspace identifier

exportedAt? string - The timestamp when the export was generated

intercom: WorkflowExportWorkflow

The workflow configuration

Fields

triggerType? string - The type of trigger that starts this workflow

preferredDevices? string[] - The preferred devices for this workflow

description? string? - The description of the workflow

createdAt? string - When the workflow was created

title? string - The title of the workflow

targetChannels? string[] - The channels this workflow targets

targeting? record {}? - The targeting rules for this workflow

embeddedRules? record {}[] - Rules embedded within the workflow steps

updatedAt? string - When the workflow was last updated

attributes? record {}[] - Custom attributes defined for this workflow

id? string - The unique identifier for the workflow

state? "live"|"draft"|"paused" - The current state of the workflow

snapshot? record {}? - The current snapshot of workflow steps and configuration

Union types

intercom: CreateDataAttributeRequest

record { dataType "options" , options record { value string }[] }|record { dataType "string"|"integer"|"float"|"boolean"|"datetime"|"date" }

CreateDataAttributeRequest

intercom: CustomerRequest

IntercomUserID|UserID|Email1?

CustomerRequest

Customer identification using Intercom ID, user ID, or email

intercom: CreateTicketRequestContacts

ID|ExternalID|Email

CreateTicketRequestContacts

Contact identifier for ticket creation using ID, external ID, or email

intercom: Datetime

DateTimeString|Integer

Datetime

Flexible datetime format accepting either string or integer values

intercom: IntercomVersion

"1.0"|"1.1"|"1.2"|"1.3"|"1.4"|"2.0"|"2.1"|"2.2"|"2.3"|"2.4"|"2.5"|"2.6"|"2.7"|"2.8"|"2.9"|"2.10"|"2.11"|"2.12"|"2.13"|"2.14"

IntercomVersion

Intercom API version.
By default, it's equal to the version set in the app package

intercom: PaginatedResponseData

NewsItem|Newsfeed

PaginatedResponseData

Response data schema that can contain news items or newsfeeds

intercom: TagsBody

CreateOrUpdateTagRequest|TagCompanyRequest|UntagCompanyRequest|TagMultipleUsersRequest

TagsBody

Request body for tag operations supporting multiple tag action types

intercom: ContactReplyConversationRequest

ContactReplyIntercomUserIdRequest|ContactReplyEmailRequest|ContactReplyUserIdRequest

ContactReplyConversationRequest

Contact reply request supporting multiple identification methods

intercom: ContactReplyTicketRequest

ContactReplyTicketIntercomUserIdRequest|ContactReplyTicketUserIdRequest|ContactReplyTicketEmailRequest

ContactReplyTicketRequest

Contact reply request for tickets with multiple identification options

intercom: ReplyConversationRequest

ContactReplyConversationRequest|AdminReplyConversationRequest

ReplyConversationRequest

Request schema for replying to conversations (contact or admin)

intercom: EventDetails

EventDetails

Details of workflow and action events

intercom: Filter

UserIdQueryParameter|IntercomUserIdQueryParameter|EmailQueryParameter

Filter

User filtering criteria using ID, Intercom ID, or email

intercom: ConversationIdPartsBody

CloseConversationRequest|SnoozeConversationRequest|OpenConversationRequest|AssignConversationRequest

ConversationIdPartsBody

Request body for conversation operations (close, snooze, open, assign)

intercom: RedactConversationRequest

RedactConversationPartRequest|RedactConversationSourceRequest

RedactConversationRequest

Request schema for redacting conversation content or source data

intercom: TicketIdReplyBody

ContactReplyTicketRequest|AdminReplyTicketRequest

TicketIdReplyBody

Request body for replying to a ticket with notification options

Anydata types

intercom: ConvertVisitorRequestVisitor

anydata

ConvertVisitorRequestVisitor

The unique identifiers to convert a single Visitor

intercom: UpdateVisitorRequest

anydata

UpdateVisitorRequest

Update an existing visitor

intercom: CreateMessageRequest

anydata?

CreateMessageRequest

You can create a message

intercom: CreateContactRequest

anydata

CreateContactRequest

Payload to create a contact

intercom: CreateDataEventRequest

anydata

CreateDataEventRequest

intercom: ConvertVisitorRequestUser

anydata

ConvertVisitorRequestUser

The unique identifiers retained after converting or merging

intercom: UpdateDataAttributeRequest

anydata

UpdateDataAttributeRequest

String types

intercom: DateTimeString

string

DateTimeString

A date and time following the ISO8601 notation

Integer types

intercom: Integer

int

Integer

A date and time as UNIX timestamp notation

Simple name reference types

intercom: ContactArchived

ContactReference

ContactArchived

archived contact object

intercom: TicketsticketIdBody

UpdateTicketRequest

TicketsticketIdBody

Request body for updating a ticket with optional notification settings

intercom: ContactReplyTicketUserIdRequest

ContactReplyBaseRequest

ContactReplyTicketUserIdRequest

Payload of the request to reply on behalf of a contact using their user_id

intercom: InternalArticle

InternalArticleListItem

InternalArticle

The Internal Articles API is a central place to gather all information and take actions on your internal articles

intercom: TicketsBody

CreateTicketRequest

TicketsBody

Ticket creation request with notification preferences

intercom: ContactscontactIdBody

UpdateContactRequest

ContactscontactIdBody

Request body for contact update operations

intercom: ContactReplyIntercomUserIdRequest

ContactReplyBaseRequest

ContactReplyIntercomUserIdRequest

Payload of the request to reply on behalf of a contact using their intercom_user_id

intercom: ContactReplyUserIdRequest

ContactReplyBaseRequest

ContactReplyUserIdRequest

Payload of the request to reply on behalf of a contact using their user_id

intercom: ContactBlocked

ContactReference

ContactBlocked

blocked contact object

intercom: ContactReplyTicketIntercomUserIdRequest

ContactReplyBaseRequest

ContactReplyTicketIntercomUserIdRequest

Payload of the request to reply on behalf of a contact using their intercom_user_id

intercom: ContactDeleted

ContactReference

ContactDeleted

deleted contact object

intercom: ContactsBody

CreateContactRequest

ContactsBody

Request body for contact operations

intercom: ContactReplyTicketEmailRequest

ContactReplyBaseRequest

ContactReplyTicketEmailRequest

Payload of the request to reply on behalf of a contact using their email

intercom: ContactUnarchived

ContactReference

ContactUnarchived

unarchived contact object

intercom: ConversationPartMetadataQuickReplyOptions

QuickReplyOption

ConversationPartMetadataQuickReplyOptions

Quick reply options with translation support for conversation parts

intercom: ConversationMessage

Message

ConversationMessage

Message object associated with a specific conversation

intercom: ContactWithPush

Contact

ContactWithPush

Contact object extended with push messaging preferences

intercom: ContactReplyEmailRequest

ContactReplyBaseRequest

ContactReplyEmailRequest

Payload of the request to reply on behalf of a contact using their email

intercom: Article

ArticleListItem

Article

The Articles API is a central place to gather all information and take actions on your articles. Articles can live within collections and sections, or alternatively they can stand alone

Import

import ballerinax/intercom;

Other versions

1.0.1

1.0.0

Metadata

Released date: 9 days ago

Version: 1.0.1

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.13.0

GraalVM compatible: Yes

Pull count

Total: 3

Current verison: 2

Weekly downloads

Source repository

Keywords

customer support

messaging

conversations

tickets

contacts

Vendor/Intercom

Area/Communication

Type/Connector

Contributors

Dependencies

ballerina/os/1.10.1 ballerina/data.jsondata/1.1.3 ballerina/url/2.6.1

Cookie policy

Delete policy

clients

records

unionTypes

anyDataTypes

stringTypes

integerTypes

simpleNameReferenceTypes

ballerinax/intercom Ballerina library

Overview

Key Features

Setup guide

Create an Intercom account

Generate an API access token

Quickstart

Step 1: Import the module

Step 2: Instantiate a new connector

Step 3: Invoke the connector operation

Create a contact

Create a conversation

Examples

Clients

intercom: Client

Constructor

get me

Parameters

Return Type

put admins/[int adminId]/away

Parameters

Return Type

get admins/activity_logs

Parameters

Return Type

get admins

Parameters

Return Type

get admins/[int adminId]

Parameters

Return Type

get ai/content_import_sources

Parameters

Return Type

post ai/content_import_sources

Parameters

Return Type

get ai/content_import_sources/[string sourceId]

Parameters

Return Type

put ai/content_import_sources/[string sourceId]

Parameters

Return Type

delete ai/content_import_sources/[string sourceId]

Parameters

Return Type

get ai/external_pages

Parameters

Return Type

post ai/external_pages

Parameters

Return Type

get ai/external_pages/[string pageId]

Parameters

Return Type

put ai/external_pages/[string pageId]

Parameters

Return Type

delete ai/external_pages/[string pageId]

Parameters

Return Type

get articles

Parameters

Return Type

post articles

Parameters

Return Type

get articles/[int articleId]

Parameters

Return Type

put articles/[int articleId]

Parameters

Return Type