Blocklist

Add blocklist entries

Adds up to 1000 suppression entries in one call. Each value is either a full email address (contains "@") or a bare domain. Existing entries and invalid values are skipped, so the call is safe to retry and suited to carrying over a suppression list from another sending platform. scope defaults to "workspace", which suppresses for the calling key's workspace only; "global" suppresses across every workspace on the account and requires a main workspace's key.

post/blocklist

Request

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

Request body

scope'workspace' | 'global'

Scope is "workspace" (default) or "global". A global entry suppresses across every workspace on the account and can only be written with a main workspace's API key.

valuesstring[] required

Values holds the email addresses and/or domains to block, up to 1000 per request.

Example request

{
  "scope": "workspace",
  "values": [
    "competitor.com",
    "jane@acme.com"
  ]
}

Response

OK

createdinteger

Created is the number of new suppression entries written.

scope'workspace' | 'global'

Scope is the list the entries were written to.

skippedinteger

Skipped is the number of values ignored because they already existed or failed validation.

Example response

{
  "created": 42,
  "scope": "workspace",
  "skipped": 3
}

Changes

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