Blocklist

Update a blocklist entry

Changes the blocked value, the scope, or both. A value containing "@" is stored as an email address, otherwise as a domain, so an entry can be converted between the two. Moving an entry to or from the account-wide list requires a main workspace's key, and moves the entry onto the main workspace.

put/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

Request body

scope'workspace' | 'global'

Scope moves the entry between the workspace list and the account-wide list. Moving an entry to "global" requires a main workspace's key.

valuestring

Value is the new domain or email address. Which of the two the entry holds is re-inferred from whether the value contains "@", so an entry can be converted between a domain block and an address block.

Example request

{
  "scope": "global",
  "value": "competitor.com"
}

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.