Skip to content
XOS Developers

Create an application

Opportunities module

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.

  • Requires the capability me.work_details.write.
  • OAuth scopes: me.
  • Send an Idempotency-Key header. A replay with the same key returns the original response.
  • Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: ApplicationCreate

applications.create: ApplicationCreate
FieldTypeRequiredDescription
opportunity_idstring (uuid)YesIdentifier of the opportunity.
profile_share_idstring (uuid) | nullNoIdentifier of the consented profile snapshot.
availability_confirmedbooleanNoWhether the applicant confirmed availability.
applicant_person_idstring (uuid) | nullNoIdentifier of the applying person.
applicant_organization_idstring (uuid) | nullNoIdentifier of the applying external account.
cover_notestring | nullNoNote from the applicant.Constraints: length 1 to 20000
proposed_fee_minorinteger (int64) | nullNoFee the applicant proposes instead of the posted one (artists). Integer minor units of the resource currency; null means unpriced, never zero.
currency_codestring | nullNoISO 4217 currency of the proposed fee.Constraints: 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"
}

Response 201: Application

applications.create: Application
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the application.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
opportunity_idstring (uuid)YesIdentifier of the opportunity.
profile_share_idstring (uuid) | nullYesIdentifier of the consented profile snapshot.
availability_confirmedbooleanYesWhether the applicant confirmed availability.
application_stateApplicationStateYesApplication lifecycle state.Constraints: one of "Submitted", "In Review", "Shortlisted", "Offered", "Accepted", "Declined", "Withdrawn", "Not Selected"
applicant_person_idstring (uuid) | nullYesIdentifier of the applying person.
applicant_organization_idstring (uuid) | nullYesIdentifier of the applying external account.
submitted_bystring (uuid) | nullYesIdentifier of the person who submitted, set from the session: the applicant, their representative or an account administrator.
cover_notestring | nullYesNote from the applicant.Constraints: length 1 to 20000
proposed_fee_minorinteger (int64) | nullYesFee the applicant proposes instead of the posted one (artists). Integer minor units of the resource currency; null means unpriced, never zero.
currency_codestring | nullYesISO 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" \
  -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"}'