Skip to main content
POST
Block a domain or address

Authorizations

Authorization
string
header
required

Personal API key created in the dashboard under Settings > API keys.

Query Parameters

website_id
integer
required

Target website id

Body

application/json
value
string
required
Required string length: 3 - 254
scope
enum<string>
default:domain
Available options:
domain,
email
reason
string | null
Maximum string length: 300

Response

Successful Response

id
integer
required
scope
enum<string>
required
Available options:
domain,
email
value
string
required
reason
string | null
created_by_user_id
integer | null
created_by_name
string | null
created_at
string<date-time> | null
removed_at
string<date-time> | null
removed_by_user_id
integer | null