Update a magic route

patch

https://api.emaktalk.com/api/v1/magic_routing/{id}

Updates a magic route in place; fields you omit keep their current values. Only the fields below are writable and anything else in the body is ignored without an error, so extension_number, test_listeners and the created and updated timestamps cannot be set here. Setting enabled to true does not make a route live on its own — deploy it. fallback_destination is validated on its own path: it must resolve to a dialable extension or number or the whole request is rejected before anything is written, and saving it regenerates and reloads the live routing.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

ID of the magic route to update.

Body Params

name

string

Name for the route.

description

string | null

Free-text description of the route.

code

string | null

The routing program that runs when a call reaches this route. Stored exactly as sent and not checked here.

enabled

boolean

Enable flag. Setting it to true does not build the routing — use POST /api/v1/magic_routing/{id}/deploy.

routing_summary

object | null

Readable summary of the route: headline, a rules array of condition, action and priority, and lastUpdated.

worker_url

string | null

Override the service endpoint that runs this route's program.

fallback_destination

string | null

Where a call goes when the routing program picks no destination. Must resolve to a dialable extension or number, and saving it regenerates the live routing.

Responses

200

The route was updated.

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

400The ID is not a valid UUID, the body could not be parsed, fallback_destination was not a string or null, the fallback destination did not resolve, or the update failed.

403Your key is below the required role.

404No such magic route on your account.

500The new fallback destination was saved but the live routing still carries the previous one. Deploy the route again.