Endpoint
Required scope
agents:write
Path parameters
Example request
curl
Response
204 No Content
No body.400 Bad Request
scenarioId or routeId 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.
401 Unauthorized
Missing, invalid, revoked, or expired token.403 Forbidden
The token does not have theagents:write scope.
502 Bad Gateway
The agent service is unreachable.Operational notes
- It cannot be undone. To stop using it while keeping it, set its
statustoarchived.