Sign in

v51

latestOpenAPI 3.0.1MITraw.githubusercontent.com2026-08-01150230854.3 KB
Tickets

Enqueue create ticket

Enqueues ticket creation for asynchronous processing, returning if the job was enqueued successfully to be processed. We attempt to perform a best-effort validation on inputs before tasks are enqueued. If the given parameters are incorrect, we won't enqueue the job.

post/tickets/enqueue

Headers

Intercom-Version'1.0' | '1.1' | '1.2' | '1.3' | '1.4' | '2.0' | '2.1' | '2.2' | '2.3' | '2.4' | '2.5' | '2.6' | '2.7' | '2.8' | '2.9' | '2.10' | '2.11' | '2.12' | '2.13' | '2.14'

Intercom API version.</br>By default, it's equal to the version set in the app package.

Example:2.14

Request body

ticket_type_idstring required

The ID of the type of ticket you want to create

conversation_to_link_idstring

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_idstring

The ID of the company that the ticket is associated with. The unique identifier for the company which is given by Intercom

created_atinteger

The time the ticket was created. If not provided, the current time will be used.

ticket_attributesTicketRequestCustomAttributes

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).

Example request

{
  "ticket_type_id": "1234",
  "contacts": [
    {
      "id": "1234"
    }
  ],
  "conversation_to_link_id": "1234",
  "company_id": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632",
  "created_at": 1590000000,
  "ticket_attributes": {
    "_default_title_": "Found a bug",
    "_default_description_": "The button is not working"
  },
  "assignment": {
    "admin_assignee_id": "123",
    "team_assignee_id": "8"
  }
}

Response

Successful response

type'job'

The type of the object

idstring required

The id of the job that's currently being processed or has completed.

urlstring

API endpoint URL to check the job status.

status'pending' | 'success' | 'failed'

The status of the job execution.

resource_typestring

The type of resource created during job execution.

resource_idstring nullable

The id of the resource created during job execution (e.g. ticket id)

resource_urlstring nullable

The url of the resource created during job exeuction. Use this url to fetch the resource.

Example response

{
  "url": "https://api.intercom.io/jobs/status/20",
  "resource_type": "ticket",
  "resource_url": "http://api.intercom.io/tickets/123"
}