Skip to main content
PATCH
Two settings decide which list a mid-call opt-out is written to. Both are off by default. With both off, opt-outs go to the calling organization’s own list. Partner-wide overrides reseller-wide. While it is on, every reseller under the partner reports enforced_by_partner: true, and a PATCH to a reseller setting returns 409 enforced_by_partner. The settings decide only where opt-outs are written. Every call is still checked against the organization, reseller and partner lists. Turning a setting off stops new opt-outs being written there; numbers already on the list stay blocked. Turning one on does not move existing organization entries. Every change is recorded with who made it. See Outbound Compliance. Both endpoints accept GET (read) and PATCH (change).

Who can use it

Path Parameters

string
Partner setting. The partner’s account UUID. It must be the account of your API key; any other id returns 404.
string
Reseller setting. The reseller’s UUID.

Request Body (PATCH)

boolean
required
true to turn the setting on, false to turn it off. No other fields are accepted.

Response

boolean
The level’s own setting.
boolean
Reseller setting only. true while partner-wide suppression is on: opt-outs go to the partner list and this setting cannot be changed.
A partner-wide opt-out blocks calls to that number from every business under the partner, including unrelated ones. That is why both settings are off by default. Check with counsel before turning one on.