Create a Blocked Phone Number

View as MarkdownOpen in Claude
Once this record is created, the phone number you have specified will no longer work for outbound nor inbound calls. That means: * Nobody in your organization will be able to call that phone number. * That phone number will not be able to call anybody in your organization.

Authentication

AuthorizationBasic
Use your API key as the username and leave the password empty.
OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
phonestringRequired

The phone number (in E.164 format) that you wish to block.

reasonstringRequired
The reason why you wish to block a given phone number.

Response

Successful response
created_bystring
User who created this Blocked Number initially.
date_createddatetime
When this Blocked Number was created.
date_updateddatetime
When this Blocked Number was last updated.
idstring
organization_idstring
phonestring

The phone number (in E.164 format) to block.

reasonstring
The reason for blocking the given phone number.
updated_bystring
User who most recently updated this Blocked Number.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error