Retrieve dynamic content

Request

You can fetch a single dynamic content by its id.

Requires the read_dynamic_content or read_write_dynamic_content OAuth scope.

Security

bearerAuth

Path

idstringrequired

The unique identifier for the dynamic content.

Example:123

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:Preview

curl -i -X GET \
  https://api.intercom.io/dynamic_contents/123 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: Preview'

Responses

Successful response

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. Returned HTML-escaped, for example & as &.

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": "124",
  "name": "Refund policy",
  "key": "refund-policy",
  "content_type": "block",
  "default_locale": "en",
  "variations": [
    { … },
    { … }
  ],
  "created_at": 1663597223,
  "updated_at": 1663597223
}