Skip to content
Home/
REST API Reference
/
/
Create a content snippet

Create a content snippet

Request

You can create a new content snippet.

title is listed as required, but a missing, null or empty title is accepted and the snippet is created with a blank title. When json_blocks is omitted or null and body_markdown is omitted or blank, the snippet is created with a single empty paragraph.

Requires the read_write_content_snippets OAuth scope.

Security
bearerAuth
Headers
Intercom-Versionstring(intercom_version)

Intercom API version.
If you omit the header, the API uses the version set in your app package, and 1.0 if none is set.

Enum:"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"
Example:2.17
Bodyapplication/jsonrequired
titlestring, <= 255 charactersrequired

The title of the content snippet. The API accepts a missing, null or empty title.

Example:"How to reset your password"
json_blocksArray of objects

The content blocks that make up the body of the snippet. Mutually exclusive with body_markdown.

Example:
[
  {
    "type": "paragraph",
    "text": "Navigate to Settings > Security > Reset password."
  }
]
body_markdownstring

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.

Example:"# Hello\n\nSome content.\n"
localestring

The locale of the content snippet. Defaults to en.

Default:"en"
Example:"en"
audience_idsArray of integers or null

The list of audience IDs to target this content snippet to for Fin AI Agent. Pass an empty array or omit the field for no audience targeting. Unknown audience IDs return a 404 error with no partial commit.

Example:
[
  1,
  2
]
ai_chatbot_availabilityboolean

Whether the content snippet should be available for AI Chatbot (Fin). Defaults to true.

Default:true
Example:true
ai_copilot_availabilityboolean

Whether the content snippet should be available for AI Copilot. Defaults to true.

Default:true
Example:true
ai_sales_agent_availabilityboolean

Whether the content snippet should be available for AI Sales Agent. Defaults to true.

Default:true
Example:true
curl -i -X POST \
  https://api.intercom.io/content_snippets \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Intercom-Version: 2.17' \
  -d '{
    "title": "How to reset your password",
    "json_blocks": [
      {
        "type": "paragraph",
        "text": "Navigate to Settings > Security > Reset password."
      }
    ],
    "locale": "en",
    "audience_ids": [
      1,
      2
    ]
  }'

Responses

Content snippet created

Bodyapplication/json
typestring

String representing the object's type. Always has the value content_snippet.

Example:"content_snippet"
idstring

The unique identifier for the content snippet.

Example:"123"
titlestring or null

The title of the content snippet.

Example:"How to reset your password"
localestring

The locale of the content snippet.

Example:"en"
json_blocksArray of objects

The content blocks that make up the body of the snippet. In responses, the blocks are returned as a JSON-encoded string rather than as an array.

Example:
[
  {
    "type": "paragraph",
    "text": "Navigate to Settings > Security > Reset password."
  }
]
body_markdownstring or null

The body of the content snippet in markdown.

Example:"Navigate to Settings \\> Security \\> Reset password.\n"
ai_chatbot_availabilityboolean

Whether the content snippet is available for AI Chatbot (Fin).

Example:true
ai_copilot_availabilityboolean

Whether the content snippet is available for AI Copilot.

Example:true
ai_sales_agent_availabilityboolean

Whether the content snippet is available for AI Sales Agent.

Example:true
created_atinteger

The time the snippet was created as a UNIX timestamp.

Example:1663597223
updated_atinteger

The time the snippet was last updated as a UNIX timestamp.

Example:1663597223
audience_idsArray of integers or null

The list of audience IDs this content snippet is targeted to for Fin AI Agent. Empty array means no audience targeting is set.

Example:
[
  1,
  2
]
chatbot_availabilityintegerdeprecated

Deprecated. Use ai_chatbot_availability instead.

Example:2
copilot_availabilityintegerdeprecated

Deprecated. Use ai_copilot_availability instead.

Example:2
Response
{
  "type": "content_snippet",
  "id": "456",
  "title": "How to reset your password",
  "locale": "en",
  "json_blocks": [
    { … }
  ],
  "body_markdown": "Navigate to Settings \\> Security \\> Reset password.\n",
  "chatbot_availability": 2,
  "copilot_availability": 2,
  "ai_chatbot_availability": true,
  "ai_copilot_availability": true,
  "ai_sales_agent_availability": true,
  "created_at": 1663597223,
  "updated_at": 1663597223,
  "audience_ids": [
    1,
    2
  ]
}