POST
/conversations/{conversation_id}/convertConvert a conversation to a ticket
Converts an existing conversation into a ticket. Supply ticket_type_id to select the ticket type, and optionally provide ticket_state_id and attributes to set the ticket state and ticket attributes. The response contains the created ticket.
- IdempotentThe SDK sends
Idempotency-Key, so a retried request is only applied once.
conversation_idintegerrequired
The ID of the conversation to convert into a ticket.
Intercom-Versionstringoptional
The API version to use. Defaults to 2.17 when omitted; supported versions include 1.0–1.4 and 2.0–2.6.
Ticket configuration for converting the conversation.
ticket_type_idstringrequired
The ID of the type of ticket you want to convert the conversation to
ticket_state_idstringoptional
The ID of the ticket state associated with the ticket type.
attributesobjectoptional
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](ref:get_ticket-types). 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`).
200Returns the created ticket, including its identifier, ticket type, state, attributes, and assignment details.
typestringoptional
Always ticket
idstringoptional
The unique identifier for the ticket which is given by Intercom.
ticket_idstringoptional
The ID of the Ticket used in the Intercom Inbox and Messenger. Do not use ticket_id for API queries.
categorystringoptional
Category of the Ticket.
channelstringoptional
The channel the ticket was created through. Defaults to messenger when no channel is specified at creation.
ticket_attributesobjectoptional
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_`.
ticket_stateobjectoptional
A ticket state, used to define the state of a ticket.
ticket_typeobjectoptional
A ticket type, used to define the data fields to be captured in a ticket.
contactsobjectoptional
The list of contacts affected by a ticket.
admin_assignee_idintegeroptional
The id representing the admin assigned to the ticket. If it's not assigned to an admin it will return 0.
team_assignee_idintegeroptional
The id representing the team assigned to the ticket. If it's not assigned to a team it will return 0.
created_atintegeroptional
The time the ticket was created as a UTC Unix timestamp.
updated_atintegeroptional
The last time the ticket was updated as a UTC Unix timestamp.
openbooleanoptional
Whether or not the ticket is open. If false, the ticket is closed.
snoozed_untilintegeroptional
The time the ticket will be snoozed until as a UTC Unix timestamp. If null, the ticket is not currently snoozed.
linked_objectsobjectoptional
An object containing metadata about linked conversations and linked tickets. Up to 1000 can be returned.
ticket_partsobjectoptional
A list of Ticket Part objects for each note and event in the ticket. There is a limit of 500 parts.
is_sharedbooleanoptional
Whether or not the ticket is shared with the customer.
previous_ticket_state_idstringoptional
The ID of the previous ticket state from the most recent state change. Returns null if no state change history exists. Useful for tracking state transitions for reporting and compliance.
400Returned when the conversion request is invalid.
One documented failure
parameter_invalidTicket type is not a customer ticket type
typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
Error handling
A 400 is returned when the conversion request is invalid. ticket_type_id is required; the conversation_id path parameter must identify the conversation to convert.