Create Ticket Request Payload

License MIT

AI Content

With 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.",

Create Ticket Reply Request Payload

One of:

Payload of the request to reply on behalf of a contact using their intercom_user_id

intercom_user_idstringrequired

The identifier for the contact as given by Intercom.

message_typestringrequired

Value"comment"

typestringrequired

Value"user"

bodystringrequired

The text body of the comment.

created_atinteger

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

Example: 1590000000

attachment_urlsArray of strings(uri)(Attachment URLs)<= 10 items

A list of image URLs that will be added as attachments. You can include up to 10 URLs.

{
  "intercom_user_id": "string",
  "message_type": "comment",
  "type": "user",
  "body": "string",
  "created_at": 1590000000,
  "attachment_urls": [
    "http://example.com"
  ]
}

Create Ticket Request Payload

You can create a Ticket

ticket_type_idstringrequired

The ID of the type of ticket you want to create

Example: "1234"

contactsArray of ID (object) or External ID (object) or Email (object)required

The list of contacts (users or leads) affected by this ticket. Currently only one is allowed

Example: [{"id":"1234"}]

One of:

contacts[].idstringrequired

The identifier for the contact as given by Intercom.

company_idstring

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

Example: "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632"

created_atinteger

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

Example: 1590000000

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

Example: {"_default_title_":"Found a bug","_default_description_":"The button is not working"}

assignmentobject

{
  "ticket_type_id": "1234",
  "contacts": [
    { … }
  ],
  "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": {
    "assignee_id": "123"
  }
}

Create Ticket Type Attribute Request Payload

You can create a Ticket Type Attribute

namestringrequired

The name of the ticket type attribute

Example: "Bug Priority"

descriptionstringrequired

The description of the attribute presented to the teammate or contact

Example: "Priority level of the bug"

data_typestringrequired

The data type of the attribute

Enum"string""list""integer""decimal""boolean""datetime""files"

Example: "string"

required_to_createboolean

Whether the attribute is required to be filled in when teammates are creating the ticket in Inbox.

Default false

Example: false

required_to_create_for_contactsboolean

Whether the attribute is required to be filled in when contacts are creating the ticket in Messenger.

Default false

Example: false

visible_on_createboolean

Whether the attribute is visible to teammates when creating a ticket in Inbox.

Default true

Example: true

visible_to_contactsboolean

Whether the attribute is visible to contacts when creating a ticket in Messenger.

Default true

Example: true

multilineboolean

Whether the attribute allows multiple lines of text (only applicable to string attributes)

Example: false

list_itemsstring

A comma delimited list of items for the attribute value (only applicable to list attributes)

Example: "Low Priority,Medium Priority,High Priority"

allow_multiple_valuesboolean

Whether the attribute allows multiple files to be attached to it (only applicable to file attributes)

Example: false

{
  "name": "Bug Priority",
  "description": "Priority level of the bug",
  "data_type": "string",
  "required_to_create": false,
  "required_to_create_for_contacts": false,
  "visible_on_create": true,
  "visible_to_contacts": true,
  "multiline": false,
  "list_items": "Low Priority,Medium Priority,High Priority",
  "allow_multiple_values": false
}

Intercom API (2.12)

Admins

AI Content

Articles

Companies

Contacts

Conversations

Data Attributes

Data Events

Data Export

Help Center

Messages

News

Notes

Segments

Subscription Types

Switch

Tags

Teams

Ticket States

Ticket Type Attributes

Ticket Types

Tickets

Visitors

Models

Create Ticket Reply Request Payload

Create Ticket Request Payload

Create Ticket Type Attribute Request Payload