Reject standalone Forms API editing.

PATCH /api/v1/forms/{formId}

Standalone Forms API editing has been removed. Update the source review artifact or draft review file instead.

Access

Use a credential with commentary.forms.write.

Provider access, workspace membership, and agent grants are enforced separately. A token does not expand access to a repository or resource. Set up developer access.

Parameters

Name	Location	Type	Required	Description
`formId`	path	string	Yes	Form id or reference id.
`X-Commentary-Workspace-Id`	header	string	No	Must match the credential workspace. This header cannot widen grant authority.
`X-Correlation-Id`	header	string	No

Request body

Required. Supported content types: application/json.

Field	Type	Required	Description
`contract`	FormContract	No
`contractSource`	string	No	Literal JSON or YAML form contract source.
`sourceFormat`	`"json"` · `"yaml"` · `"auto"`	No
`referenceId`	string	No
`title`	string	No
`description`	string	No
`visibility`	`"private"` · `"shared"` · `"public_placeholder"`	No
`sourceType`	`"commentary"` · `"github"` · `"embedded"` · `"custom"`	No
`sourceMetadata`	object	No
`destinationConfig`	object	No
`agentAlias`	string	No
`clientName`	string	No

Call the endpoint

Replace path placeholders and your credential. For body operations, create request.json using the required fields above; this command does not invent resource identifiers or consent.

curl --request PATCH \
  'https://commentary.dev/api/v1/forms/<formId>' \
  --header 'Authorization: Bearer <your-token>' \
  --header 'Content-Type: application/json' \
  --data-binary @request.json

Responses

Status	Meaning	Payload
`400`	The request was invalid.	ExternalError
`401`	Authentication is required.	ExternalError
`403`	The token or session does not have permission for this resource.	ExternalError
`404`	The resource was not found.	ExternalError
`410`	Standalone form editing has been removed.	ExternalError
`429`	The request was rate limited.	ExternalError

Recover from errors

Use the returned status and error body. Correct invalid fields before retrying; reconnect or narrow the target for authentication and permission errors. For conditional writes, reload the latest version before preparing a new request. Respect rate-limit headers and retry only when the operation’s idempotency contract permits it.

Operation ID: updateForm. Download the OpenAPI contract for complete constraints and code generation. Browse endpoints.