Requests the caller ID name displayed alongside a project-owned phone number on outbound calls. Caller ID name is available only for numbers whose carrier offers it. This operation sets the outbound name for your own number; to retrieve the name published for another number, use Look up phone number with include=cnam.

A 201 means SignalWire accepted the request, not necessarily that call recipients see the name yet. A new name, or one previously rejected or failed, returns with status set to pending and is queued for compliance review. Poll Get the caller ID name until status is approved, rejected, or failed.

Re-requesting a name already approved for this phone number returns the existing request with 201 and status still approved. SignalWire re-applies that name at the carrier without another compliance review.

A phone number can have only one request awaiting a decision. Submitting a different name supersedes any earlier request with a pending or in_review status.

SignalWire normalizes name before validating it, so apply the length and character rules to the normalized form described on that field. When the phone number's carrier does not offer caller ID name, the operation returns 422 with an item in errors whose detail is Caller ID name isn't available for this number. Other 422 responses mean name was blank or the normalized name did not meet those rules.

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.

{
  "name": "Acme Plumbing"
}

{
  "name": "ACME PLUMBING"
}