Create an engagement document

Módulo Opportunities

POST/engagement-documentsengagementDocuments.create

A document in an engagement, under the canon Engagement-Document lifecycle. Creates an engagement document. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Requiere la capacidad opportunities.engagement.write.
Alcances de OAuth: opportunities.
Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
Estados de error: 400, 401, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: EngagementDocumentCreate

engagementDocuments.create: EngagementDocumentCreate
Campo	Tipo	Obligatorio	Descripción
engagement_id	string (uuid)	Sí	Identifier of the engagement.
document_id	string (uuid) \| null	No	Identifier of the document.
title	string	Sí	Document title.Restricciones: length 1 to 300
document_kind	"Offer" \| "Agreement" \| "Statement of Work" \| "Non-Disclosure Agreement" \| "Rider" \| "Advance Packet" \| "Insurance Certificate" \| "Lien Waiver" \| "Settlement" \| "Proof of Performance" \| "Content Consent"	Sí	Kind of document.
expires_on	string (date) \| null	No	Last day the document is valid, for documents that expire.

{
  "engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "document_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "title": "Statement of Work",
  "document_kind": "Offer",
  "expires_on": "2026-10-08"
}

Respuesta 201: EngagementDocument

engagementDocuments.create: EngagementDocument
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the engagement document.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
engagement_id	string (uuid)	Sí	Identifier of the engagement.
document_id	string (uuid) \| null	Sí	Identifier of the document.
title	string	Sí	Document title.Restricciones: length 1 to 300
engagement_document_state	string	Sí	Engagement-Document lifecycle state. A Title Case value from the lifecycle's database enum.Restricciones: 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"	Sí	Kind of document.
expires_on	string (date) \| null	Sí	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"
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/engagement-documents" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"engagement_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","document_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","title":"Statement of Work","document_kind":"Offer","expires_on":"2026-10-08"}'

const { data } = await xos.engagementDocuments.create({
    "engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "document_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "title": "Statement of Work",
    "document_kind": "Offer",
    "expires_on": "2026-10-08"
  });

response = xos.engagement_documents.create({"engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "document_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "title": "Statement of Work", "document_kind": "Offer", "expires_on": "2026-10-08"})

xos engagement-documents create --data '{"engagement_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","document_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","title":"Statement of Work","document_kind":"Offer","expires_on":"2026-10-08"}'