Create an application
Módulo Opportunities
POST/applicationsapplications.create
An application to an opportunity, with a consented profile snapshot. Creates an application. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.
- Requiere la capacidad me.work_details.write.
- Alcances de OAuth: me.
- Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
- Estados de error: 400, 401, 409, 422, 429. Los errores son detalles de problema RFC 9457.
Cuerpo de la solicitud: ApplicationCreate
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| opportunity_id | string (uuid) | Sí | Identifier of the opportunity. |
| profile_share_id | string (uuid) | null | No | Identifier of the consented profile snapshot. |
| availability_confirmed | boolean | No | Whether the applicant confirmed availability. |
| applicant_person_id | string (uuid) | null | No | Identifier of the applying person. |
| applicant_organization_id | string (uuid) | null | No | Identifier of the applying external account. |
| cover_note | string | null | No | Note from the applicant.Restricciones: length 1 to 20000 |
| proposed_fee_minor | integer (int64) | null | No | 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 | No | ISO 4217 currency of the proposed fee.Restricciones: pattern ^[A-Z]{3}$ |
{
"opportunity_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"profile_share_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"availability_confirmed": true,
"applicant_person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"applicant_organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"cover_note": "Available for both show days.",
"proposed_fee_minor": 250000,
"currency_code": "USD"
}Respuesta 201: Application
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the application. |
| 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. |
| opportunity_id | string (uuid) | Sí | Identifier of the opportunity. |
| profile_share_id | string (uuid) | null | Sí | Identifier of the consented profile snapshot. |
| availability_confirmed | boolean | Sí | Whether the applicant confirmed availability. |
| application_state | ApplicationState | Sí | Application lifecycle state.Restricciones: one of "Submitted", "In Review", "Shortlisted", "Offered", "Accepted", "Declined", "Withdrawn", "Not Selected" |
| applicant_person_id | string (uuid) | null | Sí | Identifier of the applying person. |
| applicant_organization_id | string (uuid) | null | Sí | Identifier of the applying external account. |
| submitted_by | string (uuid) | null | Sí | Identifier of the person who submitted, set from the session: the applicant, their representative or an account administrator. |
| cover_note | string | null | Sí | Note from the applicant.Restricciones: length 1 to 20000 |
| proposed_fee_minor | integer (int64) | null | Sí | 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 | Sí | 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" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"opportunity_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","profile_share_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","availability_confirmed":true,"applicant_person_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","applicant_organization_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","cover_note":"Available for both show days.","proposed_fee_minor":250000,"currency_code":"USD"}'const { data } = await xos.applications.create({
"opportunity_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"profile_share_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"availability_confirmed": true,
"applicant_person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"applicant_organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"cover_note": "Available for both show days.",
"proposed_fee_minor": 250000,
"currency_code": "USD"
});response = xos.applications.create({"opportunity_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "profile_share_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "availability_confirmed": True, "applicant_person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "applicant_organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "cover_note": "Available for both show days.", "proposed_fee_minor": 250000, "currency_code": "USD"})xos applications create --data '{"opportunity_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","profile_share_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","availability_confirmed":true,"applicant_person_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","applicant_organization_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","cover_note":"Available for both show days.","proposed_fee_minor":250000,"currency_code":"USD"}'