Intercom API (unofficial showcase)
POST/articles/{article_id}/tags

Add a tag to an article

Applies an existing workspace tag to an article. Provide the tag's id in the request body and use article_id to identify the article. The authenticated teammate needs the manage_knowledge_base_content permission and the read_write_articles_scope OAuth scope.

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

2 parameters · 2 body fields
article_idintegerrequired
The unique integer identifier for the article 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. Provide the tag id; admin_id can optionally attribute the action to a teammate.

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 applied tag, including its ID and name.
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 or lacks the required OAuth scope.

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 teammate does not have the `manage_knowledge_base_content` permission.

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 article or tag does not exist.

2 documented failures

  • article_not_found

    Article 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 or lacks the read_write_articles_scope OAuth scope. A 403 is returned when the authenticated teammate lacks the manage_knowledge_base_content permission. A 404 is returned when the article_id path parameter does not identify an article or the body id does not identify an existing tag.