Create a question for a section

POST /api/v1/form/{form_uuid}/question

Personal access token & O auth2

Headers

X-PLANNR-ACCOUNT-UUID string

Path parameters

form_uuid string Required

application/json

Body Required

type string Required

The type of the question
required boolean Required

Whether the question is required or not
title string Required

The title of the question
help_text string

Input placeholder
caption string

User friendly description of what should be input
position integer Required

The position of the question in the section.
selection_options array[string] Required

The selection options for the question IF the question is of type selection.
section_uuid string Required

The uuid of the section to move the question to.
target_field string

The field to update if the question is filled in
linked_question_field string

Create a question from a linked field, with this, the type and selection options can be ignored
linked_primary boolean

If this is a contact detail or address field, should it be made primary?

Responses

200 application/json
Hide response attributes Show response attributes object
- uuid string
  
  The UUID of the resource.
- created_at string
  
  The timestamp of when the resource was created.
- updated_at string
  
  The timestamp of when the resource was updated.
- section object
  
  The section this question belongs to
  
  Hide section attributes Show section attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  form string
  
  title string
  
  position integer
  
  questions string
- title string
  
  The title of the question
- help_text string
  
  Input placeholder text
- caption string
  
  Text to describe the input
- type string
  
  The type of question
- required boolean
  
  Whether the question is required
- position integer
  
  The position of the question in the section
- selection_options array[string]
  
  The options for selection questions
- target_field string
  
  The field to update upon question completion
- key string
  
  The key to use when updating the target field
- linked_question object
  
  the linked form question
  
  Hide linked_question attributes Show linked_question attributes object
  
  type string
  
  field string
  
  label string
  
  formatted_field string
  
  selection_options array[string]
  
  is_custom_field boolean
  
  forced_required boolean
  
  caption string
- linked_primary boolean
  
  Will the this linked field become a primary Address/Phone Number/Email Address

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":"1e2b4fe0-61cc-4256-81cd-54055a0602ab","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": "1e2b4fe0-61cc-4256-81cd-54055a0602ab",
  "target_field": "client.first_name",
  "linked_question_field": "first_name",
  "linked_primary": false
}

Response examples (200)

{
  "key": "what_is_your_name",
  "type": "string",
  "uuid": "951010a2-1eb2-4a01-a4b8-7b7039c7fe13",
  "title": "What is your name?",
  "caption": "Your full legal name",
  "section": {
    "form": "App\\Http\\Resources\\FormResource",
    "uuid": "5c1b84b0-6542-457b-8d11-62ad69329b48",
    "title": "Personal Details",
    "position": 1,
    "questions": "App\\Http\\Resources\\FormQuestionResource",
    "created_at": "2025-08-27T17:31:26+01:00",
    "updated_at": "2025-08-27T17:31:26+01:00"
  },
  "position": 1,
  "required": true,
  "help_text": "Gareth",
  "created_at": "2025-08-27T17:31:26+01:00",
  "updated_at": "2025-08-27T17:31:26+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"
  ]
}