Create an opportunity question

Opportunities module

POST/opportunity-questionsopportunityQuestions.create

An application question. Creates an opportunity question. 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 opportunities.posting.write.
OAuth scopes: opportunities.
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: OpportunityQuestionCreate

opportunityQuestions.create: OpportunityQuestionCreate
Field	Type	Required	Description
opportunity_id	string (uuid)	Yes	Identifier of the opportunity.
position	integer	Yes	Question order.Constraints: range 1 to any
prompt	string	Yes	Question.Constraints: length 1 to 300
required	boolean	Yes	Whether an answer is required.

{
  "opportunity_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "position": 1,
  "prompt": "Have you worked a festival load-in before?",
  "required": true
}

Response 201: OpportunityQuestion

opportunityQuestions.create: OpportunityQuestion
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the opportunity question.
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.
position	integer	Yes	Question order.Constraints: range 1 to any
prompt	string	Yes	Question.Constraints: length 1 to 300
required	boolean	Yes	Whether an answer is required.

{
  "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",
  "position": 1,
  "prompt": "Have you worked a festival load-in before?",
  "required": true
}

Code samples

curl -X POST "$XOS_BASE_URL/opportunity-questions" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"opportunity_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","position":1,"prompt":"Have you worked a festival load-in before?","required":true}'

const { data } = await xos.opportunityQuestions.create({
    "opportunity_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "position": 1,
    "prompt": "Have you worked a festival load-in before?",
    "required": true
  });

response = xos.opportunity_questions.create({"opportunity_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "position": 1, "prompt": "Have you worked a festival load-in before?", "required": True})

xos opportunity-questions create --data '{"opportunity_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","position":1,"prompt":"Have you worked a festival load-in before?","required":true}'