MailerDeleteSuppression¶

DELETE mailer/suppression

Removes an address from the suppression list. The entry can be addressed either by id or by the address — an operator holding an email address should not have to look up an id first.

Removing an entry means writing again to an address that once bounced or complained. It is an administrative decision and is journalled as one.

Access Control¶

Allowed role: admin.

Request¶

RESTTCPSDK

DELETE request

DELETE https://{broker_domain}/mailer/[email protected]
Authorization: <JWT_TOKEN>

{
  "command": "MailerDeleteSuppression",
  "extID": "1",
  "data": {
    "email": "[email protected]"
  }
}

const res = await platform.MailerDeleteSuppression({
  email: "[email protected]"
});

Request Data¶

Field	Type	Required	Description
`id`	int	No	Suppression entry id
`email`	string	No	Address, in any case; used when `id` is not given

Response Data¶

removed is how many rows were cleared — normally one. Deleting by id answers with that id instead.

{
  "email": "[email protected]",
  "removed": 1,
  "deleted": true
}

Errors¶

Code	Error	Description
`400`	`VALIDATION_ERROR`	Neither `id` nor `email` was provided
`404`	`NOT_FOUND`	The address is not suppressed in this brand