Skip to main content
POST
Add to email stop-list

Authorizations

Authorization
string
header
required

Access token issued by gtm.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Headers

Email-Box-SID
string

Email server (em_bx_...) the call is for, from search_email_boxes. Omitted: the primary server.

Pattern: ^em_bx_[A-Za-z0-9]{12}$

Body

application/json

Request body of create_email_suppression.

address
string<email> | null

One address.

Maximum string length: 320
addresses
string<email>[] | null

1 to 1000 addresses; a repeat inside the list counts once.

Required array length: 1 - 1000 elements
Maximum string length: 320
reason
string | null

A note kept on every row this call makes.

Maximum string length: 512

Response

create success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
create
item
object
required
already_exists
boolean
required
meta
object
required