DeList Number

This API is used to delist and remove business numbers from the client account and its feature-set.

Replace the {{BaseURL}} with the one mentioned here

POST{{BaseURL}}/clients/{clientAccountId}/number_management/feature_sets/{featureSetId}/numbers/delist

{clientAccountId} : This can be taken directly from the self serve portal under the Manage API Keys Page

{featureSetId}: This can be taken directly from the feature set configuration page on the self serve portal

For Authorization Token kindly refer the Authentication section followed by Generate Access Token API

Headers

Name	Value
Content-Type	Required application/json
Authorization	Required Bearer <token>

Body

Name	Type	Validations	Description
phone_numbers	string	minLength: 1 maxLength: 10000	Required. List of phone numbers to be added to feature set

Request

JSON

{
  "phone_numbers": [
    "911234567891"
  ]
}

Response

200 OK

{
    "client_account_id": "91c173bb-28d8-4030-9722-8663ff9589f3",
    "phone_type": "",
    "processing_numbers": [],
    "new_numbers": [],
    "other_phonetype_numbers": [],
    "existing_numbers": [
        "911234567891"
    ],
    "others_numbers": [],
    "invalid_numbers": [],
    "other_feature_set_numbers": [],
    "status": "pending"
}

400 Bad Request

{
    "client_account_id": "91c173bb-28d8-4030-9722-8663ff9589f3",
    "phone_type": "",
    "processing_numbers": [],
    "new_numbers": [
        "911234567891"
    ],
    "other_phonetype_numbers": [],
    "existing_numbers": [],
    "others_numbers": [],
    "invalid_numbers": [],
    "other_feature_set_numbers": [],
    "status": "failed"
}