Sign in
latestOpenAPI 3.1.1Proprietary – Contact us for usage terms2026-08-20173183551.4 KB

9da73dd2f99e

blacklist

Add a number to a user's blacklist

Adds a phone number to a user's personal blacklist. Once blacklisted, calls from this number to the user are blocked. An optional comment can be attached to explain why the number was blocked (e.g., "spam caller", "wrong number"). If the number is already blacklisted, the request returns 304 Not Modified.

Permission: Users Write required.

Monitoring impact:

  • OFF: Can only add to your own blacklist.
  • ON: Can add to any user's blacklist.
post/users/{userId}/blacklists/numbers

Path parameters

userIdinteger required
Example:123456

The identifier of the user

Request body

numberinteger

Phone number (E.164 format) (mandatory)

commentstring nullable

A comment about this blacklisted number

directionstring

IN (default value) or OUT for blacklisted numbers

Example request

{
  "number": 33184800000,
  "direction": "IN"
}

Response

Successful operation