Skip to main content
Changes only the fields you send; steps or cases sent are replaced whole. A change of content writes a new version, so it can be restored.

Endpoint

Required scope

agents:write

Path parameters

Body

An action is { kind, target }. kind is native (a platform function by name), tool (a webhook tool id), catalog, move_stage (a pipeline stage id), tag (a tag id) or send_file. Up to 60 per step or case.

Example request

curl

Response

200 OK

400 Bad Request

An unknown value, steps nested more than 6 levels, an unknown property, or a scenarioId/routeId that is not an ObjectId.

404 Not Found

AGENT_NOT_FOUND when the agent belongs to another project of the company, UPSTREAM_ERROR (message AGENT_NOT_FOUND) when no agent has that id in the company; scenario_not_found or route_not_found when the scenario or the route is not the agent’s.

409 Conflict

stale_revision: expected_updated_at no longer matches — someone saved in between. Read it again and re-apply your change.

401 Unauthorized

Missing, invalid, revoked, or expired token.

403 Forbidden

The token does not have the agents:write scope.

502 Bad Gateway

The agent service is unreachable.

Operational notes

  • Archiving is the safe way to stop using a route. It stays, with its history.
  • Moving keeps the history. The route changes scenario; its versions come with it.