Skip to content
Home/
REST API Reference
/
/
Tag Company Request Paylo...

Intercom API (2.11)

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

SchemasOperations

Articles

Everything about your Articles

SchemasOperations

Companies

Everything about your Companies

SchemasOperations

Contacts

Everything about your contacts

SchemasOperations

Conversations

Everything about your Conversations

SchemasOperations

Data Attributes

Everything about your Data Attributes

SchemasOperations

Data Events

Everything about your Data Events

SchemasOperations

Data Export

Everything about your Data Exports

SchemasOperations

Help Center

Everything about your Help Center

SchemasOperations

Messages

Everything about your messages

SchemasOperations

News

Everything about your News

SchemasOperations

Notes

Everything about your Notes

SchemasOperations

Segments

Everything about your Segments

SchemasOperations

Subscription Types

Everything about subscription types

SchemasOperations

Switch

Everything about Switch

Operations

Tags

Everything about tags

SchemasOperations

Teams

Everything about your Teams

SchemasOperations

Ticket Type Attributes

Everything about your ticket type attributes

Operations

Ticket Types

Everything about your ticket types

Operations

Tickets

Everything about your tickets

SchemasOperations

Visitors

Everything about your Visitors

Operations

Models

Schemas

Subscription Types

A list of subscription type objects.

typestringrequired

The type of the object

Value"list"
Example: "list"
dataArray of objects(Subscription Types)required

A list of subscription type objects associated with the workspace .

data[].​typestringrequired

The type of the object - subscription

Example: "subscription"
data[].​idstringrequired

The unique identifier representing the subscription type.

Example: "123456"
data[].​statestringrequired

The state of the subscription type.

Enum"live""draft""archived"
Example: "live"
data[].​default_translationobject(Translation)required

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

data[].​default_translation.​namestringrequired

The localised name of the subscription type.

Example: "Announcements"
data[].​default_translation.​descriptionstringrequired

The localised description of the subscription type.

Example: "Offers, product and feature announcements"
data[].​default_translation.​localestringrequired

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

Example: "en"
data[].​translationsArray of objects(Translation)required

An array of translations objects with the localised version of the subscription type in each available locale within your translation settings.

data[].​translations[].​namestringrequired

The localised name of the subscription type.

Example: "Announcements"
data[].​translations[].​descriptionstringrequired

The localised description of the subscription type.

Example: "Offers, product and feature announcements"
data[].​translations[].​localestringrequired

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

Example: "en"
data[].​consent_typestringrequired

Describes the type of consent.

Enum"opt_out""opt_in"
Example: "opt_in"
data[].​content_typesArray of stringsrequired

The message types that this subscription supports - can contain email or sms_message.

Items Enum"email""sms_message"
Example: ["email"]
{
  "type": "list",
  "data": [
    { … }
  ]
}

Tag Company Request Payload

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

namestringrequired

The name of the tag, which will be created if not found.

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"
{
  "name": "Independent",
  "companies": [
    { … }
  ]
}

Tags

A list of tags objects in the workspace.

typestringrequired

The type of the object

Value"list"
Example: "list"
dataArray of objects(Tag)required

A list of tags objects associated with the workspace .

data[].​typestringrequired

value is "tag"

Example: "tag"
data[].​idstringrequired

The id of the tag

Example: "123456"
data[].​namestringrequired

The name of the tag

Example: "Test tag"
data[].​applied_atinteger or null(date-time)required

The time when the tag was applied to the object. Only present when the tag is returned as part of a tagging operation on a contact, conversation, or ticket.

Example: 1663597223
data[].​applied_byobject or null(Reference)required
data[].​applied_by.​typestringrequired
Example: "contact"
data[].​applied_by.​idstring or null
Example: "1a2b3c"
{
  "type": "list",
  "data": [
    { … }
  ]
}