Intercom API (unofficial showcase)
POST/conversations/{conversation_id}/tags

Add a tag to a conversation

Adds a tag to a specific conversation. Provide the tag identifier and the admin identifier in the request body to apply the tag. The response includes the tag that was added.

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

2 parameters · 2 body fields
conversation_idstringrequired
The unique identifier of the conversation to tag.
Intercom-Versionstringoptional
The Intercom API version to use. Defaults to `2.17` when omitted.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

Tagging details containing the tag to apply and the admin applying it.

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

3 status codes
200Returns the tag object that was added to the conversation, including its identifier, name, application time, and applying admin when available.
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 conversation is not found.

One documented failure

  • not_found

    Conversation 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, and a 404 when the conversation is not found. The conversation_id path parameter must identify the conversation to tag. Include id and admin_id in the request body.