DELETE/conversations/{conversation_id}/tags/{tag_id}

Remove a tag from a conversation

Removes a tag from a specific conversation. Identify the conversation and tag in the path, and provide the admin identifier in the request body. The response includes the tag that was removed.

3 parameters · 1 body field
conversation_idstringrequired
The unique identifier of the conversation to remove the tag from.
tag_idstringrequired
The unique identifier of the tag to remove.
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

Details for removing the tag, including the admin performing the removal.

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

3 status codes
200Returns the tag object that was removed from 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 tag is not found.

2 documented failures

  • not_found

    Conversation not found

  • tag_not_found

    Tag 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 tag is not found. The conversation_id path parameter and tag_id path parameter must identify the conversation and tag. Include admin_id in the request body.