Intercom API (unofficial showcase)
POST/content_snippets/{content_snippet_id}/tags

Add a tag to a content snippet

Applies an existing tag to a content snippet and returns the applied tag. The tag must already exist, and the authenticated user must have the manage_knowledge_base_content permission. The request requires the read_write_content_snippets OAuth scope.

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

2 parameters · 2 body fields
content_snippet_idstringrequired
The unique identifier of the content snippet 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

Tag details for applying an existing tag to the content snippet.

idstringrequired
The unique identifier of the tag to apply, as given by Intercom.
admin_idstringoptional
Optional id of the teammate to attribute the tagging to. Defaults to the authenticating teammate. Does not affect authorization.

4 status codes
200Returns the tag applied to the content snippet.
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 unauthenticated.

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
403Returned when the authenticated user lacks the required permission or OAuth scope.

One documented failure

  • forbidden

    Not authorized to manage knowledge base content

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

2 documented failures

  • content_snippet_not_found

    Content snippet 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 unauthenticated. A 403 is returned when the authenticated user lacks the manage_knowledge_base_content permission or the required read_write_content_snippets OAuth scope. A 404 is returned when the content_snippet_id path parameter or body id does not identify an existing snippet or tag. The body id field is required; admin_id, if supplied, attributes the tag to a teammate without changing authorization.