Skip to main content
PATCH
Update a synthesis template
Changes the fields you send, at least one besides id, and answers 200 with the template. constraints replaces the whole list. Sending only constraints keeps the enforcement, and sending only enforcement keeps the constraints. Field rules are those of Create synthesis template. An empty, malformed or unknown id, or a template in another workspace, answers 404 resource_missing “Synthesis template not found”. A repeat converges on the same state. Needs synthesis:manage, and the credential’s scopes must also reach platform:read, because the answer is a read of what was written; a credential missing either is refused 403 before anything runs. Both must then be held at the platform scope: a grant that covers only some org units receives 403 naming the first one missing, and nothing is written. A Personal key writes as its owner; an External App or platform key is recorded as itself (see Who wrote it). Send an Idempotency-Key to make a retry safe: the same key and body within 24 hours returns the recorded answer only while your scopes still reach platform:read and you still hold platform:read and synthesis:manage at the platform scope; otherwise 409 idempotency_result_unavailable, and the write never runs twice. The same key with a different body is 422. See Synthesis settings writes.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Headers

Idempotency-Key
string

Optional logical intent key. A same-key retry within 24 hours returns the recorded result without writing again.

Required string length: 1 - 255

Path Parameters

templateId
string
required

The template's id.

Minimum string length: 1

Body

application/json
name
string

Shown in Console; stored trimmed; at most 200 characters.

Maximum string length: 200
description
string

What the template enforces; stored trimmed; at most 2000 characters.

Maximum string length: 2000
appliesTo
enum<string>

The primitive kind the template governs.

Available options:
skill,
agent,
procedure
enforcement
enum<string>

hard blocks the Builder's dispatch on a violation; warn only reports it.

Available options:
hard,
warn
constraints
object[]

Replaces the whole constraint list; the enforcement is kept unless also sent.

Maximum array length: 50
status
enum<string>

Only active templates are enforced.

Available options:
active,
disabled,
draft

Response

The updated template

data
object
required
meta
object
required