Body
Required
-
The type of the question
-
Whether the question is required or not
-
The title of the question
-
Input placeholder
-
User friendly description of what should be input
-
The position of the question in the section.
-
The selection options for the question IF the question is of type selection.
-
The uuid of the section to move the question to.
-
The field to update if the question is filled in
-
Create a question from a linked field, with this, the type and selection options can be ignored
-
If this is a contact detail or address field, should it be made primary?
POST
/api/v1/form/{form_uuid}/question
curl \
--request POST 'https://api.plannrcrm.com/api/v1/form/6ff8f7f6-1eb3-3525-be4a-3932c805afed/question' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
--data '{"type":"string","required":"true","title":"What is your name?","help_text":"Gareth","caption":"Enter your full legal name","position":0,"selection_options":["apple","orange"],"section_uuid":"9c291135-288e-4b49-8fba-294f522053ce","target_field":"client.first_name","linked_question_field":"first_name","linked_primary":false}'
Request examples
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"type": "string",
"required": "true",
"title": "What is your name?",
"help_text": "Gareth",
"caption": "Enter your full legal name",
"position": 0,
"selection_options": [
"apple",
"orange"
],
"section_uuid": "9c291135-288e-4b49-8fba-294f522053ce",
"target_field": "client.first_name",
"linked_question_field": "first_name",
"linked_primary": false
}
Response examples (200)
{
"key": "what_is_your_name",
"type": "string",
"uuid": "40c47386-7501-4784-b82d-cfd3c068efa7",
"title": "What is your name?",
"caption": "Your full legal name",
"section": {
"form": "App\\Http\\Resources\\FormResource",
"uuid": "a72cdcca-ab21-4953-8c3f-e7f024930d2d",
"title": "Personal Details",
"position": 1,
"questions": "App\\Http\\Resources\\FormQuestionResource",
"created_at": "2025-08-07T13:41:41+01:00",
"updated_at": "2025-08-07T13:41:41+01:00"
},
"position": 1,
"required": true,
"help_text": "Gareth",
"created_at": "2025-08-07T13:41:41+01:00",
"updated_at": "2025-08-07T13:41:41+01:00",
"target_field": "name",
"linked_primary": true,
"linked_question": {
"type": "selection",
"field": "gender",
"label": "Gender",
"caption": "Your drink preference",
"forced_required": false,
"formatted_field": "Gender",
"is_custom_field": false,
"selection_options": [
"male",
"female",
"non-binary",
"transgender",
"intersex",
"other",
"unknown"
]
},
"selection_options": [
"option 1",
"option 2"
]
}