Skip to content
Home
/
REST API Reference
/
Models
/
Translation

Intercom API (2.9)

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

Ticket Types

A list of ticket types associated with a given workspace.

typestring

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

ticket_typesArray of objects or null(Ticket Type)

A list of ticket_types associated with a given workspace.

{
  "type": "string",
  "ticket_types": [
    { … }
  ]
}

Translation

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

namestring

The localised name of the subscription type.

Example: "Announcements"
descriptionstring

The localised description of the subscription type.

Example: "Offers, product and feature announcements"
localestring

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[].​idstring

The Intercom defined id representing the company.

Example: "531ee472cce572a6ec000006"
companies[].​company_idstring

The company id you have defined for the company.

Example: "6"
companies[].​untagboolean

Always set to true

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