Skip to main content
POST
Add phone numbers to block list
Adds phone numbers to an agent’s block list. The API key must belong to the supplied user, and that user must have access to the agent. The response separates numbers that were added from numbers that failed validation or were already blocked. Handle both arrays because a request can partially succeed.

Authorizations

X-Authorization
string
header
required

Body

application/json
uid
string
required

User ID

agentId
string
required

The ID of the agent

numbers
string[]
required

Array of phone numbers to add or remove from the block list

Minimum array length: 1

Response

Successful response

message
string
required

Success message

added
string[]
required

Array of phone numbers that were successfully added

failed
object[]
required

Array of numbers that failed to be added and the reason

Last modified on August 10, 2026