Skip to main content
PATCH
Rename a number
Changes the label you gave a number. Labels are for your own reference — Sales, Support, Warehouse. Nothing about sending depends on one.

Notes

  • label is required here (unlike on create, where it is optional) and is capped at 60 characters.
  • Renaming changes nothing else: the instance_id, the connection and the phone number are untouched.

Example

cURL

Authorizations

apikey
string
header
required

Your API key, sent in an apikey request header. Never in the URL, never as a Bearer token.

Path Parameters

id
string<uuid>
required

The instance_id of one of your numbers.

Body

application/json
label
string
required

The new label. Required, and up to 60 characters.

Required string length: 1 - 60
Example:

"Sales — Surat"

Response

Renamed.

success
boolean
data
object
request_id
string<uuid>