Suppressed Email

Manage the account-level email suppression list. Suppressed emails are blocked from receiving any messages. Includes export functionality for bulk data extraction.

Show all suppressed emails

GET

https://api.cakemail.dev

/suppressed-emails

List all suppressed email addresses in the account.

Required scope(s): suppressions:read

Show all suppressed emails › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

page

integer · min: 1

Default: 1

per_page

integer · min: 1

Default: 50

with_count

boolean

Include count in the response

Default: false

filter

string

Valid Terms:

email

Valid Operators:

==

Query separator:

Valid Terms:

email

Valid Operators:

==

Query separator:

Show all suppressed emails › Responses

Successful Response

SuppressedEmailsResponse

object · required

Pagination metadata

SuppressedEmailResponse[] · required

List of suppressed emails

Add a suppressed email

POST

https://api.cakemail.dev

/suppressed-emails

Add an email address to the suppression list. Suppressed addresses are blocked from receiving any messages across all lists.

Required scope(s): suppressions:write

Add a suppressed email › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Add a suppressed email › Request Body

SuppressedEmail

email

string · minLength: 1 · required

Full email, a local part wildcard or a domain wildcard. Examples: @hotmail.com, john@, john@hotmail.com

Add a suppressed email › Responses

Successful Response

CreateSuppressedEmailResponse

email

string · required

Suppressed email address

created

boolean

Whether the suppression was created

Default: true

Delete a suppressed email

DELETE

https://api.cakemail.dev

/suppressed-emails/{email}

Remove an email address from the suppression list, allowing it to receive messages again.

Required scope(s): suppressions:delete

Delete a suppressed email › path Parameters

email

string · pattern: (^\*@[^@*]+\.[^@*]+$… · required

Full email, a local part wildcard or a domain wildcard. Examples: @domain.com, john@, john@domain.com

Delete a suppressed email › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Delete a suppressed email › Responses

Successful Response

DeleteSuppressedEmailResponse

email

string · required

Suppressed email address

deleted

boolean

Whether the suppression was deleted

Default: true

Show all Suppressed Emails Export

GET

https://api.cakemail.dev

/reports/suppressed-emails-exports

Show all Suppressed Emails Export.

Required scope(s): suppressions:read

Show all Suppressed Emails Export › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

page

integer · min: 1

Default: 1

per_page

integer · min: 1

Default: 50

with_count

boolean

Include count in the response

Default: false

Show all Suppressed Emails Export › Responses

Successful Response

ListSuppressedEmailsExportsResponse

object · required

Pagination details

SuppressedEmailsExportResponse[] · required

List of suppressed emails exports

Create a Suppressed Emails Export

POST

https://api.cakemail.dev

/reports/suppressed-emails-exports

Create a Suppressed Emails Export to a CSV file.

Required scope(s): suppressions:read

Create a Suppressed Emails Export › query Parameters

description

string

account_id

integer · min: 1

Optional Account ID to be used for the request

Create a Suppressed Emails Export › Responses

Successful Response

CreateSuppressedEmailsExportResponse

id

string · required

Export task id

object · required

Created export details

object

string

Object type

Default: task

created

boolean

Whether the export was created

Default: true

Show a Suppressed Emails Export

GET

https://api.cakemail.dev

/reports/suppressed-emails-exports/{export_id}

Show a Suppressed Emails Export.

Required scope(s): suppressions:read

Show a Suppressed Emails Export › path Parameters

export_id

string · required

Show a Suppressed Emails Export › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Show a Suppressed Emails Export › Responses

Successful Response

GetSuppressedEmailsExportResponse

object · required

Export details

Delete a Suppressed Emails Export

DELETE

https://api.cakemail.dev

/reports/suppressed-emails-exports/{export_id}

Delete a Suppressed Emails Export.

Required scope(s): suppressions:read

Delete a Suppressed Emails Export › path Parameters

export_id

string · required

Delete a Suppressed Emails Export › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Delete a Suppressed Emails Export › Responses

Successful Response

DeleteSuppressedEmailsExportResponse

id

string · required

Export task id

object · required

Deleted export details

object

string

Object type

Default: task

deleted

boolean

Whether the export was deleted

Default: true

Download a suppressed emails export

GET

https://api.cakemail.dev

/reports/suppressed-emails-exports/{export_id}/download

Returns the URL to download the exported CSV file.

Required scope(s): suppressions:read

Download a suppressed emails export › path Parameters

export_id

string · required

Download a suppressed emails export › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Download a suppressed emails export › Responses

Successful Response

DownloadSuppressedEmailsExportResponse

object · required

Download details

Domain Form