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

Intercom API (2.10)

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

Articles

Everything about your Articles

Operations

Companies

Everything about your Companies

Operations

Contacts

Everything about your contacts

Operations

Conversations

Everything about your Conversations

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

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 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 Data Attribute Request

archivedboolean

Whether the attribute is to be archived or not.

Example: false
descriptionstring

The readable description you see in the UI for the attribute.

Example: "My Data Attribute Description"
optionsArray of strings

To create list attributes. Provide a set of hashes with value as the key of the options you want to make. data_type must be string.

Example: ["option1","option2"]
messenger_writableboolean

Can this attribute be updated by the Messenger

Example: false
{
  "archived": false,
  "description": "My Data Attribute Description",
  "options": [
    "option1",
    "option2"
  ],
  "messenger_writable": false
}

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"}
statestring

The state of the ticket.

Enum"in_progress""waiting_on_customer""resolved"
Example: "submitted"
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"
  },
  "state": "submitted",
  "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
}