Update an opportunity position

Opportunities module

PATCH/opportunity-positions/{id}opportunityPositions.update

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.

Requires the capability opportunities.posting.write.
OAuth scopes: opportunities.
Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.

Path and query parameters

opportunityPositions.update: Path and query parameters
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the opportunity position.

Request body: OpportunityPositionUpdate

opportunityPositions.update: OpportunityPositionUpdate
Field	Type	Required	Description
label	string	No	Position label, for example Rigger 2.Constraints: length 1 to 300
call_at	string (date-time) \| null	No	Call time.
ends_at	string (date-time) \| null	No	When the position's work ends.

{
  "label": "Rigger 2",
  "call_at": "2026-10-08T14:30:00Z",
  "ends_at": "2026-10-08T14:30:00Z"
}

Response 200: OpportunityPosition

opportunityPositions.update: OpportunityPosition
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the opportunity position.
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.
opportunity_id	string (uuid)	Yes	Identifier of the opportunity.
label	string	Yes	Position label, for example Rigger 2.Constraints: length 1 to 300
call_at	string (date-time) \| null	Yes	Call time.
ends_at	string (date-time) \| null	Yes	When the position's work ends.

{
  "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",
  "opportunity_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "label": "Rigger 2",
  "call_at": "2026-10-08T14:30:00Z",
  "ends_at": "2026-10-08T14:30:00Z"
}

Code samples

curl -X PATCH "$XOS_BASE_URL/opportunity-positions/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -H "Content-Type: application/json" \
  -d '{"label":"Rigger 2","call_at":"2026-10-08T14:30:00Z","ends_at":"2026-10-08T14:30:00Z"}'

const { data, etag } = await xos.opportunityPositions.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "label": "Rigger 2",
    "call_at": "2026-10-08T14:30:00Z",
    "ends_at": "2026-10-08T14:30:00Z"
  }, { ifMatch: etag });

response = xos.opportunity_positions.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"label": "Rigger 2", "call_at": "2026-10-08T14:30:00Z", "ends_at": "2026-10-08T14:30:00Z"}, if_match=etag)

xos opportunity-positions update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"label":"Rigger 2","call_at":"2026-10-08T14:30:00Z","ends_at":"2026-10-08T14:30:00Z"}' --if-match auto