v1

latestOpenAPI 3.1.02026-08-0456127224.3 KB

Questions

Update a question

Updates the specified question. Only fields present in the request body are modified; omitted fields remain unchanged.

patch/api/v2/postings/{posting_id}/questions/{question_id}

Path parameters

posting_idstring required

question_idstring required

Headers

X-API-KEYstring nullable

Authorizationstring nullable

X-Workspace-Idstring nullable

Request body

textstring nullable

Updated question text.

evaluation_criteriastring nullable

Updated evaluation criteria.

score_of_1string nullable

Updated score-1 description.

score_of_5string nullable

Updated score-5 description.

score_weightinteger nullable

Updated importance weight for scoring (1–10).

not_scoredboolean nullable

Updated not-scored flag.

question_typestring nullable

Updated question format.

min_follow_upsinteger nullable

Updated min follow-ups.

max_follow_upsinteger nullable

Updated max follow-ups.

additional_instructionsstring nullable

Updated instructions.

post_processing_evaluation_criteriastring nullable

Updated post-processing criteria.

expected_answerstring nullable

Updated expected answer.

expected_valueinteger nullable

Updated expected value.

is_dealbreakerboolean nullable

Updated dealbreaker flag.

{"stackTrail":"components:schemas:UpdateQuestionRequest:properties:answer:anyOf","oasType":"schema","type":"unknown","title":"Answer","description":"Updated expected answer (form).","nullable":true}

is_knockoutboolean nullable

Updated knockout flag.

dropdown_valuesobject[] nullable

Updated dropdown options.

is_answer_mandatedboolean nullable

Updated require-answer flag.

mcq_typestring nullable

Updated MCQ type.

operatorstring nullable

Updated operator.

file_typesstring[] nullable

Updated file types.

allow_multiple_filesboolean nullable

Updated multiple files flag.

slider_minnumber nullable

Updated slider min.

slider_maxnumber nullable

Updated slider max.

slider_stepnumber nullable

Updated slider step.

response_format'text' | 'freeform' | 'date' | 'number' nullable

Updated response format: 'text', 'freeform', 'date', or 'number'.

instructionsstring nullable

Updated instructions.

optionsstring[] nullable

Updated options.

structured_configobject nullable

Updated advanced structured configuration (voice).

Response

Successful Response

metaobject nullable

Optional metadata. Shape varies by endpoint.

Example response

{
  "data": {
    "id": "A1B2C3D4",
    "posting_id": "13D77095",
    "modality": "voice",
    "text": "Tell me about a challenging project you led.",
    "rank": 1
  }
}