Intercom API (unofficial showcase)
POST/tickets/enqueue

Enqueue ticket creation

Enqueues ticket creation for asynchronous processing after performing best-effort input validation. Supply ticket_type_id and contacts; invalid inputs are not enqueued. Use the returned job identifier or URL to check the job's progress and retrieve the created ticket when processing completes.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 9 body fields
Intercom-Versionstringoptional
The API version to use. Defaults to 2.17 when omitted.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

Ticket details to enqueue for creation. ticket_type_id and contacts are required; contacts currently allows only one contact.

skip_notificationsbooleanoptional
Option to disable notifications when a Ticket is created.
ticket_type_idstringrequired
The ID of the type of ticket you want to create
contactsarray<ID>required
The list of contacts (users or leads) affected by this ticket. Currently only one is allowed
conversation_to_link_idstringoptional
The ID of the conversation you want to link to the ticket. Here are the valid ways of linking two tickets: - conversation | back-office ticket - customer tickets | non-shared back-office ticket - conversation | tracker ticket - customer ticket | tracker ticket
company_idstringoptional
The ID of the company that the ticket is associated with. The unique identifier for the company which is given by Intercom
created_atintegeroptional
The time the ticket was created. If not provided, the current time will be used.
ticket_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`).
assignmentobjectoptional
Assignment details for the ticket, including an admin assignee ID or team assignee ID.
channelstringoptional
The channel for the ticket. Only supported for customer ticket types. Defaults to messenger if not provided.
Allowed:email

3 status codes
200Returns a job object with its identifier, status, status URL, and details about the resource created when processing completes.
typestringoptional
The type of the object
Allowed:job
idstringrequired
The id of the job that's currently being processed or has completed.
urlstringoptional
API endpoint URL to check the job status.
statusstringoptional
The status of the job execution.
Allowed:pendingsuccessfailed
resource_typestringoptional
The type of resource created during job execution.
resource_idstringoptional
The id of the resource created during job execution (e.g. ticket id)
resource_urlstringoptional
The url of the resource created during job exeuction. Use this url to fetch the resource.
400Returned when the request fails best-effort input validation and the ticket creation job is not enqueued.

One documented failure

  • parameter_invalid

    Missing required ticket attributes

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
401Returned when the request is unauthorized.

One documented failure

  • unauthorized

    Access Token Invalid

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 request fails input validation, and a 401 when the request is unauthorized. ticket_type_id and contacts are required, and contacts currently accepts only one contact. If provided, channel must be email; it is supported only for customer ticket types.