Blocklist

Get a blocklist entry

Returns one suppression entry by id. Entries inherited from the account-wide list are visible here too, and report scope "global".

get/blocklist/{id}

Request

  • Base URL: https://api.emailchaser.com/r
  • URL: https://api.emailchaser.com/r/blocklist/{id}
  • Auth: HTTP bearer

Path parameters

idinteger required

Blocklist entry ID

Response

OK

createdAtstring
domainstring
emailAddressstring

EmailAddress is the blocked address when the entry blocks one address rather than a whole domain.

idinteger
scope'workspace' | 'global'

Scope is "workspace" for the calling workspace's own entry, "global" for an account-wide one.

workspaceIdinteger

WorkspaceId is the workspace the entry is stored on. For a global entry read from a sub-workspace this is the main workspace, not the caller.

Example response

{
  "domain": "competitor.com",
  "emailAddress": "jane@acme.com",
  "id": 17,
  "scope": "workspace",
  "workspaceId": 12
}

Changes

No recorded changes to this operation across all 1 revision of this API.