Update phone number

This endpoint updates the editable attributes of a phone number you own. Currently this is the nickname — a short, human-friendly label (e.g. "Sales line", "Support — US") shown next to the number across the dashboard.

Only the owner of the number can update it. Numbers shared with you (granted) display the nickname but cannot be changed by you.

Path Parameters

Body Parameters

Response

  The unique identifier of the phone number

  The phone number in E.164 format

  The phone number's nickname (or `null` if not set)

  The ISO 3166-1 alpha-2 country code

  The type of phone number: `normal`, `sip`, or `caller_id`

{
  "message": "Phone number updated successfully.",
  "data": {
    "id": 1,
    "phone_number": "+14155551234",
    "nickname": "Sales line",
    "country_code": "US",
    "type": "normal"
  }
}

{
  "error": "Phone number not found."
}

{
  "message": "The nickname must not exceed 50 characters.",
  "errors": {
    "nickname": ["The nickname must not exceed 50 characters."]
  }
}