Agent Email
Create an email suppression
POST /v1/agent-email/suppressions · SDK createAgentEmailSuppression · CLI deployments email-suppression create
POST
Requires agent-email:admin.
platformBearerheader
AuthorizationBearer <token>Platform bearer credential accepted as an opaque API key or JWT.
x-deployments-environment*stringMatch
^[0-7][0-9A-HJKMNP-TV-Z]{25}$idempotency-key*stringLength
1 <= length <= 512application/json- body
address*stringMatch
^\S[\s\S]*\S$|^\S$|^$Length
3 <= length <= 320reason*stringValue in
"manual""policy"AgentEmailSuppressionResponse
application/json- response
address*stringMatch
^\S[\s\S]*\S$|^\S$|^$Length
3 <= length <= 320createdAt*stringMatch
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$Format
date-timeid*stringMatch
^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$organizationId*stringMatch
^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$reason*stringValue in
"bounce""complaint""manual""policy"sourceMessageId?stringMatch
^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$curl -X POST "https://example.com/v1/agent-email/suppressions" \ -H "x-deployments-environment: string" \ -H "idempotency-key: string" \ -H "Content-Type: application/json" \ -d '{ "address": "string", "reason": "manual" }'{ "address": "string", "createdAt": "2019-08-24T14:15:22Z", "id": "string", "organizationId": "string", "reason": "bounce", "sourceMessageId": "string"}