API ReferenceTelephony

Update IVR Menu Option Label

Re-label one option in the stored menu_tree, matched on the supplied DTMF value. The label is what the console displays in the detail panel and what the worker reads back at navigate time to surface the option semantically. Unknown DTMF values are a no-op (the response echoes the unchanged menu).

Authentication

AuthorizationBearer

Enter your API key with the Bearer prefix, e.g. ‘Bearer sk_…’.

Path parameters

idstringRequired

Request

This endpoint expects an object.
dtmfstringRequired

DTMF value of the option to relabel (e.g. “1”, ”*”, ”#”).

labelstringRequired<=256 characters

New label. Capped at 256 chars server-side.

Response

The refreshed menu shape.
idstring

Prefixed wire identifier (menu_<26 char Crockford base32>). URL paths accept only this prefixed form; legacy UUID path parameters are rejected with 404.

fingerprint_idstring
schema_versioninteger
menu_treeobject

Validated menu_tree per contracts/agents/ivr_menu.schema.json. Opaque to consumers other than the worker.

confidence_scoredouble
succeeded_traversalsinteger
total_traversalsinteger
last_validated_atdatetime
created_atdatetime
updated_atdatetime
tenant_idstring or null

Null on the cross-tenant promoted slot.

invalidated_atdatetime or null

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error