Home
/
REST API Reference
/
Models
/
Update Ticket Type Attribute Request Payload

Intercom API (Unstable)

The intercom API reference.

Download OpenAPI description
api.intercom.io.json
api.intercom.io.yaml
Overview
URL

https://developers.intercom.com

License

MIT

Languages
Servers
The production API server

https://api.intercom.io/

The european API server

https://api.eu.intercom.io/

The australian API server

https://api.au.intercom.io/

Admins

Everything about your Admins

Operations

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

Operations

Articles

Everything about your Articles

Operations

Internal Articles

Everything about your Internal Articles

Operations

Away Status Reasons

Everything about your away status reasons

Operations

Companies

Everything about your Companies

Operations

Contacts

Everything about your contacts

Operations

Conversations

Everything about your Conversations

Operations

Custom Channel Events

With the closed beta "Custom Channel" integration, you can bring Fin and Intercom capabilities to your own platform via API, enabling powerful custom integrations.

Intercom treats your integration like any other Intercom channel, allowing your application and Intercom to exchange events seamlessly. This makes it possible, for example, for your users to interact with Fin directly within your own application’s UI.

Note: If you are interested in joining our closed beta and have a use case to integrate with "Fin over API", please reach out to your account manager or our support team for further information.

Operations

Custom Object Instances

Everything about your Custom Object instances.

Permission Requirements

From now on, to access this endpoint, you need additional permissions. Please head over to the Developer Hub app package authentication settings to configure the required permissions.

Operations

Data Attributes

Everything about your Data Attributes

Operations

Data Events

Everything about your Data Events

Operations

Data Export

Everything about your Data Exports

Operations

Help Center

Everything about your Help Center

Operations

Jobs

Everything about jobs

Operations

Messages

Everything about your messages

Operations

News

Everything about your News

Operations

Notes

Everything about your Notes

Operations

Segments

Everything about your Segments

Operations

Subscription Types

Everything about subscription types

Operations

Switch

Everything about Switch

Operations

Tags

Everything about tags

Operations

Teams

Everything about your Teams

Operations

Ticket States

Everything about your ticket states

Operations

Ticket Type Attributes

Everything about your ticket type attributes

Operations

Ticket Types

Everything about your ticket types

Operations

Tickets

Everything about your tickets

Operations

Visitors

Everything about your Visitors

Operations

Models

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
admin_idinteger

The ID of the admin performing ticket update. Needed for workflows execution and attributing actions to specific admins.

Example: 123
assignee_idstring

The ID of the admin or team to which the ticket is assigned. Set this 0 to unassign it.

Example: "123"
{
  "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,
  "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
}

Update Ticket Type Request Payload

The request payload for updating a ticket type. You can copy the icon property for your ticket type from Twemoji Cheatsheet

namestring

The name of the ticket type.

Example: "Bug"
descriptionstring

The description of the ticket type.

Example: "A bug has been occured"
categorystring

Category of the Ticket Type.

Enum"Customer""Back-office""Tracker"
Example: "Customer"
iconstring

The icon of the ticket type.

Default "🎟️"
Example: "🐞"
archivedboolean

The archived status of the ticket type.

Example: false
is_internalboolean

Whether the tickets associated with this ticket type are intended for internal use only or will be shared with customers. This is currently a limited attribute.

Default false
Example: false
{
  "name": "Bug",
  "description": "A bug has been occured",
  "category": "Customer",
  "icon": "🐞",
  "archived": false,
  "is_internal": false
}

Reporting Data Export

Operations

WhatsApp

Operations