Update a phone menu

Updates a phone menu. A partial body is safe: your fields are merged over the current menu, so anything you omit is preserved. options is the exception — sending the array deletes and recreates every key press, so omit the key to keep the stored ones. The updated menu is not returned, so re-read it with GET /api/v1/ivr_menus/{menuId}; and a menu owned by a call flow answers 409 before anything is written. Identity fields are not settable here: the record's own id, its account, and its call-routing id are always taken from the stored record, and sending them has no effect.

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

The phone menu's UUID.

Body Params
string | null

Menu name.

string | null

The number the menu answers on. A number in the reserved 10000–19999 range is refused with 400 (code reserved_extension_band).

string | null

Free-text description.

string | null

Language the menu speaks in.

string | null

Greeting played when the menu answers the call.

string | null

Prompt played when the caller presses something the menu does not offer.

string | null

Prompt played as the menu exits.

string | null

The exit action, its picker label and its argument. To clear the action, set all three to null together.

number | null

Confirmation attempts, digit timeout, and the number of invalid entries and timeouts the menu accepts before it exits.

boolean | null

Whether callers may dial an extension directly from the menu.

string | null

Ringback audio, the caller-ID prefix added to calls leaving the menu, and the display ordering hint.

string

Replaces the menu's key presses wholesale — every stored option is deleted and recreated from this array. Omit the key to leave them alone.

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