Skip to content

Update template activity or description ​

http
PATCH /api/v1/templates/{id}

Name and tag are immutable. Empty or whitespace-only descriptions become null. No AgentBox lookup. Browser writes require Origin and X-Orpheus-CSRF.

operationId: update_template

Authentication ​

HTTPBearer / BrowserSession

See browser access. Session mutations require a Bearer key.

Parameters ​

NameInRequiredTypeDescription and constraints
idpathYesstringformat: "uuid"

Request body ​

application/json: UpdateTemplate

json
{
  "$ref": "#/components/schemas/UpdateTemplate"
}

Responses ​

CodeDescriptionContent
200Updated templateapplication/json: Template
defaultInvalid input (422), unauthorized (401), forbidden browser origin (403), missing record (404), duplicate (409), or unavailable provider/storage (503).application/json: ErrorResponse

HTTP API