Skip to main content
POST
A number on a reseller’s list is never dialled by any organization under that reseller. A trigger for it is refused with 409 suppressed and suppression_scope: "reseller". See Outbound Compliance. GET returns one page of entries. POST adds a number. DELETE …/suppression-list/{number} removes one. The request and entry fields are the same as the organization list. Mid-call opt-outs are written here only while reseller-wide suppression is on and partner-wide suppression is off. Numbers added by hand block calls whatever the setting.

Who can use it

A reseller key sent to another reseller’s list gets 403 forbidden.

Path Parameters

string
required
The reseller’s UUID
string
DELETE only. The E.164 number, percent-encoded (%2B15105550123); the raw form is accepted too.

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.
string
default:"manual"
One of opt_out, manual, complaint, litigation, other.
string
Up to 1000 characters.
Adding a number cancels calls already queued or scheduled to it under every organization of the reseller. cancelled_calls in the response says how many. A call already dialling is not stopped. Adding a number that is already listed succeeds, returns existing: true, and still cancels pending calls.
Removals are audited: who removed the number, when, and the entry it replaced are kept.