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>). ADR 0015 Cluster 2 hard-break: URL paths accept only this prefixed form; legacy UUID path parameters are rejected with 404 as of Cluster 2.

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

$	curl -X PATCH https://api.speechify.ai/v1/agents/ivr-menus/id \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"dtmf": "string",
>	"label": "string"
>	}'

1	{
2	"id": "menu_01k8wn821ypk214y4km844wq28",
3	"fingerprint_id": "string",
4	"schema_version": 1,
5	"menu_tree": {},
6	"confidence_score": 1.1,
7	"succeeded_traversals": 1,
8	"total_traversals": 1,
9	"last_validated_at": "2024-01-15T09:30:00Z",
10	"created_at": "2024-01-15T09:30:00Z",
11	"updated_at": "2024-01-15T09:30:00Z",
12	"tenant_id": "string",
13	"invalidated_at": "2024-01-15T09:30:00Z"
14	}