[POST] Number delisting

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

Delist Numbers

This endpoint removes and de-lists numbers from the published feature sets.

POST/clients/{clientAccountId}/number_management/feature_sets/{featureSetId}/numbers/delist
Authorization
Path parameters
client_account_id*string

Client Account ID of the caller, taken from path params

feature_set_id*string

Feature Set ID, taken from path params

Body
phone_numbers*array of string

List phone numbers to be removed from feature set

Response
Body
client_account_idstring
existing_numbersarray of string
invalid_numbersarray of string
new_numbersarray of string
other_feature_set_numbersarray of string
other_phonetype_numbersarray of string
others_numbersarray of string
phone_typestring
processing_numbersarray of string
statusstring
Request
const response = await fetch('/clients/{clientAccountId}/number_management/feature_sets/{featureSetId}/numbers/delist', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "phone_numbers": [
        "text"
      ]
    }),
});
const data = await response.json();
Response
{
  "client_account_id": "text",
  "existing_numbers": [
    "text"
  ],
  "invalid_numbers": [
    "text"
  ],
  "new_numbers": [
    "text"
  ],
  "other_feature_set_numbers": [
    "text"
  ],
  "other_phonetype_numbers": [
    "text"
  ],
  "others_numbers": [
    "text"
  ],
  "phone_type": "text",
  "processing_numbers": [
    "text"
  ],
  "status": "text"
}

Last updated

© 2024 Truecaller AB