Update a phone menu

patch

https://api.emaktalk.com/api/v1/ivr_menus/{menuId}

Updates a phone menu. A partial body is safe: your fields are merged over the current menu, so anything you omit is preserved. A sound field you send is replaced whole; one you omit keeps its sound. 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

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

menuId

string

required

The phone menu's UUID.

Body Params

name

string | null

Menu name.

extension

string | null

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

description

string | null

Free-text description.

language

string | null

Language the menu speaks in.

greet_long

The greeting played when the menu answers. Takes a recording, a stock prompt or a phrase, as a sound reference: an object whose type is one of the types below. null plays no greeting.

greet_short

The shorter greeting played when the menu repeats itself. Takes a recording, a stock prompt or a phrase, as a sound reference: an object whose type is one of the types below. null plays the long greeting instead.

invalid_sound

Played when the caller presses a key the menu doesn't offer. Takes a recording or a stock prompt, as a sound reference: an object whose type is one of the types below. null plays nothing.

exit_sound

Played as the menu exits. Takes a recording or a stock prompt, as a sound reference: an object whose type is one of the types below. null plays nothing.

exit_app / exit_app_category / exit_data

string | null

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

confirm_attempts / timeout / max_failures / max_timeouts

number | null

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

direct_dial

boolean | null

Whether callers may dial an extension directly from the menu.

ringback

What the caller hears while a call sent on by the menu rings. Takes a recording, music on hold, an internet stream, a ringback tone or silence, as a sound reference: an object whose type is one of the types below. null leaves the ringback the call already has.

cid_prefix / order

string | null

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

options

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

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The menu was updated; the updated menu is not returned, so re-read it.

403Your API key does not have the Admin role.

404No menu on your account has that id.

409A call flow owns this menu — edit the flow instead. This is checked before anything is written.

502The ownership check could not be completed, so nothing was written.

503try_again: your account's sounds couldn't be read just now, and nothing was changed. Wait the Retry-After seconds, then send the same request again.