Deployments.ai Docs
Agent Email

Remove an email suppression

POST /v1/agent-email/suppressions/{suppressionId}/remove · SDK removeAgentEmailSuppression · CLI deployments email-suppression remove

POST
/v1/agent-email/suppressions/{suppressionId}/remove

Requires agent-email:admin.

Authorization

platformBearer
headerAuthorizationBearer <token>

Platform bearer credential accepted as an opaque API key or JWT.

Path Parameters

suppressionId*string
Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Header Parameters

x-deployments-environment*string
Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
idempotency-key*string
Length1 <= length <= 512

Response Body

AgentEmailSuppressionResponse

application/json
  1. response
address*string
Match^\S[\s\S]*\S$|^\S$|^$
Length3 <= length <= 320
createdAt*string
Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$
Formatdate-time
id*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
organizationId*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
reason*string
Value in"bounce""complaint""manual""policy"
sourceMessageId?string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
curl -X POST "https://example.com/v1/agent-email/suppressions/string/remove" \  -H "x-deployments-environment: string" \  -H "idempotency-key: string"
{  "address": "string",  "createdAt": "2019-08-24T14:15:22Z",  "id": "string",  "organizationId": "string",  "reason": "bounce",  "sourceMessageId": "string"}