Intercom API (unofficial showcase)
POST/contacts/{contact_id}/tags

Add a tag to a contact

Adds a tag to a contact. Supply the tag's id in the request body to identify which tag to apply; the response returns the applied tag.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 parameters · 1 body field
contact_idstringrequired
The unique identifier of the contact to add the tag to.
Intercom-Versionstringoptional
The Intercom API version to use; the listed values include 1.0 through 2.6. Defaults to 2.17 when omitted.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

The tag to attach to the contact.

idstringrequired
The unique identifier for the tag which is given by Intercom

3 status codes
200Returns the applied tag object, including its identifier, name, application time, and the admin who applied it.
typestringoptional
value is "tag"
idstringoptional
The id of the tag
namestringoptional
The name of the tag
applied_atintegeroptional
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.
applied_byobjectoptional
The admin who applied the tag. Only present when the tag is returned as part of a tagging operation on a contact, conversation, or ticket.
401Returned when the request is unauthorized.

One documented failure

  • unauthorized

    Access Token Invalid

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
404Returned when the tag is not found.

One documented failure

  • not_found

    User Not Found

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 401 is returned when the request is unauthorized. A 404 is returned when the tag is not found. The contact_id path parameter identifies the contact, and the request body must include the tag id. The Intercom-Version header defaults to 2.17 when omitted.