Transition the opportunity state

Módulo Opportunities

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

Requiere la capacidad opportunities.posting.publish.
Alcances de OAuth: opportunities.
Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
Estados de error: 400, 401, 404, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

opportunities.transition: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the opportunity.

Cuerpo de la solicitud: OpportunityTransitionRequest

opportunities.transition: OpportunityTransitionRequest
Campo	Tipo	Obligatorio	Descripción
expected_state	"Draft" \| "Pending Approval" \| "Published" \| "Paused" \| "Filled" \| "Closed" \| "Canceled"	Sí	The state the caller believes the row is in (compare-and-set).
to_state	"Draft" \| "Pending Approval" \| "Published" \| "Paused" \| "Filled" \| "Closed" \| "Canceled"	Sí	Target state.
reason	string	No	Reason, required by some transitions.Restricciones: length 1 to any

{
  "expected_state": "Draft",
  "to_state": "Pending Approval",
  "reason": "Client approved the revised scope."
}

Respuesta 200: Opportunity

opportunities.transition: Opportunity
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the opportunity.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
requisition_id	string (uuid) \| null	Sí	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)	Sí	Identifier of the project.
scope_node_id	string (uuid) \| null	Sí	Identifier of the scope node.
title	string	Sí	Opportunity title, Title Case.Restricciones: length 1 to 300
role_type	ExternalRoleType	Sí	External role type (Section 4.4.2).Restricciones: one of "Client", "Vendor", "Contractor", "Crew", "Staff", "Artist", "Artist Representative", "Sponsor"
role_code	RoleCode \| null	Sí
cat_urid	UridAtAnyGrain	Sí	URID at discipline grain (`DDDD.DD`) or category grain (`DDDD.DD.DD`), as GL dimension 2 allows.Restricciones: pattern ^[0-9]000(\.[0-9]{2}){1,2}$
description	string \| null	Sí	Description.Restricciones: length 1 to 20000
venue_id	string (uuid) \| null	Sí	Identifier of the venue.
rate_type	RateType \| null	Sí
visibility	OpportunityVisibility	Sí	Who can see an opportunity.Restricciones: one of "Invited", "Pool", "Network", "Public"
opportunity_state	OpportunityState	Sí	Opportunity lifecycle state.Restricciones: one of "Draft", "Pending Approval", "Published", "Paused", "Filled", "Closed", "Canceled"
jurisdiction_id	JurisdictionId \| null	Sí
starts_on	string (date) \| null	Sí	First day of the work.
ends_on	string (date) \| null	Sí	Last day of the work.
pay_min_minor	integer (int64) \| null	Sí	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	Sí	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	Sí	ISO 4217 currency of the posted pay.Restricciones: pattern ^[A-Z]{3}$
deadline_at	string (date-time) \| null	Sí	Deadline for applications and bids. Bids stay sealed until it passes.
minimum_age	integer \| null	Sí	Minimum age for the work, 16 or older (Section 14.9).Restricciones: range 16 to any
is_remote	boolean	Sí	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
}

Ejemplos de código

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."}'