Cakemail Logo
Cakemail API

​Suppressed Email (1.18.25)

Endpoint:https://api.cakemail.dev

​Show all suppressed emails

GET
https://api.cakemail.dev
/suppressed-emails

​Show all suppressed emails › query Parameters

  • account_idinteger · min: 1
  • pageinteger · min: 1
    Default: 1
  • per_pageinteger · min: 1
    Default: 50
  • with_countboolean
  • filterstring

​Show all suppressed emails › Responses

    • paginationobject · required
    • dataobject[] · required

​Add a suppressed email

POST
https://api.cakemail.dev
/suppressed-emails

​Add a suppressed email › query Parameters

  • account_idinteger · min: 1

​Add a suppressed email › Request Body

  • emailstring · minLength: 1 · required

​Add a suppressed email › Responses

    • emailstring · required
    • createdboolean
      Default: true

​Delete a suppressed email

DELETE
https://api.cakemail.dev
/suppressed-emails/{email}

​Delete a suppressed email › path Parameters

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

​Delete a suppressed email › query Parameters

  • account_idinteger · min: 1

​Delete a suppressed email › Responses

    • emailstring · required
    • deletedboolean
      Default: true

​Show all Suppressed Emails Export

GET
https://api.cakemail.dev
/reports/suppressed-emails-exports

​Show all Suppressed Emails Export › query Parameters

  • account_idinteger · min: 1
  • pageinteger · min: 1
    Default: 1
  • per_pageinteger · min: 1
    Default: 50
  • with_countboolean

​Show all Suppressed Emails Export › Responses

    • paginationobject · required
    • dataobject[] · required

​Create a Suppressed Emails Export

POST
https://api.cakemail.dev
/reports/suppressed-emails-exports

​Create a Suppressed Emails Export › query Parameters

  • descriptionstring
  • account_idinteger · min: 1

​Create a Suppressed Emails Export › Responses

    • idstring · required
    • dataobject · required
    • objectstring
      Default: task
    • createdboolean
      Default: true

​Show a Suppressed Emails Export

GET
https://api.cakemail.dev
/reports/suppressed-emails-exports/{export_id}

​Show a Suppressed Emails Export › path Parameters

  • export_idstring · required

​Show a Suppressed Emails Export › query Parameters

  • account_idinteger · min: 1

​Show a Suppressed Emails Export › Responses

    • dataobject · required

​Delete a Suppressed Emails Export

DELETE
https://api.cakemail.dev
/reports/suppressed-emails-exports/{export_id}

​Delete a Suppressed Emails Export › path Parameters

  • export_idstring · required

​Delete a Suppressed Emails Export › query Parameters

  • account_idinteger · min: 1

​Delete a Suppressed Emails Export › Responses

    • idstring · required
    • dataobject · required
    • objectstring
      Default: task
    • deletedboolean
      Default: true

​Download a suppressed emails export

GET
https://api.cakemail.dev
/reports/suppressed-emails-exports/{export_id}/download

​Download a suppressed emails export › path Parameters

  • export_idstring · required

​Download a suppressed emails export › query Parameters

  • account_idinteger · min: 1

​Download a suppressed emails export › Responses

    • dataobject · required
ReportToken