Intercom API (unofficial showcase)
POST/contacts/{id}/banners/{view_id}/dismiss

Dismiss a banner for a contact

Records that a contact has dismissed a banner, with dismissals shared across surfaces for that contact. Supply the banner's view_id from the list banners response. Dismissing a banner that is already dismissed succeeds and returns the same response.

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

3 parameters
idstringrequired
The unique identifier of the contact whose banner to dismiss.
view_idstringrequired
The banner view identifier to dismiss, as returned by the list banners endpoint.
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 the banner dismissal result, including the dismissed `view_id` and a `dismissed` flag.
typestringoptional
String representing the object's type. Always has the value `banner_dismiss`.
view_idstringoptional
The id of the dismissed banner view.
dismissedbooleanoptional
Whether the banner view is dismissed.
404Returned when the banner view is not found.

One documented failure

  • not_found

    Resource 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 view_id path parameter does not identify a banner view. Supply the id path parameter for the contact and the view_id path parameter from the list banners response.