Translation

Ticket Types

A list of ticket types associated with a given workspace.

typestringrequired

String representing the object's type. Always has the value ticket_type.list.

Value"ticket_type_attributes.list"

ticket_typesArray of objects(Ticket Type)required

A list of ticket_types associated with a given workspace.

ticket_types[].typestringrequired

String representing the object's type. Always has the value ticket_type.

Value"ticket_type"

Example: "ticket_type"

ticket_types[].idstringrequired

The id representing the ticket type.

Example: "1295"

ticket_types[].categorystringrequired

Category of the Ticket Type.

Enum"Customer""Back-office""Tracker"

Example: "Customer"

ticket_types[].namestringrequired

The name of the ticket type

Example: "Bug"

ticket_types[].descriptionstringrequired

The description of the ticket type

Example: "A bug that has been reported."

ticket_types[].iconstringrequired

The icon of the ticket type

Example: "🐞"

ticket_types[].workspace_idstringrequired

The id of the workspace that the ticket type belongs to.

Example: "ecahpwf5"

ticket_types[].ticket_type_attributesobject(Ticket Type Attributes)required

A list of attributes associated with a given ticket type.

ticket_types[].ticket_type_attributes.typestringrequired

String representing the object's type. Always has the value ticket_type_attributes.list.

Value"ticket_type_attributes.list"

ticket_types[].ticket_type_attributes.ticket_type_attributesArray of objects(Ticket Type Attribute)required

A list of ticket type attributes associated with a given ticket type.

ticket_types[].ticket_type_attributes.ticket_type_attributes[].typestringrequired

String representing the object's type. Always has the value ticket_type_attribute.

Value"ticket_type_attribute"

Example: "ticket_type_attribute"

ticket_types[].ticket_type_attributes.ticket_type_attributes[].idstringrequired

The id representing the ticket type attribute.

Example: "1"

ticket_types[].ticket_type_attributes.ticket_type_attributes[].workspace_idstringrequired

The id of the workspace that the ticket type attribute belongs to.

Example: "ecahpwf5"

ticket_types[].ticket_type_attributes.ticket_type_attributes[].namestringrequired

The name of the ticket type attribute

Example: "Title"

ticket_types[].ticket_type_attributes.ticket_type_attributes[].descriptionstringrequired

The description of the ticket type attribute

Example: "Bug title."

ticket_types[].ticket_type_attributes.ticket_type_attributes[].data_typestringrequired

The type of the data attribute (allowed values: "string list integer decimal boolean datetime files")

Example: "string"

ticket_types[].ticket_type_attributes.ticket_type_attributes[].input_optionsobjectrequired

Input options for the attribute

Example: "multiline: true"

ticket_types[].ticket_type_attributes.ticket_type_attributes[].orderintegerrequired

The order of the attribute against other attributes

Example: 1

ticket_types[].ticket_type_attributes.ticket_type_attributes[].required_to_createbooleanrequired

Whether the attribute is required or not for teammates.

Default false

Example: false

ticket_types[].ticket_type_attributes.ticket_type_attributes[].required_to_create_for_contactsbooleanrequired

Whether the attribute is required or not for contacts.

Default false

Example: false

ticket_types[].ticket_type_attributes.ticket_type_attributes[].visible_on_createbooleanrequired

Whether the attribute is visible or not to teammates.

Default true

Example: false

ticket_types[].ticket_type_attributes.ticket_type_attributes[].visible_to_contactsbooleanrequired

Whether the attribute is visible or not to contacts.

Default true

Example: false

ticket_types[].ticket_type_attributes.ticket_type_attributes[].defaultbooleanrequired

Whether the attribute is built in or not.

Example: true

ticket_types[].ticket_type_attributes.ticket_type_attributes[].ticket_type_idintegerrequired

The id of the ticket type that the attribute belongs to.

Example: 42

ticket_types[].ticket_type_attributes.ticket_type_attributes[].archivedbooleanrequired

Whether the ticket type attribute is archived or not.

Example: false

ticket_types[].ticket_type_attributes.ticket_type_attributes[].created_atinteger(timestamp)required

The date and time the ticket type attribute was created.

ticket_types[].ticket_type_attributes.ticket_type_attributes[].updated_atinteger(timestamp)

The date and time the ticket type attribute was last updated.

ticket_types[].archivedbooleanrequired

Whether the ticket type is archived or not.

Example: false

ticket_types[].created_atinteger(timestamp)required

The date and time the ticket type was created.

ticket_types[].updated_atinteger(timestamp)

The date and time the ticket type was last updated.

{
  "type": "ticket_type_attributes.list",
  "ticket_types": [
    { … }
  ]
}

Translation

A translation object contains the localised details of a subscription type.

namestringrequired

The localised name of the subscription type.

Example: "Announcements"

descriptionstringrequired

The localised description of the subscription type.

Example: "Offers, product and feature announcements"

localestringrequired

The two character identifier for the language of the translation object.

Example: "en"

{
  "name": "Announcements",
  "description": "Offers, product and feature announcements",
  "locale": "en"
}

Untag Company Request Payload

You can tag a single company or a list of companies.

namestringrequired

The name of the tag which will be untagged from the company

Example: "Independent"

companiesArray of objectsrequired

The id or company_id of the company can be passed as input parameters.

companies[].idstringrequired

The Intercom defined id representing the company.

Example: "531ee472cce572a6ec000006"

companies[].company_idstringrequired

The company id you have defined for the company.

Example: "6"

companies[].untagbooleanrequired

Always set to true

Example: true

{
  "name": "Independent",
  "companies": [
    { … }
  ]
}

Intercom API (2.11)

Admins

Articles

Companies

Contacts

Conversations

Data Attributes

Data Events

Data Export

Help Center

Messages

News

Notes

Segments

Subscription Types

Switch

Tags

Teams

Ticket Type Attributes

Ticket Types

Tickets

Visitors

Models

Ticket Types

Translation

Untag Company Request Payload