Create dynamic content

Request

You can create dynamic content. Requires the read_write_dynamic_content scope.

Security

bearerAuth

Headers

Intercom-Versionstring(intercom_version)

Intercom API version.
By default, it's equal to the version set in the app package.

Default:"Preview"

Enum:"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example:Preview

Bodyapplication/jsonrequired

namestring, <= 255 charactersrequired

The name of the dynamic content. Must be unique in the workspace.

Example:"Support phone number"

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.

Enum:"inline""block"

Example:"inline"

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.

Example:"en"

variationsArray of objects, non-empty(Dynamic Content Variation Request)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.

curl -i -X POST \
  https://api.intercom.io/dynamic_contents \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Intercom-Version: Preview' \
  -d '{
    "name": "Support phone number",
    "content_type": "inline",
    "default_locale": "en",
    "variations": [
      {
        "locale": "en",
        "text_content": "+1-555-0100"
      },
      {
        "locale": "fr",
        "text_content": "+33 1 23 45 67 89"
      }
    ]
  }'

Responses

Dynamic content created

Bodyapplication/json

typestring

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

Example:"dynamic_content"

idstring

The unique identifier for the dynamic content.

Example:"123"

namestring

The name of the dynamic content.

Example:"Support phone number"

keystring

The identifier that articles use to reference the dynamic content. Derived from the name when the dynamic content is created, and never changes.

Example:"support-phone-number"

content_typestring

Whether the dynamic content is a short inline value (inline) or one or more blocks of content (block).

Enum:"inline""block"

Example:"inline"

default_localestring

The locale whose variation is used when there's no variation for the requested locale.

Example:"en"

variationsArray of objects(Dynamic Content Variation)

The variations of the dynamic content.

created_atinteger, (date-time)

The time the dynamic content was created as a Unix timestamp.

Example:1663597223

updated_atinteger, (date-time)

The time the dynamic content was last updated as a Unix timestamp.

Example:1663597223

Response

{
  "type": "dynamic_content",
  "id": "123",
  "name": "Support phone number",
  "key": "support-phone-number",
  "content_type": "inline",
  "default_locale": "en",
  "variations": [
    { … },
    { … }
  ],
  "created_at": 1663597223,
  "updated_at": 1663597223
}