curl --request PATCH \
--url https://{your-subdomain}.neetoform.com/api/external/v2/forms/{form_id}/questions/{id} \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <x-api-key>' \
--data '
{
"question": {
"attributes": {
"label": "Work email",
"is_required": true
}
}
}
'const options = {
method: 'PATCH',
headers: {'X-Api-Key': '<x-api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({question: {attributes: {label: 'Work email', is_required: true}}})
};
fetch('https://{your-subdomain}.neetoform.com/api/external/v2/forms/{form_id}/questions/{id}', 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/{id}"
payload = { "question": { "attributes": {
"label": "Work email",
"is_required": True
} } }
headers = {
"X-Api-Key": "<x-api-key>",
"Content-Type": "application/json"
}
response = requests.patch(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": "Question does not exist."
}{
"error": "Not attributes of a dropdown question: color"
}Update a question
Update the values of a question. This also works for the welcome screen, logo, banner, submit button and progress bar. The change is saved as a draft and reaches respondents only after the form is published.
curl --request PATCH \
--url https://{your-subdomain}.neetoform.com/api/external/v2/forms/{form_id}/questions/{id} \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <x-api-key>' \
--data '
{
"question": {
"attributes": {
"label": "Work email",
"is_required": true
}
}
}
'const options = {
method: 'PATCH',
headers: {'X-Api-Key': '<x-api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({question: {attributes: {label: 'Work email', is_required: true}}})
};
fetch('https://{your-subdomain}.neetoform.com/api/external/v2/forms/{form_id}/questions/{id}', 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/{id}"
payload = { "question": { "attributes": {
"label": "Work email",
"is_required": True
} } }
headers = {
"X-Api-Key": "<x-api-key>",
"Content-Type": "application/json"
}
response = requests.patch(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": "Question does not exist."
}{
"error": "Not attributes of a dropdown question: color"
}{your-subdomain} with your workspace’s subdomain. Learn how to find your subdomain in Workspace subdomain.
Headers
Use the X-Api-Key header to provide your workspace API key. Refer to Authentication for more information.
Path Parameters
Unique ID of the form. Refer to Getting the Form ID for detailed instructions.
Unique ID of the question. Get it from the list questions endpoint.
Body
Hide child attributes
Hide child attributes
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.
{ "label": "Work email", "is_required": true }
Response
OK - Question updated successfully
Hide child attributes
Hide child attributes
"6b1f2c1e-2d7a-4a55-9c4e-0f1f8a7b2c11"
Kind of the question, for example dropdown, short_text or submit.
"dropdown"
Zero-based position among all elements of the form.
2
draft until the form is published with this question, then published.
"draft"
Whether the question has changes that are not published yet.
Current values of the question, with unpublished draft changes applied. The keys depend on the kind. Image data is never returned.
{ "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 } ] }