Clear caller ID name

DELETE

https://{your_space_name}.signalwire.com/api/relay/rest/phone_numbers/:id/cnam

Queues removal of the caller ID name from a phone number in your project. A 204 means SignalWire accepted the request; the applied name remains available as cnam on the phone number until the carrier confirms the removal. After confirmation, cnam becomes null and SignalWire cancels any request still pending or in_review.

SignalWire first checks whether the phone number’s carrier offers caller ID name. If it does not, the operation returns 422 with an item in errors whose detail is Caller ID name isn't available for this number. For a supported phone number, there must be an applied name or a request awaiting a decision; otherwise the operation returns 422 because there is nothing to clear.

Returns 404 when the phone number is not in your project.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Numbers.

Learn more about API scopes.

Queues removal of the caller ID name from a phone number in your project. A `204` means SignalWire accepted the request; the applied name remains available as `cnam` on the phone number until the carrier confirms the removal. After confirmation, `cnam` becomes `null` and SignalWire cancels any request still `pending` or `in_review`. SignalWire first checks whether the phone number's carrier offers caller ID name. If it does not, the operation returns `422` with an item in `errors` whose `detail` is `Caller ID name isn't available for this number.` For a supported phone number, there must be an applied name or a request awaiting a decision; otherwise the operation returns `422` because there is nothing to clear. Returns `404` when the phone number is not in your project. #### Permissions The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Numbers_. [Learn more about API scopes](/docs/platform/your-signalwire-api-space).

Authentication

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)

SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Path parameters

idstringRequiredformat: "uuid"

Unique ID of the phone number.

Response

There is no content to send for this request, but the headers may be useful.

Errors

401

Unauthorized Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error