Transition the opportunity state
Opportunities module
POST/opportunities/{id}/transitionsopportunities.transition
Moves the opportunity state machine through its transition RPC, which writes its ledger. Publishing applies spend authority and refuses a posting without a pay range where the jurisdiction requires one. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.
- Requires the capability opportunities.posting.publish.
- OAuth scopes: opportunities.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 404, 409, 422, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the opportunity. |
Request body: OpportunityTransitionRequest
| Field | Type | Required | Description |
|---|---|---|---|
| expected_state | "Draft" | "Pending Approval" | "Published" | "Paused" | "Filled" | "Closed" | "Canceled" | Yes | The state the caller believes the row is in (compare-and-set). |
| to_state | "Draft" | "Pending Approval" | "Published" | "Paused" | "Filled" | "Closed" | "Canceled" | Yes | Target state. |
| reason | string | No | Reason, required by some transitions.Constraints: length 1 to any |
{
"expected_state": "Draft",
"to_state": "Pending Approval",
"reason": "Client approved the revised scope."
}Response 200: Opportunity
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the opportunity. |
| 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. |
| requisition_id | string (uuid) | null | Yes | Identifier of the approved requisition the opportunity is published from; required to publish Contractor, Crew and Staff opportunities and fixed once published. |
| project_id | string (uuid) | Yes | Identifier of the project. |
| scope_node_id | string (uuid) | null | Yes | Identifier of the scope node. |
| title | string | Yes | Opportunity title, Title Case.Constraints: length 1 to 300 |
| role_type | ExternalRoleType | Yes | External role type (Section 4.4.2).Constraints: one of "Client", "Vendor", "Contractor", "Crew", "Staff", "Artist", "Artist Representative", "Sponsor" |
| role_code | RoleCode | null | Yes | |
| cat_urid | UridAtAnyGrain | Yes | URID at discipline grain (`DDDD.DD`) or category grain (`DDDD.DD.DD`), as GL dimension 2 allows.Constraints: pattern ^[0-9]000(\.[0-9]{2}){1,2}$ |
| description | string | null | Yes | Description.Constraints: length 1 to 20000 |
| venue_id | string (uuid) | null | Yes | Identifier of the venue. |
| rate_type | RateType | null | Yes | |
| visibility | OpportunityVisibility | Yes | Who can see an opportunity.Constraints: one of "Invited", "Pool", "Network", "Public" |
| opportunity_state | OpportunityState | Yes | Opportunity lifecycle state.Constraints: one of "Draft", "Pending Approval", "Published", "Paused", "Filled", "Closed", "Canceled" |
| jurisdiction_id | JurisdictionId | null | Yes | |
| starts_on | string (date) | null | Yes | First day of the work. |
| ends_on | string (date) | null | Yes | Last day of the work. |
| pay_min_minor | integer (int64) | null | Yes | Lower end of the posted pay range; null when not posted. Integer minor units of the resource currency; null means unpriced, never zero. |
| pay_max_minor | integer (int64) | null | Yes | Upper end of the posted pay range; null when not posted. Integer minor units of the resource currency; null means unpriced, never zero. |
| currency_code | string | null | Yes | ISO 4217 currency of the posted pay.Constraints: pattern ^[A-Z]{3}$ |
| deadline_at | string (date-time) | null | Yes | Deadline for applications and bids. Bids stay sealed until it passes. |
| minimum_age | integer | null | Yes | Minimum age for the work, 16 or older (Section 14.9).Constraints: range 16 to any |
| is_remote | boolean | Yes | Whether the work can be done remotely. |
{
"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",
"requisition_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"scope_node_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"title": "Stagehands for Harborfront Load-In",
"role_type": "Crew",
"role_code": "5000.50.01",
"cat_urid": "4000.01",
"description": "Six stagehands for a two-day load-in.",
"venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"rate_type": "Day",
"visibility": "Pool",
"opportunity_state": "Published",
"jurisdiction_id": "US-FL",
"starts_on": "2026-10-08",
"ends_on": "2026-10-08",
"pay_min_minor": 3500,
"pay_max_minor": 4500,
"currency_code": "USD",
"deadline_at": "2026-10-08T14:30:00Z",
"minimum_age": 18,
"is_remote": false
}Code samples
curl -X POST "$XOS_BASE_URL/opportunities/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/transitions" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"expected_state":"Draft","to_state":"Pending Approval","reason":"Client approved the revised scope."}'const { data } = await xos.opportunities.transition("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
"expected_state": "Draft",
"to_state": "Pending Approval",
"reason": "Client approved the revised scope."
});response = xos.opportunities.transition("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"expected_state": "Draft", "to_state": "Pending Approval", "reason": "Client approved the revised scope."})xos opportunities transition 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"expected_state":"Draft","to_state":"Pending Approval","reason":"Client approved the revised scope."}'