Cancel a schedule
well_cancel_scheduleCancel one workspace schedule for good: a one-off that has not run yet ("cancel my 1:45am poem"), a recurring job or an event job. A cancelled schedule runs nothing again and cannot be resumed; to run the job again, create a new schedule. A run already in progress is not stopped.
REQUIRED: schedule_id (from well_list_schedules or the result of well_create_schedule).
Cancelling draws no confirmation card. Confirm the schedule's name with the user in your own words before you call it, and quote the status the result returns.
Use it when the person asks to disable, stop or turn off a routine, such as "disable my morning brief".
Do NOT use this to skip a few days of a routine (use well_snooze_schedule), to pause a schedule you may want back (use well_update_schedule with status "paused"), or to change one (use well_update_schedule).
When the token authorizes one workspace, call this directly — no workspace call is needed first. When it authorizes several, this read will not guess which one you mean: pass workspace_id on the call.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| schedule_id | Yes | The schedule to cancel. | |
| workspace_id | No | Target workspace. Omit when the token authorizes one workspace. Required when it authorizes several — a write lands in exactly one workspace and this call would not say which. | |
| conversation_id | No | The conversation id returned by the previous Well result, in its meta under well/conversation_id, in its structuredContent, or in its JSON text block. Pass it back on every call in the same conversation, including a call a card makes, so the chosen workspace and the earlier answers still apply. It decides the conversation on its own: nothing the host states about the session replaces it. Omit it only on the first call of a conversation. | |
| idempotency_key | No | Optional client-supplied key. A retried write with the same key returns the original result instead of re-applying the operation. | |
| workspace_scope | No | Restrict this call to the family: the token's primary workspace plus the company workspaces under it that you are a member of. Unrelated authorized workspaces drop out of the read; row reads merge across the family, while a per-workspace figure still reports exactly one workspace. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | No | ||
| status | No | ||
| message | No | ||
| success | Yes | ||
| schedule | No | ||
| next_run_at | No | ||
| approved_tools | No | ||
| conversation_id | No | The conversation this result belongs to. Pass it back as the conversation_id argument on every later Well call in the same conversation. | |
| newly_connected | No | Tools that connected to this workspace since the last result and that no session was told about yet, oldest first. Present only when at least one tool is new. The connected-line rule says when to tell an entry; when it does, one line per entry, in the person's language: "<name> is connected.". Never fold several entries into one sentence. Each entry comes back once, on one result only: never repeat its line later. | |
| resolved_workspace | No | The workspace that answered, when the caller named none and the token authorizes several. | |
| conversation_id_note | No | Present only when the server opened a fresh lane, stating that no choice recorded earlier was read. | |
| conversation_id_source | No | Where the conversation id came from: the host's own request meta, the caller's argument, or a fresh lane the server opened. |