Intercom API (unofficial showcase)
POST/content/bulk_actions

Run a bulk action on Knowledge Hub content

Applies an asynchronous bulk action to up to 1,000 Knowledge Hub content items. Choose an action and provide content IDs of supported types; actions can publish, unpublish, delete, change availability or audience, or update tags. The request is enqueued for background processing, and items with unsupported types for the selected action may be silently dropped.

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

1 parameter · 5 body fields
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

Bulk action request. Provide the required action and content_ids, plus action-specific fields when needed.

actionstringrequired
The bulk action to perform. Allowed `content_ids[].type` values vary per action: * `publish`, `unpublish`: `article_content` * `delete`: `article_content`, `content_snippet`, `file_source_content`, `internal_article` * `set_availability`, `set_audience`: `article_content`, `content_snippet`, `external_content`, `file_source_content`, `internal_article` * `update_tags`: `article` (the parent Article id, not `article_content`), `content_snippet`, `external_content`, `file_source_content`, `internal_article`
Allowed:publishunpublishdeleteset_availabilityset_audienceupdate_tags
content_idsarray<object>required
Up to 1,000 content items to apply the action to.
availabilityobjectoptional
Required when `action` is `set_availability`. Each field is optional — only the properties present in the request are toggled.
audienceobjectoptional
Required when `action` is `set_audience`. Manages segment membership.
tagsobjectoptional
Required when `action` is `update_tags`. Applies and/or removes existing tags. Supply at least one of `add_tag_ids` / `remove_tag_ids`. At most 100 distinct tag IDs may be supplied across `add_tag_ids` and `remove_tag_ids` combined. Tag IDs must reference existing, non-archived tags; exceeding the limit or referencing unknown or archived IDs is rejected with `parameter_invalid` (HTTP 422).

4 status codes
202Returns a placeholder envelope confirming that the bulk action work has been enqueued.
typestringoptional
statusstringoptional
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 token does not have the `write_content` OAuth scope.
typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
422Returned when the action, content IDs, or action-specific parameters are invalid.
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 token lacks the write_content OAuth scope. A 422 is returned when the action, content IDs, or action-specific parameters are invalid. action and content_ids are required, and content_ids can contain at most 1,000 items; each item must include type and id. update_tags requires at least one of add_tag_ids or remove_tag_ids, and the supplied tag IDs must reference existing, non-archived tags.