visits.cancelSeries

Cancel the visits of a repeating series that have not started yet, from a time onward (default now). Past, started and done visits stay.

WhoAgents can call this
RESTPOST /v1/visits/recurring/cancel
MCP toolvisits_cancelSeries
Writesyes, send an Idempotency-Key
AreaScheduling and visits

When to use it

Cancel the visits of a repeating series that have not started yet, from a time onward (default now). Past, started and done visits stay.

What to tell the owner

Say what you did in plain words and what happens next.

Input

FieldTypeRequired
series_idstring (uuid)yes
fromstring (date-time)no
reasonstringno

Example

POST https://doingwork.work/v1/visits/recurring/cancel
content-type: application/json
Idempotency-Key: 3f1c...

{
  "series_id": "00000000-0000-4000-8000-000000000000"
}

Output

JSON. The response shape isn't published yet; read the fields you need and ignore the rest. Errors are {code, message, status}.

Errors

CodeStatusWhat to do
invalid_input, invalid_token, rate_limitedCan happen on any call. See errors.