Intercom API (unofficial showcase)
GET/contacts/{id}/banners

List banners for a contact

Lists the banners that a contact currently matches so you can display them outside the Messenger. Call this endpoint when you are about to show the banners, because requesting them records an impression for each returned banner. Use each banner's view_id with the dismiss endpoint to record a dismissal.

2 parameters
idstringrequired
The unique identifier of the contact whose matching banners to retrieve.
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

2 status codes
200Returns a list of banners the contact currently matches, with the content and `view_id` needed to display and dismiss each banner.
typestringoptional
String representing the object's type. Always has the value `list`.
dataarray<Banner>optional
An array of banners.
404Returned when the contact is not found.

One documented failure

  • not_found

    User Not Found

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 404 is returned when the id path parameter does not identify a contact. The id path parameter must identify the contact whose banners you want to retrieve.