Phone Number

Update a phone number

Changed on

Relabels a number or changes which agent it is assigned to. A field left out is untouched; null clears it.

put/v1/phone-number/{phoneNumberId}

Request

  • Base URL
    https://api.roark.ai
  • URL
    https://api.roark.ai/v1/phone-number/{phoneNumberId}
  • Auth
    HTTP bearer

Path parameters

phoneNumberIdstring uuid required

Phone number ID

Request body

namestring nullable

New label; null clears it, omit to leave it alone

agentIdstring uuid nullable

Agent to assign the number to; null unassigns, omit to leave it alone

Response

The updated phone number

Example response

{
  "data": {
    "e164": "+14155550123"
  }
}

Changes