Saltar al contenido

Transition the application state

Módulo Opportunities

POST/applications/{id}/transitionsapplications.transition

Moves the application state machine through its transition RPC, which writes its ledger. Applicants may only withdraw; every other transition belongs to the org. 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.selection.decide.
  • 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

applications.transition: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the application.

Cuerpo de la solicitud: ApplicationTransitionRequest

applications.transition: ApplicationTransitionRequest
CampoTipoObligatorioDescripción
expected_state"Submitted" | "In Review" | "Shortlisted" | "Offered" | "Accepted" | "Declined" | "Withdrawn" | "Not Selected"SíThe state the caller believes the row is in (compare-and-set).
to_state"Submitted" | "In Review" | "Shortlisted" | "Offered" | "Accepted" | "Declined" | "Withdrawn" | "Not Selected"SíTarget state.
reasonstringNoReason, required by some transitions.Restricciones: length 1 to any
{
  "expected_state": "Submitted",
  "to_state": "In Review",
  "reason": "Client approved the revised scope."
}

Respuesta 200: Application

applications.transition: Application
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the application.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
opportunity_idstring (uuid)SíIdentifier of the opportunity.
profile_share_idstring (uuid) | nullSíIdentifier of the consented profile snapshot.
availability_confirmedbooleanSíWhether the applicant confirmed availability.
application_stateApplicationStateSíApplication lifecycle state.Restricciones: one of "Submitted", "In Review", "Shortlisted", "Offered", "Accepted", "Declined", "Withdrawn", "Not Selected"
applicant_person_idstring (uuid) | nullSíIdentifier of the applying person.
applicant_organization_idstring (uuid) | nullSíIdentifier of the applying external account.
submitted_bystring (uuid) | nullSíIdentifier of the person who submitted, set from the session: the applicant, their representative or an account administrator.
cover_notestring | nullSíNote from the applicant.Restricciones: length 1 to 20000
proposed_fee_minorinteger (int64) | nullSíFee the applicant proposes instead of the posted one (artists). Integer minor units of the resource currency; null means unpriced, never zero.
currency_codestring | nullSíISO 4217 currency of the proposed fee.Restricciones: pattern ^[A-Z]{3}$
{
  "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",
  "profile_share_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "availability_confirmed": true,
  "application_state": "Submitted",
  "applicant_person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "applicant_organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "submitted_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "cover_note": "Available for both show days.",
  "proposed_fee_minor": 250000,
  "currency_code": "USD"
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/applications/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/transitions" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"expected_state":"Submitted","to_state":"In Review","reason":"Client approved the revised scope."}'
const { data } = await xos.applications.transition("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "expected_state": "Submitted",
    "to_state": "In Review",
    "reason": "Client approved the revised scope."
  });
response = xos.applications.transition("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"expected_state": "Submitted", "to_state": "In Review", "reason": "Client approved the revised scope."})
xos applications transition 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"expected_state":"Submitted","to_state":"In Review","reason":"Client approved the revised scope."}'