Skip to main content
POST
curl

Authorizations

X-Api-Key
string
header
required

Your API key. In the dashboard, go to Integrations and open Deliveryman API Keys to create one.

Body

email
string<email>
required

Email address to suppress.

workspace_id
integer
required

Workspace to add the entry to.

type
enum<string>
default:unsubscribes

Whether the address is suppressed because it bounced (bounces) or opted out (unsubscribes). Defaults to unsubscribes.

Available options:
bounces,
unsubscribes

Response

Already Suppressed

An address that emails won't be sent to.

email
string
required

Suppressed email address.

type
enum<string>
required

bounces if the address bounced, unsubscribes if it opted out.

Available options:
bounces,
unsubscribes
workspace_id
integer
required

Workspace the entry belongs to.

added_on
string<date-time>
required
read-only

When the address was added to the list. ISO 8601, UTC.