The intercom API reference.
Home//
REST API Reference
/- Segments
Activity Log
Paginated Response
Activity Log Metadata
Addressable List
Admins
Admin Priority Level
Admin Reply
Admin Reply on ticket
Admin
App
Article Content
Articles
Article Statistics
Article Translated Content
Assign Conversation Request
Assign Conversation Request
Close Conversation Request
Collections
Company Attached Contacts
Company Attached Segments
Companies
Company Scroll
Contact Archived
Contact Attached Companies
Contact companies
Company Data
Contact Deleted
Contact List
Contact Location
Contact notes
Contact Reference
Contact Reply Base Object
Contact Reply
Email
Intercom User ID
Email
Intercom User ID
Contact Reply on ticket
User ID
User ID
Social Profile
Contact Subscription Types
Contact Tags
Contact Unarchived
Content Source List
Conversation attachment files
Contacts
First contact reply
Conversation List
Conversation Part
Conversation part author
Conversation Parts
Conversation Rating
Conversation source
Conversation statistics
Conversation teammates
Convert Ticket Request Payload
Convert Visitor Request Payload
Create Article Request Payload
Create Collection Request Payload
Create Contact Request Payload
Create Conversation Request Payload
Create Data Attribute Request
Create Data Event Request
Create Data Event Summaries Request
Create Data Export Request
Create Message Request Payload
Create Or Update Company Request Payload
Create or Update Tag Request Payload
Create Phone Switch Request Payload
Create Ticket Reply Request Payload
Create Ticket Request Payload
Create Ticket Type Attribute Request Payload
Create Ticket Type Request Payload
Cursor based pages
Custom Attributes
customer_request
Data Attribute List
Data Event List
Data Event Summary
Data Event Summary Item
Data Export CSV
Deleted Article Object
Deleted Collection Object
Deleted Company Object
Deleted Object
detach_contact_from_conversation_request
Error
File
filter
Group Content
Group Translated Content
intercom_version
Linked Object
Linked Objects
Merge contact data
Multiple Filter Search Request
Create News Item Request
Paginated Response
Open Conversation Request
Pagination Object
Paginated News Item Response
Paginated Newsfeed Response
Part attachment
Phone Switch
redact_conversation_request
Reference
reply_conversation_request
Search data
Segment List
Single Filter Search Request
Applied SLA
Snooze Conversation Request
Social Profile
Pagination: Starting After
Subscription Types
Tag Company Request Payload
Tags
Tag Users Request Payload
Tags
Team List
Team Priority Level
Ticket Attributes
Ticket List
Ticket part author
Ticket Parts
A Ticket Part representing a note, comment, or quick_reply on a ticket
Ticket Attributes
Ticket Type Attribute
Ticket Type Attributes
Ticket Types
Translation
Untag Company Request Payload
Update Article Request Payload
Update Collection Request Payload
Update Contact Request Payload
Update Conversation Request
Update Data Attribute Request
Update Ticket Request Payload
Update Ticket Type Attribute Request Payload
Update Ticket Type Request Payload
Update Visitor Request Payload
Visitor
Visitor Deleted Object
Segments
Intercom API (2.11)
Download OpenAPI description
Overview
URL
License
Languages
Servers
The production API server
https://api.intercom.io/
The european API server
https://api.eu.intercom.io/
The australian API server
https://api.au.intercom.io/
User ID
Payload of the request to reply on behalf of a contact using their user_id
A list of files that will be added as attachments. You can include up to 10 files.
The time the reply was created. If not provided, the current time will be used.
Example: 1590000000
{ "user_id": "string", "attachment_files": [ { … } ], "message_type": "comment", "type": "user", "body": "string", "created_at": 1590000000, "attachment_urls": [ "http://example.com" ] }
Segments
A list of segments objects attached to a specific contact.
Segment objects associated with the contact.
The unique identifier representing the segment.
Example: "56203d253cba154d39010062"
Type of the contact: contact (lead) or user.
Enum"contact""user"
Example: "contact"
{ "type": "list", "data": [ { … } ] }