Sign in
Numbers

Update Number

Update the specified resource in storage.

put/numbers/{number}

Path parameters

numberinteger required

The ID of the number to update

Request body

labelstring

A label for the number

use_ai_ivrboolean

Whether the AI receptionist answers on this number

ai_ivr_agent_idstring nullable

ElevenLabs agent external ID to route calls through AI IVR

ai_answer_triggersstring[] nullable

When the AI receptionist answers. Empty/null means every call.

use_extensionsboolean

Whether to use extensions

recordboolean

Whether to record calls

sms_enabledboolean

Whether SMS is enabled

mms_enabledboolean

Whether MMS is enabled

sms_notification_emailstring email

Email to notify for SMS

sms_notification_email_additionalstring[]

Additional emails to notify for SMS

voicemail_notification_emailstring email

Email to notify for voicemail

voicemail_notification_email_additionalstring[]

Additional emails to notify for voicemail

fax_notification_emailstring email

Email to notify for fax

fax_notification_email_additionalstring[]

Additional emails to notify for fax

number_template_idinteger

ID of the number template to apply

sms_notification_phonestring

Phone number to notify for SMS

sms_notification_phone_additionalstring[]

Additional phone numbers to notify for SMS

voicemail_notification_phonestring

Phone number to notify for voicemail

voicemail_notification_phone_additionalstring[]

Additional phone numbers to notify for voicemail

tagsinteger[]

Array of tag IDs

Example request

{
  "label": "Sales Line",
  "routes": [
    {
      "forwards": [
        {
          "number": "+18005551234"
        }
      ]
    }
  ],
  "sms_notification_phone": "+18005551234",
  "sms_notification_phone_additional": [
    "+18005551234"
  ],
  "voicemail_notification_phone": "+18005551234",
  "voicemail_notification_phone_additional": [
    "+18005551234"
  ]
}

Response

Updated successfully

Changes

No recorded changes to this endpoint across all 1 revision of this API.