Skip to main content
PATCH
Update an agent's blocked numbers

Authorizations

Authorization
string
header
required

An org API key: Authorization: Bearer phk_…

Headers

Phonely-Organization
string | null

Optional. Must be the key's org.

Path Parameters

id
string
required

The agent's ID.

Body

application/json

The numbers to block and unblock. Numbers not sent stay as they are.

add
string[]

Numbers to block, in E.164, such as +14155550100. One already blocked stays as it is.

Maximum array length: 1000
Pattern: ^\+[1-9]\d{6,14}$
remove
string[]

Numbers to unblock, in E.164. One that isn't blocked is ignored.

Maximum array length: 1000
Pattern: ^\+[1-9]\d{6,14}$

Response

Successful Response

The phone numbers an agent refuses calls from.

agent_id
string
required

The agent's ID.

object
string
default:agent_blocked_numbers
required

The type of this object, always agent_blocked_numbers.

Allowed value: "agent_blocked_numbers"
phone_numbers
string[]
required

Calls from these numbers are refused. In E.164, such as +14155550100, in ascending order.