Skip to content

opportunityPositions

Opportunities module · 5 operations

List opportunity position rows

GET/opportunity-positions

A position within an opportunity. Returns a cursor page of opportunity position rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

Create an opportunity position

POST/opportunity-positions

A position within an opportunity. Creates an opportunity position. 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 position

GET/opportunity-positions/{id}

A position within an opportunity. Returns one opportunity position with its `ETag`. A opportunity position the caller may not see returns 404.

Update an opportunity position

PATCH/opportunity-positions/{id}

A position within an opportunity. 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 position

DELETE/opportunity-positions/{id}

A position within an opportunity. Soft-deletes the opportunity position: it moves to Trash and can be restored for its table's retention period.