Rename, pause or resume a journey
patch_journeyRename, pause or resume a journey (permission: edit)
Change name and/or status (paused: no scan of it is scheduled or started from now on, while a replay already queued still runs; active: resume). No re-record and no replay; the baseline is kept. The answer is the journey document with its new ETag. A journey that is not a website journey (or has no test) answers 409 unsupported_target.
etag is sent as If-Match: pass the etag of your last get_journey; on precondition_failed call get_journey again and retry.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"id": "<id>",
"etag": "<etag>"
},
"name": "patch_journey"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Journey id: from GET /journeys or the POST /journeys answer. | |
| etag | Yes | The `etag` returned by get_journey (or by the last write), sent as If-Match. | |
| name | No | New name. | |
| status | No | paused: no scan of it is scheduled or started from now on (a replay already queued still runs); active: resume. |