Connect to the Intercom Customer Service API to access data and build integrations for this chat app. Test an API call and export the code snippet into your app.
Datatype | Description | Example |
---|---|---|
Datepicker | String which includes date and time | |
Map | String which includes latitude and longitude coma separated | |
List | Simple array | |
Select | String with predefined values | |
Array | Array of objects |
Please use SDK to test this feature.
Field | Type | Description |
---|---|---|
projectName | credentials | |
projectKey | credentials |
Fetch access token.
Field | Type | Description |
---|---|---|
clientId | credentials | Client identifier from your credentials. |
clientSecret | credentials | Client secret from your credentials. |
code | String | This is automatically passed by the redirect. |
Create user by email.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
String | The user’s email address. | |
userId | String | A unique string identifier for the user. |
phone | String | The user’s phone number. |
name | String | The user’s full name. |
lastSeenIp | String | An ip address. |
customAttributes | JSON | JSON Object, a hash of key - value pairs containing any other data about the user you want Intercom to store. |
lastSeenUserAgent | String | The user agent the user last visited your application with. |
companies | List | Array of JSON objects of companies. |
lastRequestAt | DatePicker | The date the user last visited your application |
updateLastRequestAt | Boolean | If true, instructs Intercom to update the user’s last_request_at value. |
newSession | Boolean | If true, instructs Intercom to register the request as a session. |
Create user by identifier.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
userId | String | A unique string identifier for the user. |
String | The user’s email address. | |
phone | String | The user’s phone number. |
name | String | The user’s full name. |
lastSeenIp | String | An ip address. |
customAttributes | JSON | JSON Object, a hash of key - value pairs containing any other data about the user you want Intercom to store. |
lastSeenUserAgent | String | The user agent the user last visited your application with. |
companies | List | Array of JSON objects of companies. |
lastRequestAt | DatePicker | The date the user last visited your application |
updateLastRequestAt | Boolean | If true, instructs Intercom to update the user’s last_request_at value. |
newSession | Boolean | If true, instructs Intercom to register the request as a session. |
Update user by email.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
String | The user’s email address. | |
userId | String | A unique string identifier for the user. |
phone | String | The user’s phone number. |
name | String | The user’s full name. |
lastSeenIp | String | An ip address. |
customAttributes | JSON | JSON Object, a hash of key - value pairs containing any other data about the user you want Intercom to store. |
lastSeenUserAgent | String | The user agent the user last visited your application with. |
companies | List | Array of JSON objects of companies. |
lastRequestAt | DatePicker | The date the user last visited your application |
updateLastRequestAt | Boolean | If true, instructs Intercom to update the user’s last_request_at value. |
newSession | Boolean | If true, instructs Intercom to register the request as a session. |
Update user by identifier.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
userId | String | A unique string identifier for the user. |
String | The user’s email address. | |
phone | String | The user’s phone number. |
name | String | The user’s full name. |
lastSeenIp | String | An ip address. |
customAttributes | JSON | JSON Object, a hash of key - value pairs containing any other data about the user you want Intercom to store. |
lastSeenUserAgent | String | The user agent the user last visited your application with. |
companies | List | Array of JSON objects of companies. |
lastRequestAt | DateTicker | The date the user last visited your application |
updateLastRequestAt | Boolean | If true, instructs Intercom to update the user’s last_request_at value. |
newSession | Boolean | If true, instructs Intercom to register the request as a session. |
Fetch a list of users.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
page | String | what page of results to fetch. |
perPage | String | how many results per page. |
order | String | Return the users in ascending or descending order. One of: asc, desc. |
sort | Select | what field to sort the results by. One of: created_at, last_request_at, signed_up_at, updated_at. |
createdSince | String | limit results to users that were created in that last number of days. |
Fetch segmented users or leads by tag.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
tagId | String | The identifier of the tag to filter by. |
Fetch segmented users or leads by segment.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
segmentId | String | The identifier of the segment to filter by. |
Retrieve user by identifier.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
userId | String | The user identifier. |
userIdType | Select | The user identifier type. One of: intercom_id, user_id, email. |
Delete user.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
userId | String | The user identifier. |
userIdType | Select | The user identifier type. One of: intercom_id, user_id, email. |
Scroll over all users.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
scrollParam | String | Scroll parameter. |
Create lead.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
name | String | The name of the Lead. |
userId | String | Identifier for the Lead. |
String | The email you have defined for the Lead. | |
phone | String | The phone number you have defined for the lead. |
avatarImageUrl | String | An avatar URL for the Lead. |
userAgentData | String | Data about the last user agent the Lead was seen using. |
lastSeenIp | String | An ip address. |
companies | List | Array of JSON objects of companies. |
socialProfiles | List | Array of JSON objects, of social profiles associated with the Lead. |
segments | List | Array of segments the Lead. |
tags | String | Array of tags associated with the Lead. |
customAttributes | JSON | JSON Object. The custom attributes you have set on the Lead. |
locationData | JSON | JSON Object, of Location, relating to the Lead. |
Update lead.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
userId | String | Identifier for the Lead. |
name | String | The name of the Lead. |
String | The email you have defined for the Lead. | |
phone | String | The phone number you have defined for the lead. |
avatarImageUrl | String | An avatar URL for the Lead. |
userAgentData | String | Data about the last user agent the Lead was seen using. |
lastSeenIp | String | An ip address. |
companies | List | Array of JSON objects of companies. |
socialProfiles | List | Array of JSON objects, of social profiles associated with the Lead. |
segments | List | Array of segments the Lead. |
tags | List | Array of tags associated with the Lead. |
customAttributes | JSON | JSON Object. The custom attributes you have set on the Lead. |
locationData | JSON | JSON Object, of Location, relating to the Lead. |
Fetch a list of all leads.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
Fetch all Leads with a given email.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
String | Email for fetch. |
Fetch single lead.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
userId | String | The lead identifier. |
userIdType | Select | The lead identifier type. One of: intercom_id, user_id, email. |
Delete lead.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
userId | String | The lead identifier. |
userIdType | Select | The lead identifier type. One of: intercom_id, user_id, email. |
Convert Lead to Users.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
leadId | String | The lead identifier. |
leadIdType | Select | The user identifier type. One of: intercom_id, user_id, email. |
userId | String | Identifier of existing User. |
Scroll over all Leads.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
scrollParam | String | Scroll parameter. |
Create company.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
name | String | The name of the company. |
companyId | String | The company id you have defined for the company. |
monthlySpend | String | How much revenue the company generates for your business. |
plan | String | The name of the plan you have associated with the company. |
customAttributes | JSON | JSON Object, a hash of key - value pairs containing any other data about the company you want Intercom to store. |
Update company.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
companyId | String | The company identifier. |
name | String | The name of the company. |
monthlySpend | String | How much revenue the company generates for your business. |
plan | String | The name of the plan you have associated with the company. |
customAttributes | JSON | JSON Object, a hash of key - value pairs containing any other data about the company you want Intercom to store. |
Fetch a list of companies.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
page | Number | What page of results to fetch. |
perPage | Number | How many results per page. |
order | String | Return the companies in ascending or descending order. One of: asc, desc. |
Fetch tagged companies by tag.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
tagId | String | The identifier of the tag to filter by. |
Fetch segmented companies by segment.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
segmentId | String | The identifier of the segment to filter by. |
Fetch single company.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
companyId | String | The company identifier, you have given to the company. |
Fetch users that belong to a company.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
companyId | String | Your company identifier for the company. |
Scroll over all companies.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
scrollParam | String | Scroll parameter. |
fetching App’s admins.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
Fetching current admin of app.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
Fetching one admin of app.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
adminId | String | Admins identifier. |
Create tag.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
name | String | The name of the tag. |
Update tag.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
id | String | The identifier of tag to updates. |
name | String | New name of the tag. |
Add tag to User.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
name | String | The name of the tag. |
users | List | Array of JSON objects, of users user_id, intercom identifier or email. |
Remove tag from User.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
name | String | The name of the tag. |
users | List | Array of JSON objects, of users user_id, intercom identifier or email. |
Add tag to Company.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
name | String | The name of the tag. |
companies | List | Array of JSON objects, of companies company_id or intercom identifier. |
Remove tag from Company.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
name | String | The name of the tag. |
companies | List | Array of JSON objects, of companies company_id or intercom identifier. |
Delete tag.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
tagId | String | Tag identifier. |
Fetch tags of App.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
Fetch list the user segments.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
Fetch single segments.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
segmentId | String | Segment identifier. |
Create a Note.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
userId | String | User identifier the note is to be created about. |
userIdType | Select | The user identifier type. One of: intercom_id, user_id, email. |
body | String | The text of the note. |
adminId | String | The identifier of the admin creating the note. |
List Notes for a User.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
userId | String | The user identifier. |
userIdType | Select | The user identifier type. One of: intercom_id, user_id, email. |
Fetch single Note.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
noteId | String | The note identifier. |
Submitting Events.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
eventName | String | The name of the event that occurred. |
userId | String | Your identifier for the the user. |
createdAt | DatePicker | The time the event occurred |
metadata | JSON | JSON Object, metadata about the event. |
The events belonging to a user.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
userId | String | The user identifier. |
View User Event Summaries.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
userId | String | The user identifier. |
Fetch app total counts.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
type | Select | Type of counts. One of: user, company, conversation. |
Fetch app conversation count.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
Fetch admin conversations count.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
Fetch user segmens count.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
Fetch user tags count.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
Fetch company segments count.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
Fetch company tags count.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
Fetch company users count.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
Create an admin initiated message to a user.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
fromAdminId | String | Admin identifier from whom send message. |
receiverType | Select | Receiver type. One of: user, contact. |
receiverId | String | The receiver identifier. |
receiverIdType | Select | The receiver identifier type. One of: intercom_id, user_id, email. |
messageType | Select | The kind of message being created. One of: inapp, email. |
subject | String | The title of the email. |
body | String | The content of the message. Plaintext only, HTML is not supported. |
template | Select | The style of the outgoing message. Only valid for email messages. One of: plain, personal. |
Create user message.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
senderId | String | The sender identifier. |
senderIdType | Select | The sender identifier type. One of: intercom_id, user_id, email. |
body | String | The content of the message. Plaintext only, HTML is not supported. |
Create contact message.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
senderId | String | The sender identifier. |
senderIdType | Select | The sender identifier type. One of: intercom_id, user_id. |
body | String | The content of the message. Plaintext only, HTML is not supported. |
Fetch a list of all conversations.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
Fetch conversations for single admin.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
adminId | String | Admin identifier. |
open | Boolean | when true fetches just open conversations, when false just closed conversations. |
Fetch conversations with single user.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
userId | String | The user identifier. |
userIdType | Select | The user identifier type. One of: intercom_user_id, user_id, email. |
Fetch single conversation.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
conversationId | String | Conversation identifier. |
Replying to a Conversation.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
conversationId | String | Conversation identifier. |
body | String | The text body of the comment. |
userId | String | The user identifier. |
userIdType | Select | The user identifier type. One of: intercom_user_id, user_id, email. |
attachmentUrls | List | Array of Strings of URLs of files that will be added as attachments. You can include up to 5 attachments. |
Reply to admin comment.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
conversationId | String | Conversation identifier. |
adminId | String | The identifier of the Admin who is authoring the comment. |
body | String | The text body of the comment. |
attachmentUrls | List | Array of Strings of URLs of files that will be added as attachments. You can include up to 5 attachments. |
Reply to users last conversation.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
intercomUserId | String | The user identifier. |
adminId | String | The identifier of the Admin who is replying. |
body | String | The text body of the comment. |
attachmentUrls | List | Array of Strings of URLs of files that will be added as attachments. You can include up to 5 attachments. |
Marking a Conversation as Read.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
conversationId | String | Conversation identifier. |
Closing a conversation.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
conversationId | String | Conversation identifier. |
adminId | String | Admin identifier. |
Fetch single visitor.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
userId | String | Visitor user identifier. |
userIdType | Select | Visitor user identifier type. One of: intercom_id, user_id. |
Update a Visitor.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
userId | String | User identifier for the Visitor. |
name | String | The name of the Visitor. |
customAttributes | JSON | JSON Object, the custom attributes you have set on the Visitor. |
lastRequestAt | DatePicker | The date the lead last visited your application |
avatarImageUrl | String | An avatar image URL for the Visitor. |
unsubscribedFromEmails | Boolean | Whether the Visitor is unsubscribed from emails. |
locationData | JSON | JSON Object. Location relating to the Visitor. |
userAgentData | String | Data about the last user agent the Visitor was seen using. |
lastSeenIp | String | An ip address. |
socialProfiles | List | Array of JSON objects, of social profiles associated with the Visitor. |
segments | List | Array of segments the Visitor. |
tags | List | Array of tags associated with the Visitor. |
Delete a visitor.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
userId | String | User identifier for the Visitor. |
Convert Visitor to Leads.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
visitorUserId | String | User identifier for the Visitor. |
visitorUserIdType | Select | The Visitor user identifier of type. One of: intercom_id, user_id, email. |
leadId | String | User identifier for the Lead to binding. |
Create new subscription.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
url | String | The url the event should be sent to. |
topics | List | Comma-separated list of topics to subscribe to. |
serviceType | String | The type of the service being called. Default is web. |
hubSecret | String | A key used to sign notifications. |
Fetch single subscription.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
subscriptionId | String | Subscription identifier. |
Fetch list of subscriptions.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
Fetch feed of errors returned by the webhook.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
subscriptionId | String | Subscription identifier. |
Fetch feed of notifications sent.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
subscriptionId | String | Subscription identifier. |
Ping subscription.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
subscriptionId | String | Subscription identifier. |
Create an Event Webhook Subscription.
You can use our service as url:
https://webhooks.rapidapi.com/api/message/Intercom/webhookEvent/{projectName}/{projectKey} * see credentials description above
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
metadataEventNames | List | Array of events name to subscribe to. |
url | String | The url the event should be sent to. |
serviceType | String | The type of the service being called. Default is web. |
Update an Event Webhook Subscription.
You can use our service as url:
https://webhooks.rapidapi.com/api/message/Mandrill/webhookEvent/{projectName}/{projectKey} * see credentials description above
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
metadataEventNames | List | Array of events name to subscribe to. |
url | String | The url the event should be sent to. |
serviceType | String | The type of the service being called. Default is web. |
Creating bulk jobs for users.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
items | List | Array of object, of users tasks. |
Bulk Lead Posting.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
items | List | Array of object, of Leads. |
Bulk Event Posting.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
items | List | Array of object, of Events. |
Fetch single job.
Field | Type | Description |
---|---|---|
accessToken | String | Access token. |
jobId | String | Bulk job identifier. |