Add tag to a contact

Request

You can tag a specific contact. This will return a tag object for the tag that was added to the contact.

Requires the read_write_users or write_users_companies OAuth scope.

Security

bearerAuth

Path

contact_idstringrequired

The unique identifier for the contact which is given by Intercom

Example:63a07ddf05a32042dffac965

Intercom-Versionstring(intercom_version)

Intercom API version.
If you omit the header, the API uses the version set in your app package, and 1.0 if none is set.

Enum:"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example:Preview

Bodyapplication/json

idstringrequired

The unique identifier for the tag which is given by Intercom

Example:"7522907"

curl -i -X POST \
  https://api.intercom.io/contacts/63a07ddf05a32042dffac965/tags \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Intercom-Version: Preview' \
  -d '{
    "id": "81"
  }'

Responses

successful

Bodyapplication/json

typestring

value is "tag"

Example:"tag"

idstring

The id of the tag

Example:"123456"

namestring

The name of the tag

Example:"Test tag"

applied_atinteger or null, (timestamp)

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, ticket, article, internal article, or content snippet, when listing the tags on a contact, or when it is returned as part of an external page. null when the tag has just been removed from an article, internal article, content snippet or external page. Removing a tag from a contact, conversation or ticket returns the original value.

Example:1663597223

applied_byobject or null(Reference)

The admin who applied the tag. Only present when the tag is returned as part of a tagging operation on a contact, conversation, ticket, article, internal article, or content snippet, when listing the tags on a contact, or when it is returned as part of an external page. null when the tag has just been removed from an article, internal article, content snippet or external page. Removing a tag from a contact, conversation or ticket returns the original value. When no admin is recorded, type is nobody_admin and id is null.

Response

{
  "type": "tag",
  "id": "81",
  "name": "Manual tag",
  "applied_at": 1663597223,
  "applied_by": {
    "type": "admin",
    "id": "456"
  }
}