Skip to main content
Mail APIs

DeleteSuppressedDestination

DeleteSuppressedDestination

Overview

This API is used to remove an email address from the suppression list.

Suppressed emails will bounce. See reporting details of this on the Mail Failed page.

Permissions

To run this API, the nominated 'web-services' role needs to be given permission.
If you are not actively using the API, leave the permission off for better security.
Go to Roles / Apis and check on Mail:SuppressedDestinationDelete.

Input Fields (Header)

  • Header should contain the 'accept' Key with the Value = 'application/problem+json' or application/vnd.catch-e-api.v1+json.

Input Fields (Body)

JSON Field

Format

Notes

Mandatory

email_address

Int

email address

Yes

URL Examples

https://api.test.catch-e.com/docs/#/Mail/deleteSuppressedDestination 

Response Details

Validation Messages

204 No Content

Email Address has been deleted from the suppression list

401 - Unauthorized

{
    "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
    "title": "Unauthorized",
    "status": 401,
    "detail": "Unauthorized"
}

You have not authenticated before running this API or the token_timeout of the current session has passed. You need to authenticate again.

403 - Forbidden

{
    "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
    "title": "Forbidden",
    "status": 403,
    "detail": "Forbidden"
}

You do not have permissions for this request. Navigate to the Roles / APIs tab to make sure the permission you need to run this API is checked.

404 - Email Address Not Found

{
    "validation_messages": {
        "message for this task
        }
    },
    "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
    "title": "Unprocessable Entity",
    "status": 404,
    "detail": "Email Address Not Found"
}

406 - Not Acceptable

{
    "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
    "title": "Not Acceptable",
    "status": 406,
    "detail": "Not Acceptable"
}

500 - Unexpected error

{
    "status": 500,
    "title": "Unexpected error",
    "describedBy": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
    "detail": "",
}