Add a question

curl --request POST \
  --url https://{your-subdomain}.neetoform.com/api/external/v2/forms/{form_id}/questions \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --data '
{
  "question": {
    "kind": "dropdown",
    "position": 2,
    "attributes": {
      "label": "Work email",
      "is_required": true
    }
  }
}
'

const options = {
  method: 'POST',
  headers: {'X-Api-Key': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    question: {
      kind: 'dropdown',
      position: 2,
      attributes: {label: 'Work email', is_required: true}
    }
  })
};

fetch('https://{your-subdomain}.neetoform.com/api/external/v2/forms/{form_id}/questions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{your-subdomain}.neetoform.com/api/external/v2/forms/{form_id}/questions"

payload = { "question": {
        "kind": "dropdown",
        "position": 2,
        "attributes": {
            "label": "Work email",
            "is_required": True
        }
    } }
headers = {
    "X-Api-Key": "<x-api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "question": {
    "id": "6b1f2c1e-2d7a-4a55-9c4e-0f1f8a7b2c11",
    "kind": "dropdown",
    "position": 2,
    "state": "draft",
    "has_draft_changes": true,
    "attributes": {
      "label": "Plan",
      "description": "",
      "is_required": true,
      "is_hidden": false,
      "is_multi_select": false,
      "placeholder": "",
      "properties": {
        "is_randomized": false
      },
      "options": [
        {
          "id": "draft-0c6e1b2a-4f1d-4c53-9d1e-7a1b2c3d4e5f",
          "alt_id": "alt-9a41d2c8-3b7e-4a62-8f10-5d6e7f8a9b0c",
          "label": "Basic",
          "position": 0
        },
        {
          "id": "draft-5d2b8e44-1c9a-47f3-b6d2-0e1f2a3b4c5d",
          "alt_id": "alt-17fe3a90-6d2b-4c81-a5e4-9b8c7d6e5f4a",
          "label": "Pro",
          "position": 1
        }
      ]
    }
  }
}

{
  "error": "Form does not exist."
}

{
  "error": "'stripe_payment' questions cannot be added. Addable kinds: short_text, long_text, dropdown"
}

POST

forms

{form_id}

questions

Add a question

curl --request POST \
  --url https://{your-subdomain}.neetoform.com/api/external/v2/forms/{form_id}/questions \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --data '
{
  "question": {
    "kind": "dropdown",
    "position": 2,
    "attributes": {
      "label": "Work email",
      "is_required": true
    }
  }
}
'

const options = {
  method: 'POST',
  headers: {'X-Api-Key': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    question: {
      kind: 'dropdown',
      position: 2,
      attributes: {label: 'Work email', is_required: true}
    }
  })
};

fetch('https://{your-subdomain}.neetoform.com/api/external/v2/forms/{form_id}/questions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{your-subdomain}.neetoform.com/api/external/v2/forms/{form_id}/questions"

payload = { "question": {
        "kind": "dropdown",
        "position": 2,
        "attributes": {
            "label": "Work email",
            "is_required": True
        }
    } }
headers = {
    "X-Api-Key": "<x-api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "question": {
    "id": "6b1f2c1e-2d7a-4a55-9c4e-0f1f8a7b2c11",
    "kind": "dropdown",
    "position": 2,
    "state": "draft",
    "has_draft_changes": true,
    "attributes": {
      "label": "Plan",
      "description": "",
      "is_required": true,
      "is_hidden": false,
      "is_multi_select": false,
      "placeholder": "",
      "properties": {
        "is_randomized": false
      },
      "options": [
        {
          "id": "draft-0c6e1b2a-4f1d-4c53-9d1e-7a1b2c3d4e5f",
          "alt_id": "alt-9a41d2c8-3b7e-4a62-8f10-5d6e7f8a9b0c",
          "label": "Basic",
          "position": 0
        },
        {
          "id": "draft-5d2b8e44-1c9a-47f3-b6d2-0e1f2a3b4c5d",
          "alt_id": "alt-17fe3a90-6d2b-4c81-a5e4-9b8c7d6e5f4a",
          "label": "Pro",
          "position": 1
        }
      ]
    }
  }
}

{
  "error": "Form does not exist."
}

{
  "error": "'stripe_payment' questions cannot be added. Addable kinds: short_text, long_text, dropdown"
}

Replace {your-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Workspace subdomain.

Headers

X-Api-Key

string

default:your-api-key

required

Use the X-Api-Key header to provide your workspace API key. Refer to Authentication for more information.

Path Parameters

form_id

string

required

Unique ID of the form. Refer to Getting the Form ID for detailed instructions.

Body

application/json

question

object

required

Hide child attributes

question.kind

string

required

Kind of the question to add.

Example:

"dropdown"

question.position

integer

Zero-based position for the new question. When omitted, the question is added just before the submit button.

Example:

2

question.attributes

object

Values for the question. Use the names listed for the kind in the list question kinds endpoint. Any other name is rejected.

Object values such as properties are merged key by key into the current value. Lists such as options, fields, row_entities, column_entities and products replace the whole list in the order given. Pass id to keep an existing item, leave id out to add a new item, and leave an item out to remove it. Image uploads are not supported.

Example:

{
  "label": "Work email",
  "is_required": true
}

Response

Created - Question added successfully

question

object

Hide child attributes

question.id

string

Example:

"6b1f2c1e-2d7a-4a55-9c4e-0f1f8a7b2c11"

question.kind

string

Kind of the question, for example dropdown, short_text or submit.

Example:

"dropdown"

question.position

integer

Zero-based position among all elements of the form.

Example:

2

question.state

string

draft until the form is published with this question, then published.

Example:

"draft"

question.has_draft_changes

boolean

Whether the question has changes that are not published yet.

question.attributes

object

Current values of the question, with unpublished draft changes applied. The keys depend on the kind. Image data is never returned.

Example:

{
  "label": "Plan",
  "description": "",
  "is_required": true,
  "is_hidden": false,
  "is_multi_select": false,
  "placeholder": "",
  "properties": { "is_randomized": false },
  "options": [
    {
      "id": "draft-0c6e1b2a-4f1d-4c53-9d1e-7a1b2c3d4e5f",
      "alt_id": "alt-9a41d2c8-3b7e-4a62-8f10-5d6e7f8a9b0c",
      "label": "Basic",
      "position": 0
    },
    {
      "id": "draft-5d2b8e44-1c9a-47f3-b6d2-0e1f2a3b4c5d",
      "alt_id": "alt-17fe3a90-6d2b-4c81-a5e4-9b8c7d6e5f4a",
      "label": "Pro",
      "position": 1
    }
  ]
}

Getting started

Forms

Questions

Conditional logic

Automation rules

Thank-you pages

Form settings

Message templates

Share

Submissions

Themes

Webhooks

Discount codes

Templates

Team members

Roles

Audit logs

IP restriction

Custom domains

API keys

API v1 (deprecated)

Add a question

Headers

Path Parameters

Body

Response