Intercom API (unofficial showcase)
POST/dynamic_contents

Create dynamic content

Creates reusable dynamic content that you can insert into Help Center articles. Provide a unique name, choose inline or block for content_type, and include at least one variation with a default-locale variation that applies to all brands. The authenticated user needs the read_write_dynamic_content scope.

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

1 parameter · 4 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

Dynamic content configuration, including its name, content type, default locale, and at least one variation.

namestringrequired
The name of the dynamic content. Must be unique in the workspace.
content_typestringrequired
Whether the dynamic content is a short inline value (`inline`) or one or more blocks of content (`block`). Can't be changed later.
Allowed:inlineblock
default_localestringrequired
The locale whose variation is used when there's no variation for the requested locale. `variations` must include a variation for this locale that applies to all brands.
variationsarray<DynamicContentVariationRequest>required
The variations of the dynamic content, one per locale and optionally per brand. Set `brand_id` on a variation to override the all-brands value for that brand. At least one is required.

4 status codes
201Returns the created dynamic content object, including its identifier, name, key, content type, default locale, variations, and creation and update timestamps.
typestringoptional
String representing the object's type. Always has the value `dynamic_content`.
idstringoptional
The unique identifier for the dynamic content.
namestringoptional
The name of the dynamic content.
keystringoptional
The identifier that articles use to reference the dynamic content. Derived from the name when the dynamic content is created, and never changes.
content_typestringoptional
Whether the dynamic content is a short inline value (`inline`) or one or more blocks of content (`block`).
Allowed:inlineblock
default_localestringoptional
The locale whose variation is used when there's no variation for the requested locale.
variationsarray<DynamicContentVariation>optional
The variations of the dynamic content.
created_atintegeroptional
The time the dynamic content was created as a Unix timestamp.
updated_atintegeroptional
The time the dynamic content was last updated as a Unix timestamp.
401Returned when the request is unauthorized.

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 dynamic content is not enabled.

One documented failure

  • api_plan_restricted

    Dynamic content is not enabled for this workspace

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

One documented failure

  • validation_error

    A dynamic content named 'Support phone number' already exists

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 authentication fails, a 403 when dynamic content is not enabled, and a 422 when the request fails validation. Include name, content_type, default_locale, and variations; content_type must be inline or block, and variations must contain at least one item. Each variation needs a locale, and the authenticated user needs the read_write_dynamic_content scope.