Update phone number

Update a phone number properties, this can be used to change the name, assign an inbound agent or enable/disable redirect. The response includes the updated phone number details and headers about rate limiting.

Authorizations

X-Api-Key · string · header · required

The API Key created in Rounded Studio.

• You can create it by going to the "API Keys" settings of your profile.
• Need help? You can email us at [e-mail] or join our Discord community.

Path Parameters

phone_number_id · string<uuid> · required

The ID of the phone number to update.

Body

application/json

The phone number data to update.

name · string | null

The phone number friendly name.

inbound_agent_id · string<uuid> | null

The agent ID that will handle incoming calls to this phone number.

redirect · boolean | null · default: false

Whether to redirect the phone number.

redirect_phone_number · string | null

The phone number to redirect to.

Response

200

application/json

Successfully updated phone number

message · string · required

data · object · required

PSTN Phone Number

Show child attributes

error · object | null

Show child attributes

Example:

{
  "details": [
    {
      "field": "email",
      "message": "Invalid email format"
    }
  ],
  "message": "An error occurred while processing your request",
  "status": 400,
  "type": "generic_error"
}

status · integer · default: 200

HTTP status code of the response.