Transition the application state
Opportunities module
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`.
- Requires the capability opportunities.selection.decide.
- 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 application. |
Request body: ApplicationTransitionRequest
| Field | Type | Required | Description |
|---|---|---|---|
| expected_state | "Submitted" | "In Review" | "Shortlisted" | "Offered" | "Accepted" | "Declined" | "Withdrawn" | "Not Selected" | Yes | The state the caller believes the row is in (compare-and-set). |
| to_state | "Submitted" | "In Review" | "Shortlisted" | "Offered" | "Accepted" | "Declined" | "Withdrawn" | "Not Selected" | Yes | Target state. |
| reason | string | No | Reason, required by some transitions.Constraints: length 1 to any |
{
"expected_state": "Submitted",
"to_state": "In Review",
"reason": "Client approved the revised scope."
}Response 200: Application
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the application. |
| 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. |
| profile_share_id | string (uuid) | null | Yes | Identifier of the consented profile snapshot. |
| availability_confirmed | boolean | Yes | Whether the applicant confirmed availability. |
| application_state | ApplicationState | Yes | Application lifecycle state.Constraints: one of "Submitted", "In Review", "Shortlisted", "Offered", "Accepted", "Declined", "Withdrawn", "Not Selected" |
| applicant_person_id | string (uuid) | null | Yes | Identifier of the applying person. |
| applicant_organization_id | string (uuid) | null | Yes | Identifier of the applying external account. |
| submitted_by | string (uuid) | null | Yes | Identifier of the person who submitted, set from the session: the applicant, their representative or an account administrator. |
| cover_note | string | null | Yes | Note from the applicant.Constraints: length 1 to 20000 |
| proposed_fee_minor | integer (int64) | null | Yes | Fee the applicant proposes instead of the posted one (artists). Integer minor units of the resource currency; null means unpriced, never zero. |
| currency_code | string | null | Yes | ISO 4217 currency of the proposed fee.Constraints: 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"
}Code samples
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."}'