Banners

Retrieve the banners a contact matches and record dismissals, so you can display banners on surfaces outside the Messenger (native mobile apps, kiosks, embedded tools). These endpoints require an OAuth token with the read_write_users scope. Requesting a contact's banners records an impression for each banner returned, and dismissals are shared with the web Messenger.

Operations

Example

List banners for a contact, with the TypeScript SDK:

import { Intercom } from "@octridev/intercom";

const client = new Intercom({
  // Optional: replaces the default server and any server an operation declares.
  baseUrl: "https://api.intercom.io",
  auth: { bearerAuth: process.env.API_TOKEN! },
});

const result = await client.banners.list({
  id: "-1",
});
console.log(result);