Skip to content

Update an opportunity question

Opportunities module

PATCH/opportunity-questions/{id}opportunityQuestions.update

An application question. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

  • Requires the capability opportunities.posting.write.
  • OAuth scopes: opportunities.
  • Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
  • Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.

Path and query parameters

opportunityQuestions.update: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the opportunity question.

Request body: OpportunityQuestionUpdate

opportunityQuestions.update: OpportunityQuestionUpdate
FieldTypeRequiredDescription
positionintegerNoQuestion order.Constraints: range 1 to any
promptstringNoQuestion.Constraints: length 1 to 300
requiredbooleanNoWhether an answer is required.
{
  "position": 1,
  "prompt": "Have you worked a festival load-in before?",
  "required": true
}

Response 200: OpportunityQuestion

opportunityQuestions.update: OpportunityQuestion
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the opportunity question.
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.
positionintegerYesQuestion order.Constraints: range 1 to any
promptstringYesQuestion.Constraints: length 1 to 300
requiredbooleanYesWhether 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 PATCH "$XOS_BASE_URL/opportunity-questions/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -H "Content-Type: application/json" \
  -d '{"position":1,"prompt":"Have you worked a festival load-in before?","required":true}'
const { data, etag } = await xos.opportunityQuestions.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "position": 1,
    "prompt": "Have you worked a festival load-in before?",
    "required": true
  }, { ifMatch: etag });
response = xos.opportunity_questions.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"position": 1, "prompt": "Have you worked a festival load-in before?", "required": True}, if_match=etag)
xos opportunity-questions update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"position":1,"prompt":"Have you worked a festival load-in before?","required":true}' --if-match auto