Home
/
REST API Reference
/
Tags
/
Create or update a tag, Tag or untag companies, Tag contacts

Create or update a tag, Tag or untag companies, Tag contacts

You can use this endpoint to perform the following operations:

1. Create a new tag: You can create a new tag by passing in the tag name as specified in "Create or Update Tag Request Payload" described below.

2. Update an existing tag: You can update an existing tag by passing the id of the tag as specified in "Create or Update Tag Request Payload" described below.

3. Tag Companies: You can tag single company or a list of companies. You can tag a company by passing in the tag name and the company details as specified in "Tag Company Request Payload" described below. Also, if the tag doesn't exist then a new one will be created automatically.

4. Untag Companies: You can untag a single company or a list of companies. You can untag a company by passing in the tag id and the company details as specified in "Untag Company Request Payload" described below.

5. Tag Multiple Users: You can tag a list of users. You can tag the users by passing in the tag name and the user details as specified in "Tag Users Request Payload" described below.

Each operation will return a tag object.

SecurityHTTP: bearerAuth
Request
header Parameters
Intercom-Version
string (intercom_version)
Default: 2.11

Intercom API version.
By default, it's equal to the version set in the app package.

Enum: "1.0" "1.1" "1.2" "1.3" "1.4" "2.0" "2.1" "2.2" "2.3" "2.4" "2.5" "2.6" "2.7" "2.8" "2.9" "2.10" "2.11" "Unstable"
Example: 2.11
Request Body schema: application/json
One of:

You can create or update an existing tag.

name
required
string

The name of the tag, which will be created if not found, or the new name for the tag if this is an update request. Names are case insensitive.

id
string

The id of tag to updates.

post
/tags
Request samples
application/json
{
"name": "test"
}
Responses

200

Action successful

Response Schema: application/json
type
string

value is "tag"

id
string

The id of the tag

name
string

The name of the tag

applied_at
integer <date-time>

The time when the tag was applied to the object

object (Reference)

reference to another object

400

Invalid parameters

401

Unauthorized

404

User not found

Response samples
application/json
{
"type": "tag",
"id": "456",
"name": "test"
}