Opt-outs

List opt-outs

Who has opted out, on which channel, when, and how. starting_after is an opaque cursor here, not an id. Requires the read scope.

get/opt-outs

Request

  • Base URL: https://sumgenius.ai/api/v1
  • URL: https://sumgenius.ai/api/v1/opt-outs
  • Auth: one of:
    • API key in header X-SumGenius-Api-Key
    • HTTP bearer

Query parameters

channel'facebook' | 'instagram' | 'sms' | 'telegram' | 'whatsapp'

Channel.

status'opted_out' | 'opted_in'

opted_in returns SMS rows only; Meta channels are always opted_out.

scope'comment_dm' | 'broadcast' | 'all'

Meta channels only.

sincestring date-time

ISO-8601 UTC on recorded_at.

limitinteger

Page size, 1 to 100. Default 25.

starting_afterstring

The next_cursor from the previous page.

Response

A page

has_moreboolean required
next_cursorstring nullable required

Pass as starting_after for the next page. Null on the last page.

Changes

No recorded changes to this operation across all 1 revision of this API.