Skip to content
XOS Developers

engagementDocuments

Opportunities module · 4 operations

List engagement document rows

GET/engagement-documents

A document in an engagement, under the canon Engagement-Document lifecycle. Returns a cursor page of engagement document rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

Create an engagement document

POST/engagement-documents

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.

Get an engagement document

GET/engagement-documents/{id}

A document in an engagement, under the canon Engagement-Document lifecycle. Returns one engagement document with its `ETag`. A engagement document the caller may not see returns 404.

Transition an engagement document

POST/engagement-documents/{id}/transitions

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`.