v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB

Ats > Question

Creates a Question

post/api/2026-07-01/resources/ats/questions

Request body

ats_job_posting_idstring required

job posting identifier.

company_idstring required

company identifier, refers to /core/me endpoint.

labelstring required

text of the question.

positioninteger required

position of the question in the list.

mandatoryboolean

is the question mandatory or not

question_type'text' | 'long_text' | 'single_choice' | 'multiple_choice' | 'file' required

type of the question.

auto_disqualifyboolean

if the question autodisqualifies the candidate depending on it's response.

Example request

{
  "ats_job_posting_id": "1",
  "company_id": "1",
  "label": "Are you open to relocate?",
  "position": 1,
  "mandatory": true,
  "question_type": "text",
  "options": [
    {
      "text": "Yes",
      "disqualifies": false
    },
    {
      "text": "No",
      "disqualifies": false
    }
  ]
}

Response

CREATED

idstring required

question identifier

ats_job_posting_idstring required

job posting identifier.

labelstring required

text of the question.

positioninteger required

position of the question in the list.

mandatoryboolean required

is the question mandatory or not

auto_disqualifyboolean required

if the question autodisqualifies the candidate depending on it's response.

question_type'text' | 'long_text' | 'single_choice' | 'multiple_choice' | 'file' required

type of the question.

created_atstring required

creation date

updated_atstring required

last update date

Example response

{
  "id": "1",
  "ats_job_posting_id": "1",
  "label": "Are you open to relocate?",
  "position": 1,
  "mandatory": true,
  "question_type": "text",
  "created_at": "2025-01-01T00:00:00.000Z",
  "updated_at": "2025-01-01T00:00:00.000Z",
  "options": [
    {
      "text": "Yes",
      "disqualifies": false
    },
    {
      "text": "No",
      "disqualifies": false
    }
  ]
}