Update a voicemail box

Updates a voicemail box in place; supported fields you omit keep their current values. voicemail_options and voicemail_destinations are replaced wholesale by whatever array you send, and an empty array clears them, while voicemail_greetings is applied entry by entry according to each greeting_action rather than replacing the set. The mailbox keeps its own account and number: account or mailbox identifiers in the body, such as domain_uuid, voicemail_id and voicemail_uuid, do not retarget it. Authorization failures are reported as 400 rather than 403, and the child records are written after the main settings, so one of them can fail once the settings have already changed.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The mailbox's identifier.

Body Params
string

New mailbox password; when present it must be at least four characters after trimming, and an empty value is rejected.

number | null

The greeting to play; send null to clear it.

string | null

Alternate greeting to play; forwarded as sent, without conversion.

string | null

Email address to send voicemail to.

string | null

How the voicemail audio is attached to the email.

boolean

Whether to keep the message in the mailbox after emailing it.

boolean

Whether the mailbox accepts messages.

string | null

Description of the mailbox.

string | null

Phone number to notify by SMS.

boolean

Whether messages are transcribed.

boolean

Whether the first-login tutorial runs.

boolean

Whether the caller hears recording instructions.

boolean

Whether the caller hears the post-recording options.

string

Replaces the mailbox's keypad options wholesale when you send an array; an empty array clears them.

voicemail_destinations
array of objects

Replaces the copy destinations wholesale when you send an array; an empty array clears them.

voicemail_destinations
string

Applied entry by entry according to each greeting_action of create, update, delete or none — not a wholesale replacement.

Responses

401

Missing or invalid API key.

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json