The intercom API reference.
Download OpenAPI description
The production API server The european API serverhttps://api.eu.intercom.io/
The australian API serverhttps://api.au.intercom.io/
AdminsEverything about your Admins
AI ContentWith the AI Content APIs, you can create and manage External Pages and Content Import Sources for your Fin Content Library.
External Pages are pages that you want Fin to be able to answer questions about. The API for External Pages is a great way to ingest into your Fin Content Library pages that are not publicly accessible and hence can't be crawled by Intercom.
Content Import Sources are the sources of those pages, and they are used to determine the default audience for the pages (configured via the UI). You should create a Content Import Source for each source of External Pages that you want to ingest into your Fin Content Library.
You can then iterate through the content from that source via its API and POST it to the External Pages endpoint. That endpoint has an external_id parameter which allows you to specify the identifier from the source. The endpoint will then either create a new External Page or update an existing one as appropriate.",
ArticlesEverything about your Articles
Away Status ReasonsEverything about your Away Status Reasons
CompaniesEverything about your Companies
ConversationsEverything about your Conversations
Custom Channel EventsWith the "Custom Channel" integration, you can bring Fin and Intercom capabilities to your own platform via API, enabling powerful custom integrations.
Intercom treats your integration like any other Intercom channel, allowing your application and Intercom to exchange events seamlessly. This makes it possible, for example, for your users to interact with Fin directly within your own application’s UI.
Custom Object InstancesNote: "Fin over API" is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.
Everything about your Custom Object instances.
Permission Requirements
From now on, to access this endpoint, you need additional permissions. Please head over to the Developer Hub app package authentication settings to configure the required permissions.
Data AttributesEverything about your Data Attributes
Data EventsEverything about your Data Events
Data ExportEverything about your Data Exports
Help CenterEverything about your Help Center
Internal ArticlesEverything about your Internal Articles
MessagesEverything about your messages
NewsEverything about your News
NotesEverything about your Notes
Reporting Data ExportEverything about Reporting Data Export
SegmentsEverything about your Segments
Subscription TypesEverything about subscription types
TeamsEverything about your Teams
Ticket StatesEverything about your ticket states
Ticket Type AttributesEverything about your ticket type attributes
Create a new attribute for a ticket type RequestYou can create a new attribute for a ticket type.
Path ticket_type_idstringrequiredThe unique identifier for the ticket type which is given by Intercom.
Headers Intercom-Versionstring(intercom_version)Intercom API version.
By default, it's equal to the version set in the app package.
Default 2.14
Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"
Example: 2.14
Bodyapplication/jsonThe name of the ticket type attribute
Example: "Bug Priority"
descriptionstringrequiredThe description of the attribute presented to the teammate or contact
Example: "Priority level of the bug"
The data type of the attribute
Enum"string""list""integer""decimal""boolean""datetime""files"
Example: "string"
required_to_createbooleanWhether the attribute is required to be filled in when teammates are creating the ticket in Inbox.
Default false
Example: false
required_to_create_for_contactsbooleanWhether the attribute is required to be filled in when contacts are creating the ticket in Messenger.
Default false
Example: false
Whether the attribute is visible to teammates when creating a ticket in Inbox.
Default true
Example: true
visible_to_contactsbooleanWhether the attribute is visible to contacts when creating a ticket in Messenger.
Default true
Example: true
Whether the attribute allows multiple lines of text (only applicable to string attributes)
Example: false
A comma delimited list of items for the attribute value (only applicable to list attributes)
Example: "Low Priority,Medium Priority,High Priority"
allow_multiple_valuesbooleanWhether the attribute allows multiple files to be attached to it (only applicable to file attributes)
Example: false
https://api.intercom.io/ticket_types/{ticket_type_id}/attributes
https://api.eu.intercom.io/ticket_types/{ticket_type_id}/attributes
https://api.au.intercom.io/ticket_types/{ticket_type_id}/attributes
curl -i -X POST \ 'https://api.intercom.io/ticket_types/{ticket_type_id}/attributes' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -H 'Intercom-Version: 2.14' \ -d '{ "name": "Attribute Title", "description": "Attribute Description", "data_type": "string", "required_to_create": false }'
Ticket Type Attribute created
Bodyapplication/jsonString representing the object's type. Always has the value ticket_type_attribute
.
Example: "ticket_type_attribute"
The id representing the ticket type attribute.
Example: "1"
The id of the workspace that the ticket type attribute belongs to.
Example: "ecahpwf5"
The name of the ticket type attribute
Example: "Title"
The description of the ticket type attribute
Example: "Bug title."
The type of the data attribute (allowed values: "string list integer decimal boolean datetime files")
Example: "string"
Input options for the attribute
Example: "multiline: true"
The order of the attribute against other attributes
Example: 1
required_to_createbooleanWhether the attribute is required or not for teammates.
Default false
Example: false
required_to_create_for_contactsbooleanWhether the attribute is required or not for contacts.
Default false
Example: false
Whether the attribute is visible or not to teammates.
Default true
Example: false
visible_to_contactsbooleanWhether the attribute is visible or not to contacts.
Default true
Example: false
Whether the attribute is built in or not.
Example: true
The id of the ticket type that the attribute belongs to.
Example: 42
Whether the ticket type attribute is archived or not.
Example: false
created_atinteger(timestamp)The date and time the ticket type attribute was created.
updated_atinteger(timestamp)The date and time the ticket type attribute was last updated.
Update an existing attribute for a ticket type Request{ "type": "ticket_type_attribute", "id": "157", "workspace_id": "this_is_an_id640_that_should_be_at_least_", "name": "Attribute Title", "description": "Attribute Description", "data_type": "string", "input_options": { "multiline": false }, "order": 2, "required_to_create": false, "required_to_create_for_contacts": false, "visible_on_create": true, "visible_to_contacts": true, "default": false, "ticket_type_id": 63, "archived": false, "created_at": 1734537862, "updated_at": 1734537862 }
You can update an existing attribute for a ticket type.
Path ticket_type_idstringrequiredThe unique identifier for the ticket type which is given by Intercom.
The unique identifier for the ticket type attribute which is given by Intercom.
Headers Intercom-Versionstring(intercom_version)Intercom API version.
By default, it's equal to the version set in the app package.
Default 2.14
Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"
Example: 2.14
Bodyapplication/jsonThe name of the ticket type attribute
Example: "Bug Priority"
The description of the attribute presented to the teammate or contact
Example: "Priority level of the bug"
required_to_createbooleanWhether the attribute is required to be filled in when teammates are creating the ticket in Inbox.
Default false
Example: false
required_to_create_for_contactsbooleanWhether the attribute is required to be filled in when contacts are creating the ticket in Messenger.
Default false
Example: false
Whether the attribute is visible to teammates when creating a ticket in Inbox.
Default true
Example: true
visible_to_contactsbooleanWhether the attribute is visible to contacts when creating a ticket in Messenger.
Default true
Example: true
Whether the attribute allows multiple lines of text (only applicable to string attributes)
Example: false
A comma delimited list of items for the attribute value (only applicable to list attributes)
Example: "Low Priority,Medium Priority,High Priority"
allow_multiple_valuesbooleanWhether the attribute allows multiple files to be attached to it (only applicable to file attributes)
Example: false
Whether the attribute should be archived and not shown during creation of the ticket (it will still be present on previously created tickets)
Example: false
https://api.intercom.io/ticket_types/{ticket_type_id}/attributes/{id}
https://api.eu.intercom.io/ticket_types/{ticket_type_id}/attributes/{id}
https://api.au.intercom.io/ticket_types/{ticket_type_id}/attributes/{id}
curl -i -X PUT \ 'https://api.intercom.io/ticket_types/{ticket_type_id}/attributes/{id}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -H 'Intercom-Version: 2.14' \ -d '{ "description": "New Attribute Description" }'
Ticket Type Attribute updated
Bodyapplication/jsonString representing the object's type. Always has the value ticket_type_attribute
.
Example: "ticket_type_attribute"
The id representing the ticket type attribute.
Example: "1"
The id of the workspace that the ticket type attribute belongs to.
Example: "ecahpwf5"
The name of the ticket type attribute
Example: "Title"
The description of the ticket type attribute
Example: "Bug title."
The type of the data attribute (allowed values: "string list integer decimal boolean datetime files")
Example: "string"
Input options for the attribute
Example: "multiline: true"
The order of the attribute against other attributes
Example: 1
required_to_createbooleanWhether the attribute is required or not for teammates.
Default false
Example: false
required_to_create_for_contactsbooleanWhether the attribute is required or not for contacts.
Default false
Example: false
Whether the attribute is visible or not to teammates.
Default true
Example: false
visible_to_contactsbooleanWhether the attribute is visible or not to contacts.
Default true
Example: false
Whether the attribute is built in or not.
Example: true
The id of the ticket type that the attribute belongs to.
Example: 42
Whether the ticket type attribute is archived or not.
Example: false
created_atinteger(timestamp)The date and time the ticket type attribute was created.
updated_atinteger(timestamp)The date and time the ticket type attribute was last updated.
Ticket Types{ "type": "ticket_type_attribute", "id": "162", "workspace_id": "this_is_an_id644_that_should_be_at_least_", "name": "name", "description": "New Attribute Description", "data_type": "string", "order": 0, "required_to_create": false, "required_to_create_for_contacts": false, "visible_on_create": false, "visible_to_contacts": false, "default": false, "ticket_type_id": 65, "archived": false, "created_at": 1734537864, "updated_at": 1734537864 }
Everything about your ticket types
TicketsEverything about your tickets
VisitorsEverything about your Visitors
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4