Suppressions

List suppressions

Get the org suppression list: the emails and phone numbers excluded from automated messaging.

get/orgs/suppressions

Request

  • Base URL: https://api.useinvent.com
  • URL: https://api.useinvent.com/orgs/suppressions
  • Auth: HTTP bearer

Query parameters

searchstring

Search by email or phone identifier.

channel'EMAIL' | 'PHONE'

The channel an identifier is suppressed on

reason'BOUNCE' | 'COMPLAINT' | 'UNSUBSCRIBE' | 'MANUAL' | 'LEGAL'

Why the identifier is suppressed

source'WEBHOOK' | 'UNSUBSCRIBE_LINK' | 'ADMIN' | 'IMPORT' | 'API'

What put the identifier on the list

pagenumber

Page number

takenumber

Number of items to take

nextstring

Next page token (Only used on special endpoints)

progressiveboolean

Skip the total count: pagination-count is exact on the last page, and one more than the items so far while more pages exist (Only used on special endpoints)

Response

idstring required
channel'EMAIL' | 'PHONE' required

The channel an identifier is suppressed on

identifierstring required
reason'BOUNCE' | 'COMPLAINT' | 'UNSUBSCRIBE' | 'MANUAL' | 'LEGAL' required

Why the identifier is suppressed

source'WEBHOOK' | 'UNSUBSCRIBE_LINK' | 'ADMIN' | 'IMPORT' | 'API' required

What put the identifier on the list

notestring nullable required
created_atstring date-time required
updated_atstring date-time required

Changes

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