Suppressions

Suppress identifier

Add an email or phone number to the org suppression list. Suppressing an identifier that is already on the list refreshes its reason.

post/orgs/suppressions

Request

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

Request body

channel'EMAIL' | 'PHONE' required

The channel an identifier is suppressed on

identifierstring required

The email or phone number to suppress

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

Defaults to MANUAL

notestring nullable

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.