Skip to main content
POST
Add Blacklist Phone Number

Path Parameters

blacklist_id
string
required

The blacklist to add to.

phone_number
string
required

The number to add, E.164. Compared to the list exactly as written, so send it in the same form you read back from GET.

Body

application/json
reason
enum<string>
required

Why the number is on the list. This is what the platform acts on: inbound-fallback reasons route the caller to a person, the rest stop us contacting them.

Available options:
HUMAN_ONLY,
UNPROCESSABLE_BY_PHONE,
WRONG_PHONE_NUMBER,
IVR_LOOP,
SERVICE_NOT_AVAILABLE,
DISCONNECTED,
INPUT_DATA_ISSUE,
NOT_FOUND,
MEMBER_CONSENT_REQUIRED,
NOT_ALL_DATA_POINTS_RETRIEVED,
DNC_REQUESTED,
NOT_INTERESTED_RIGHT_NOW,
WRONG_USER,
MANAGER_REQUESTED,
PROVIDER_NO_LONGER_AT_LOCATION,
DATA_ISSUE,
TRANSFER_HANG_UP,
SMS_OPT_OUT,
TWILIO_OPT_OUT,
INBOUND_HUMAN_REQUESTED,
INBOUND_PRIORITY_CALLER
name
string | null

Optional label shown beside the number.

comment
string | null

Optional free text. Worth saying where the number came from, since whoever reads the list next will not know.

level
enum<string> | null

Severity. Ignored for inbound-fallback reasons, which are always stored critical_risk so the nightly cleanup cannot expire them. Omit it to keep what the number already has, or high_risk if it is new.

Available options:
low_risk,
high_risk,
critical_risk

Response

The number was already on the list.

phone_number
string
required

The number as stored.

reason
string
required

Why the number is on the list.

level
string
required

Severity.

name
string | null
required

Label, if one was given.

comment
string | null
required

Free text, if any was given.