CLclose
blocked_phone_numbers

Create a Blocked Phone Number

Changed on

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.
post/blocked_phone_number/

Request

  • Base URL
    https://api.close.com/api/v1
  • URL
    https://api.close.com/api/v1/blocked_phone_number/
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://app.close.com/oauth2/authorize/
      Token URL: https://api.close.com/oauth2/token/

Request body

phonestring required

The phone number that you wish to block.

reasonstring required

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

Response

Successful response

created_bystring required

User who created this Blocked Number initially.

date_createdstring date-time required

When this Blocked Number was created.

date_updatedstring date-time required

When this Blocked Number was last updated.

idstring required
organization_idstring required
phonestring required

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

reasonstring required

The reason for blocking the given phone number.

updated_bystring required

User who most recently updated this Blocked Number.

Changes

  • 2ff98656cc2aRevision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status