On this page

update-schedule

Change a schedule. A PARTIAL update: only the arguments present change. Pause and resume through 'status' — "paused" stops the schedule firing and "active" resumes it with its configuration intact; there is no separate pause tool. A schedule in another project reports not found.

What it is called on each surface

The wire name is update-schedule everywhere: it is what the Wexa MCP server advertises, the REST path is POST /v1/update-schedule, and each SDK exposes it under its own language's naming convention.

SurfaceName
Wexa MCP serverupdate-schedule
REST APIPOST /v1/update-schedule
TypeScript SDKfabric.updateSchedule()
Python SDKfabric.update_schedule()

Arguments

1 of the 7 arguments is required. Omitting a required one is refused before the tool runs, at the validation stage, so it costs nothing and changes nothing.

ArgumentTypeRequiredNotes
frequencystringOptionalCron expression "min hour day month weekday". Mutually exclusive with run_at.
goalstringOptionalWhat the agent should do on each run.
limitintegerOptionalStop after this many runs. Recurring only.
run_atintegerOptionalUnix seconds for a single run. Mutually exclusive with frequency.
schedule_idstringRequiredSchedule id from list-schedules or create-schedule.
statusone of 3Optional"paused" stops firing; "active" resumes; "inactive" retires the schedule. One of: active, inactive, paused.
tableobjectOptionalBind this schedule to a Data Table: each firing picks up the next row matching the filter and substitutes it into the goal.

project_id, projectID, organization_id and executed_by are not arguments you pass: the platform binds all four from the credential you authenticated with, and both SDKs refuse them before the request leaves your process — see server-bound arguments.

What it returns

The three surfaces wrap this differently, and code written against one will not read another correctly — see return shape.

A real response, captured from a live call to update-schedule:

{
  "content": [
    {
      "type": "text",
      "text": "{\"lifecycle_id\":\"qlc_000189\",\"result\":{\"agentflow_id\":\"6ab1945e7566f41b5c28e303\",\"conclusion\":null,\"created_at\":1790022759.401271,\"created_by\":\"6a79a770b6c128ccc24bfca7\",\"end_at\":null,\"frequency\":\"0 9 * * 1\",\"goal\":\"Summarise yesterday's orders.\",\"last_execution_id\":null,\"limit\":null,\"run_at\":null,\"run_count\":0,\"schedule_id\":\"6ab194677566f41b5c28e30f\",\"status\":\"active\",\"time_zone\":\"Asia/Kolkata\",\"type\":\"recurring\",\"updated_at\":1790023297.35068}}"
    }
  ],
  "isError": false
}

Keeping the lifecycle_id is what lets you ask later why a call was allowed, refused or held.

Calling it

The same call on all four surfaces. Pick a tab once and every code block in the documentation follows it.

The ids in this example are real: they resolve against the project the documentation is written against, so the call runs as written once you point it at your own deployment. Swap them for the ids of your own objects.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "update-schedule",
    "arguments": {
      "schedule_id": "6ab194677566f41b5c28e30f",
      "table": {}
    }
  }
}

Errors

Both SDKs raise the same typed errors, chosen from the gateway's own error string first and its HTTP status second. update-schedule checks the fabric:orchestrate.write grant, and reaches the seven classes every tool reaches — listed under the common set. These are the ones specific to it:

ErrorStatusRaised when
NotFound404schedule_id matches no schedule in this project.
ConfigurationError5xxupdate-schedule is not available to you. Retrying will not help.

Governance

Every call to update-schedule runs through the same ten-stage lifecycle as every other Wexa tool: the credential is resolved to a scope, the fabric:orchestrate.write grant is checked, quota is drawn down, the arguments are validated, policy rules are evaluated, the call is executed, the result is shaped and redacted, and an audit record is written. The lifecycle_id in the response is the handle to that record.

update-schedule only reads, so it is not marked consequential: it is audited lightly and is never held for approval. It still consumes quota and is still refused by policy like anything else.

See also

The tool index, errors, and which identifier goes where.