For the complete documentation index, see llms.txt. This page is also available as Markdown.

Blocklist

List blocklist entries

get

Returns the workspace suppression list (blocked domains and email addresses), newest first.

Authorizations
AuthorizationstringRequired
Query parameters
limitintegerOptional

Page size (default 100, max 1000)

offsetintegerOptional

Offset (default 0)

Header parameters
AuthorizationstringRequired

Bearer <API_KEY>

Responses
200

OK

application/json
totalCountintegerOptionalExample: 214
get/blocklist

Add blocklist entries

post

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.

Authorizations
AuthorizationstringRequired
Header parameters
AuthorizationstringRequired

Bearer <API_KEY>

Body
valuesstring[]Required

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

Example: ["competitor.com","jane@acme.com"]
Responses
200

OK

application/json
createdintegerOptional

Created is the number of new suppression entries written.

Example: 42
skippedintegerOptional

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

Example: 3
post/blocklist

Last updated