Skip to content
XOS Developers

opportunityRequirements

Opportunities module · 5 operations

List opportunity requirement rows

GET/opportunity-requirements

A requirement of an opportunity: a certification through a canon compliance tag, insurance or equipment. Returns a cursor page of opportunity requirement rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

Create an opportunity requirement

POST/opportunity-requirements

A requirement of an opportunity: a certification through a canon compliance tag, insurance or equipment. Creates an opportunity requirement. 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 opportunity requirement

GET/opportunity-requirements/{id}

A requirement of an opportunity: a certification through a canon compliance tag, insurance or equipment. Returns one opportunity requirement with its `ETag`. A opportunity requirement the caller may not see returns 404.

Update an opportunity requirement

PATCH/opportunity-requirements/{id}

A requirement of an opportunity: a certification through a canon compliance tag, insurance or equipment. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

Delete an opportunity requirement

DELETE/opportunity-requirements/{id}

A requirement of an opportunity: a certification through a canon compliance tag, insurance or equipment. Soft-deletes the opportunity requirement: it moves to Trash and can be restored for its table's retention period.