Skip to main content
POST
A number on an organization’s suppression list is never dialled by that organization’s agents: a trigger for it is refused with 409 suppressed. The list is per organization — a sibling organization under the same account can still call the number. See Outbound Compliance. GET returns one page of entries. POST adds a number.

Path Parameters

string
required
The organization’s UUID

Query Parameters (GET)

integer
default:"1"
Page number
integer
default:"50"
Entries per page (max 100)

Request Body (POST)

string
required
E.164, e.g. +15105550123. Matched exactly against the dialled number — no national-format or fuzzy matching.
string
default:"manual"
One of opt_out, manual, complaint, litigation, other.
string
Up to 1000 characters — where the request came from, for example.
Adding a number that is already listed succeeds rather than erroring, so a do-not-call request is never lost to a duplicate. The author of an entry is taken from the API key, not from the request body.