Conditionally update a non-decision Interaction lifecycle state.

Read as Markdown

PATCH /api/v1/interactions/{interactionId}

Conditionally update a non-decision Interaction lifecycle state.

Access

Use a credential with commentary.interactions.update.

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
interactionId	path	string	Yes	Opaque Interaction id.
If-Match	header	string	Yes
Idempotency-Key	header	string	Yes
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
state	"active" · "waiting_for_human" · "waiting_for_agent" · "expired" · "failed"	Yes

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/interactions/<interactionId>' \
  --header 'Authorization: Bearer <your-token>' \
  --header 'Content-Type: application/json' \
  --data-binary @request.json

Responses

Status	Meaning	Payload
200	Successful response.	object
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
412	The ETag is stale.	InteractionApiError
428	If-Match is required.	InteractionApiError
429	The request was rate limited.	ExternalError

Successful response fields

Field	Type	Required	Description
data	Interaction	No

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.

Contract and related guidance

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