Skip to content
Home/
REST API Reference
/
/
Banner

Banner

A banner the contact currently matches, with the content and view identifier needed to display and dismiss it.

typestring

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

Example:"banner"
idstring

The id of the banner.

Example:"486517"
view_idstring

The id of the contact's view of this banner. Pass this to the dismiss endpoint to record a dismissal.

Example:"645719311"
titlestring or null

The banner's title. null when the banner has no title.

Example:"Hi there"
bodystring or null

The banner's body content as HTML.

Example:"<p class=\"no-margin\">Hi there!</p>"
stylestring

How the banner is displayed.

Example:"inline"
positionstring

Where the banner is positioned.

Example:"top"
show_dismiss_buttonboolean

Whether the banner should display a dismiss control.

Example:true
actionobject or null

The action a contact can take on the banner, or null when the banner has no action. The fields present depend on type: url (label, target), reaction (reaction_set), email_collector, or product_tour (tour_id, tour_url).

client_targetingArray of objects or null

Reserved for future use. Always null in the current version — banners that depend on client-side targeting rules (such as page URL or time on page) are not returned by this endpoint.

created_atinteger, (timestamp)

The time the contact's view of this banner was created.

Example:1780580493
{
  "type": "banner",
  "id": "486517",
  "view_id": "645719311",
  "title": "Hi there",
  "body": "<p class=\"no-margin\">Hi there!</p>",
  "style": "inline",
  "position": "top",
  "show_dismiss_button": true,
  "action": {
    "type": "url",
    "label": "Learn more",
    "target": "https://www.intercom.com/pricing",
    "reaction_set": [ … ],
    "tour_id": "12345",
    "tour_url": "https://app.intercom.com/tours/12345"
  },
  "client_targeting": [
    {}
  ],
  "created_at": 1780580493
}