Scheduler Zero
REST APIAPI referenceBlocklist

Block one or more email addresses

Addresses are stored lowercase and deduplicated. Requires the `blocklist:create` permission.

POST
/settings/blocked-emails

Addresses are stored lowercase and deduplicated. Requires the blocklist:create permission.

Authorization

ApiKeyAuth
x-api-key<token>

API key created under Settings → API Keys. Scoped to a single workspace.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/settings/blocked-emails" \  -H "Content-Type: application/json" \  -d '{    "emails": [      "user@example.com"    ]  }'
{  "inserted": 0}

Get the authenticated workspace identity GET

Returns the workspace the credential belongs to and the permissions the key holds. Use this to validate a key and label a connection. Requires only a valid key (no specific scope).

List blocked email addresses GET

Requires the `blocklist:read` permission.