Skip to main content
PATCH
/
api
/
v2
/
postings
/
{posting_id}
/
questions
/
{question_id}
Update a question
curl --request PATCH \
  --url https://api.heymilo.ai/api/v2/postings/{posting_id}/questions/{question_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "text": "<string>",
  "evaluation_criteria": "<string>",
  "score_of_1": "<string>",
  "score_of_5": "<string>",
  "score_weight": 5,
  "not_scored": true,
  "question_type": "<string>",
  "min_follow_ups": 1,
  "max_follow_ups": 1,
  "additional_instructions": "<string>",
  "post_processing_evaluation_criteria": "<string>",
  "expected_answer": "<string>",
  "expected_value": 123,
  "is_dealbreaker": true,
  "answer": "<unknown>",
  "is_knockout": true,
  "dropdown_values": [
    {}
  ],
  "is_answer_mandated": true,
  "mcq_type": "<string>",
  "operator": "<string>",
  "file_types": [
    "<string>"
  ],
  "allow_multiple_files": true,
  "slider_min": 123,
  "slider_max": 123,
  "slider_step": 123,
  "response_format": "text",
  "instructions": "<string>",
  "options": [
    "<string>"
  ],
  "structured_config": {}
}
'
{
  "data": {
    "id": "<string>",
    "posting_id": "<string>",
    "modality": "<string>",
    "text": "<string>",
    "object": "question",
    "rank": 1,
    "evaluation_criteria": "<string>",
    "score_of_1": "<string>",
    "score_of_5": "<string>",
    "score_weight": 123,
    "not_scored": true,
    "question_type": "<string>",
    "min_follow_ups": 123,
    "max_follow_ups": 123,
    "additional_instructions": "<string>",
    "post_processing_evaluation_criteria": "<string>",
    "expected_answer": "<string>",
    "expected_value": 123,
    "is_dealbreaker": true,
    "answer": "<unknown>",
    "is_knockout": true,
    "dropdown_values": [
      {}
    ],
    "is_answer_mandated": true,
    "mcq_type": "<string>",
    "operator": "<string>",
    "file_types": [
      "<string>"
    ],
    "allow_multiple_files": true,
    "slider_min": 123,
    "slider_max": 123,
    "slider_step": 123,
    "response_format": "text",
    "instructions": "<string>",
    "options": [
      "<string>"
    ],
    "structured_config": {},
    "created_at": 123,
    "updated_at": 123
  },
  "meta": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.heymilo.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-KEY
string
header
required

API key for authentication. Pass your key in the X-API-KEY header.

Headers

​
X-API-KEY
string
required

Path Parameters

​
posting_id
string
required
​
question_id
string
required

Body

application/json

Request body for updating a question.

Only provided fields are modified; omitted fields remain unchanged.

​
text
string | null

Updated question text.

​
evaluation_criteria
string | null

Updated evaluation criteria.

​
score_of_1
string | null

Updated score-1 description.

​
score_of_5
string | null

Updated score-5 description.

​
score_weight
integer | null

Updated importance weight for scoring (1–10).

Required range: 1 <= x <= 10
​
not_scored
boolean | null

Updated not-scored flag.

​
question_type
string | null

Updated question format.

​
min_follow_ups
integer | null

Updated min follow-ups.

Required range: x >= 0
​
max_follow_ups
integer | null

Updated max follow-ups.

Required range: x >= 0
​
additional_instructions
string | null

Updated instructions.

​
post_processing_evaluation_criteria
string | null

Updated post-processing criteria.

​
expected_answer
string | null

Updated expected answer.

​
expected_value
integer | null

Updated expected value.

​
is_dealbreaker
boolean | null

Updated dealbreaker flag.

​
answer
any | null

Updated expected answer (form).

​
is_knockout
boolean | null

Updated knockout flag.

​
dropdown_values
Dropdown Values · object[] | null

Updated dropdown options.

​
is_answer_mandated
boolean | null

Updated require-answer flag.

​
mcq_type
string | null

Updated MCQ type.

​
operator
string | null

Updated operator.

​
file_types
string[] | null

Updated file types.

​
allow_multiple_files
boolean | null

Updated multiple files flag.

​
slider_min
number | null

Updated slider min.

​
slider_max
number | null

Updated slider max.

​
slider_step
number | null

Updated slider step.

​
response_format
enum<string> | null

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

Available options:
text,
freeform,
date,
number
​
instructions
string | null

Updated instructions.

​
options
string[] | null

Updated options.

​
structured_config
Structured Config · object

Updated advanced structured configuration (voice).

Response

Successful Response

​
data
QuestionResponse · object
required

A question or criterion belonging to a posting.

The modality field indicates the question type (voice, sms, form, resume_eligibility, resume_scoring, voice_tags). Fields that are not applicable to a given modality will be null.

​
meta
Meta · object

Optional metadata. Shape varies by endpoint.