Dismiss a banner for a contact

Request

Records that a contact has dismissed a banner. Dismissals are shared across surfaces, so a banner dismissed through this endpoint will also stop appearing in the web Messenger for that contact, and vice versa.

The request is idempotent: dismissing an already-dismissed banner succeeds and returns the same response.

Security

bearerAuth

Path

idstringrequired

The unique identifier of a contact.

view_idstringrequired

The view_id of the banner to dismiss, as returned by the list banners endpoint.

Intercom-Versionstring(intercom_version)

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

Default:"2.16"

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

Example:2.16

curl -i -X POST \
  'https://api.intercom.io/contacts/{id}/banners/{view_id}/dismiss' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.16'

Responses

Successful response

Bodyapplication/json

typestring

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

Example:"banner_dismiss"

view_idstring

The id of the dismissed banner view.

Example:"645719311"

dismissedboolean

Whether the banner view is dismissed.

Example:true

Response

{
  "type": "banner_dismiss",
  "view_id": "645719311",
  "dismissed": true
}