Create blocked spam source

Adds a new IP address, CIDR range, email address, or email domain to the organization's spam blocklist. Once added, future applications arriving from a matching source are auto-rejected at intake; the entry does not retroactively reject existing applications. The combination of source_type and value must be unique within the organization, IP and CIDR values must be well-formed, and a small set of common consumer email domains is protected from being blocked.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required

Kind of identifier value represents. ip_address accepts a single IPv4 or IPv6 address; cidr_block accepts an IPv4 or IPv6 CIDR range (very large subnets — IPv4 prefix <= 8 or IPv6 prefix <= 32 — are rejected); email_address accepts a full address; email_domain accepts a domain (the part after @). Picking the wrong kind for the supplied value returns 422.

Allowed:
string
required
length ≤ 255

The IP, CIDR range, email address, or domain to block, matching the chosen source_type. The value is normalized (stripped and lowercased) before being stored, and must be unique per source_type within the organization. Common consumer email domains (gmail.com, outlook.com, hotmail.com, hotmail.co.uk, icloud.com, yahoo.com, live.com, aol.com, protonmail.com) cannot be blocked and return 422.

string
length ≤ 255

Optional free-text annotation, typically used to record why the source was added (e.g. ticket id, internal incident reference). Limited to 255 characters.

Responses

401

Unauthorized

403

Forbidden

422

Unprocessable Content

Language
Credentials
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json