The intercom API reference.
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/
Ticket Parts
A list of Ticket Part objects for each note and event in the ticket. There is a limit of 500 parts.
A list of Ticket Part objects for each ticket. There is a limit of 500 parts.
The message body, which may contain HTML.
Example: "<p>Okay!</p>"
The previous state of the ticket.
Enum"submitted""in_progress""waiting_on_customer""resolved"
Example: "submitted"
The state of the ticket.
Enum"submitted""in_progress""waiting_on_customer""resolved"
Example: "submitted"
The time the ticket part was created.
Example: 1663597223
The last time the ticket part was updated.
Example: 1663597260
The author that wrote or triggered the part. Can be a bot, admin, team or user.
A list of attachments for the part.
{ "type": "ticket_part.list", "ticket_parts": [ { … } ], "total_count": 2 }
A Ticket Part representing a note, comment, or quick_reply on a ticket
A Ticket Part representing a note, comment, or quick_reply on a ticket
The author that wrote or triggered the part. Can be a bot, admin, team or user.
{ "type": "ticket_part", "id": "3", "part_type": "note", "body": "<p>Okay!</p>", "created_at": 1663597223, "updated_at": 1663597260, "author": { "type": "admin", "id": "274", "name": "Operator", "email": "operator+abcd1234@intercom.io" }, "attachments": [ { … } ], "redacted": false }
Ticket Attributes
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).
{ "_default_title_": "Found a bug", "_default_description_": "The button is not working" }