Intercom API (unofficial showcase)
PUT/content_snippets/{id}

Update a content snippet

Replaces the supplied fields on an existing content snippet while leaving omitted fields unchanged. Provide only the fields you want to update, and use either json_blocks or body_markdown for the content, not both. Pass an empty audience_ids array to clear audience targeting.

2 parameters · 8 body fields
idstringrequired
The unique identifier of the content snippet to update.
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

Fields to update on the content snippet. All fields are optional; only supplied fields are changed.

titlestringoptional
The title of the content snippet.
json_blocksarray<object>optional
The content blocks that make up the body of the snippet. Mutually exclusive with `body_markdown`.
body_markdownstringoptional
The content of the snippet in markdown. An alternative to `json_blocks` — you can provide content as markdown instead of structured blocks. Mutually exclusive with `json_blocks`.
localestringoptional
The locale of the content snippet.
audience_idsarray<integer>optional
The list of audience IDs to target this content snippet to for Fin AI Agent. Omitting the field leaves existing audience memberships unchanged (PATCH semantics). Pass `[]` to clear all audience memberships. Unknown audience IDs return a `404` error with no partial commit.
ai_chatbot_availabilitybooleanoptional
Whether the content snippet should be available for AI Chatbot (Fin).
ai_copilot_availabilitybooleanoptional
Whether the content snippet should be available for AI Copilot.
ai_sales_agent_availabilitybooleanoptional
Whether the content snippet should be available for AI Sales Agent.

3 status codes
200Returns the updated content snippet, including its current content, locale, availability settings, audience IDs, and timestamps.
typestringoptional
String representing the object's type. Always has the value `content_snippet`.
idstringoptional
The unique identifier for the content snippet.
titlestringoptional
The title of the content snippet.
localestringoptional
The locale of the content snippet.
json_blocksarray<object>optional
The content blocks that make up the body of the snippet.
body_markdownstringoptional
The body of the content snippet in markdown.
chatbot_availabilityintegerdeprecatedoptional
Deprecated. Use ai_chatbot_availability instead. Whether this snippet is available for Fin (1 = on, 0 = off).
copilot_availabilityintegerdeprecatedoptional
Deprecated. Use ai_copilot_availability instead. Whether this snippet is available for Copilot (1 = on, 0 = off).
ai_chatbot_availabilitybooleanoptional
Whether the content snippet is available for AI Chatbot (Fin).
ai_copilot_availabilitybooleanoptional
Whether the content snippet is available for AI Copilot.
ai_sales_agent_availabilitybooleanoptional
Whether the content snippet is available for AI Sales Agent.
created_atintegeroptional
The time the snippet was created as a UNIX timestamp.
updated_atintegeroptional
The time the snippet was last updated as a UNIX timestamp.
audience_idsarray<integer>optional
The list of audience IDs this content snippet is targeted to for Fin AI Agent. Empty array means no audience targeting is set.
404Returned when the content snippet or an audience ID does not exist; no partial changes are committed.

2 documented failures

  • not_found

    Content snippet not found

  • parameter_invalid

    audience_ids contains unknown audience IDs: 999

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
422Returned when the request fails validation.

One documented failure

  • validation_error

    The language is not currently supported for Fin

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 404 is returned when the content snippet or an audience ID does not exist. A 422 is returned when the request fails validation. The id path parameter must identify the snippet to update; title must not exceed 255 characters, and json_blocks and body_markdown cannot be supplied together.