Update template metadata
Updates container metadata only: name (≤120 chars), description (≤500 chars, or null to clear it), and currentVersion.
Updates container metadata only: name (≤120 chars), description (≤500 chars, or null to clear it), and currentVersion. Version bodies are immutable, so source, subject, and variables cannot be changed here — publish a new version to change content. Setting currentVersion re-points the template at any already-published version of itself for an instant roll-forward or rollback of future default sends; the target must exist for this template or the call returns 404. A request that supplies no updatable field returns 400. Responds 200 with the updated object: "template" (no version body is included), and requires the templates:write scope.
Scope: templates:write. Send the API key as a bearer token; Scopes lists what each one reaches.
Request
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
idOrSlug | string | yes | Template UUID or slug. |
Body
Required, application/json: TemplatePatchRequest.
| Field | Type | Required | Description |
|---|---|---|---|
name | string | no | (min length 1) |
description | string or null | no | |
currentVersion | integer | no | (minimum 1) |
Response
200 Success. Body: application/json, TemplateResponse.
| Field | Type | Required | Description |
|---|---|---|---|
template | Template | yes |
Errors
Every error has the same body, {"error": {"type", "code", "message", "param"}}; branch on code. Errors lists every code.
| Status | Meaning |
|---|---|
400 | The request is malformed or a value is invalid (invalid_request, invalid_domain, idempotency_key_mismatch). |
401 | The API key is missing or invalid. |
403 | The key lacks the scope this endpoint needs (scope_missing) or may not do this (not_permitted). |
404 | No such resource in this account (resource_not_found). |
422 | The request is well-formed but a field failed validation (validation_failed). |
429 | Rate limit, plan limit, budget or spend cap reached (rate_limited, plan_limit_reached, budget_exceeded, spend_cap_reached). |
500 | An unexpected error; retry with backoff, then contact support (internal_error). |