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

Update External Page Payload

You can update an External Page in your Fin Content Library.

titlestringrequired

The title of the external page.

Example: "Getting started with..."

htmlstringrequired

The body of the external page in HTML.

Example: "<p>Hello world!</p>"

urlstringrequired

The URL of the external page. This will be used by Fin to link end users to the page it based its answer on.

Example: "https://help.example.com/en/articles/1234-getting-started"

fin_availabilityboolean

Whether the external page should be used to answer questions by Fin.

Default true

Example: true

localestringrequired

Always en

Default "en"

Value"en"

Example: "en"

source_idintegerrequired

The unique identifier for the source of the external page which was given by Intercom. Every external page must be associated with a Content Import Source which represents the place it comes from and from which it inherits a default audience (configured in the UI). For a new source, make a POST request to the Content Import Source endpoint and an ID for the source will be returned in the response.

Example: 1234

external_idstring

The identifier for the external page which was given by the source. Must be unique for the source.

Example: "5678"

{
  "title": "Getting started with...",
  "html": "<p>Hello world!</p>",
  "url": "https://help.example.com/en/articles/1234-getting-started",
  "fin_availability": true,
  "locale": "en",
  "source_id": 1234,
  "external_id": "5678"
}

Update Ticket Request Payload

You can update a Ticket

ticket_attributesobject

The attributes set on the ticket.

Example: {"_default_title_":"example","_default_description_":"having a problem"}

ticket_state_idstring

The ID of the ticket state associated with the ticket type.

Example: "123"

company_idstring

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

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

openboolean

Specify if a ticket is open. Set to false to close a ticket. Closing a ticket will also unsnooze it.

Example: true

is_sharedboolean

Specify whether the ticket is visible to users.

Example: true

snoozed_untilinteger(timestamp)

The time you want the ticket to reopen.

Example: 1673609604

assignmentobject

{
  "ticket_attributes": {
    "_default_title_": "example",
    "_default_description_": "having a problem"
  },
  "ticket_state_id": "123",
  "company_id": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632",
  "open": true,
  "is_shared": true,
  "snoozed_until": 1673609604,
  "assignment": {
    "admin_id": "123",
    "assignee_id": "123"
  }
}

Update Ticket Type Attribute Request Payload

You can update a Ticket Type Attribute

namestring

The name of the ticket type attribute

Example: "Bug Priority"

descriptionstring

The description of the attribute presented to the teammate or contact

Example: "Priority level of the bug"

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

archivedboolean

Whether the attribute should be archived and not shown during creation of the ticket (it will still be present on previously created tickets)

Example: false

{
  "name": "Bug Priority",
  "description": "Priority level of the bug",
  "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,
  "archived": 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

Update External Page Payload

Update Ticket Request Payload

Update Ticket Type Attribute Request Payload