Transition an engagement document

Opportunities module

POST/engagement-documents/{id}/transitionsengagementDocuments.transition

Moves the document through the canon Engagement-Document lifecycle. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.

Requires the capability opportunities.engagement.write.
OAuth scopes: opportunities.
Send an Idempotency-Key header. A replay with the same key returns the original response.
Error statuses: 400, 401, 404, 409, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

engagementDocuments.transition: Path and query parameters
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the engagement document.

Request body: EngagementDocumentTransitionRequest

engagementDocuments.transition: EngagementDocumentTransitionRequest
Field	Type	Required	Description
expected_state	string	Yes	The state the caller believes the row is in (compare-and-set).Constraints: length 1 to any
to_state	string	Yes	Target state.Constraints: length 1 to any
reason	string	No	Reason, required by some transitions.Constraints: length 1 to any

{
  "expected_state": "Proposed",
  "to_state": "Active",
  "reason": "Client approved the revised scope."
}

Response 200: EngagementDocument

engagementDocuments.transition: EngagementDocument
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the engagement document.
org_id	string (uuid)	Yes	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Yes	When the row was created.
created_by	string (uuid) \| null	Yes	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Yes	When the row was last updated.
updated_by	string (uuid) \| null	Yes	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
engagement_id	string (uuid)	Yes	Identifier of the engagement.
document_id	string (uuid) \| null	Yes	Identifier of the document.
title	string	Yes	Document title.Constraints: length 1 to 300
engagement_document_state	string	Yes	Engagement-Document lifecycle state. A Title Case value from the lifecycle's database enum.Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]( [A-Za-z0-9&'/.()-]+)$
document_kind	"Offer" \| "Agreement" \| "Statement of Work" \| "Non-Disclosure Agreement" \| "Rider" \| "Advance Packet" \| "Insurance Certificate" \| "Lien Waiver" \| "Settlement" \| "Proof of Performance" \| "Content Consent"	Yes	Kind of document.
expires_on	string (date) \| null	Yes	Last day the document is valid, for documents that expire.

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "document_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "title": "Statement of Work",
  "engagement_document_state": "Proposed",
  "document_kind": "Offer",
  "expires_on": "2026-10-08"
}

Code samples

curl -X POST "$XOS_BASE_URL/engagement-documents/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/transitions" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"expected_state":"Proposed","to_state":"Active","reason":"Client approved the revised scope."}'

const { data } = await xos.engagementDocuments.transition("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "expected_state": "Proposed",
    "to_state": "Active",
    "reason": "Client approved the revised scope."
  });

response = xos.engagement_documents.transition("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"expected_state": "Proposed", "to_state": "Active", "reason": "Client approved the revised scope."})

xos engagement-documents transition 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"expected_state":"Proposed","to_state":"Active","reason":"Client approved the revised scope."}'