Suppression APIs

Get Email Suppression Status

Changed on

This API checks if a specific email address is currently present in your suppression list. Suppressed addresses are excluded from all future email deliveries via the platform. The response provides suppression metadata including the email’s suppression status code, the time it was added, and the last modified timestamp. Use this endpoint to validate if an email is blocked from receiving communications and take corrective actions if needed.

get/suppressions/global/email/{email}

Request

  • Base URL
    https://emailapi.netcorecloud.net/v6
  • URL
    https://emailapi.netcorecloud.net/v6/suppressions/global/email/{email}
  • Auth
    HTTP bearer

Path parameters

emailstring email required

The email address you want to check for suppression status. Must be a valid email format (e.g., user@example.com).

Headers

on-behalf-ofstring

(Optional) Use this header when making API calls on behalf of a subaccount. Required only if you’re using a master account’s API key.

Response

Suppression status retrieved successfully.

emailstring email required
createdstring date-time required
modifiedstring date-time required
statusinteger required

Suppression status code indicating the type of block.<br> Example: 5 = globally suppressed.

Changes

    • warning

      deleted the header request parameter on_behalf_of

    • info

      added the new optional header request parameter on-behalf-of