Create a question for a section Run in API Explorer

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://apidocs.plannrcrm.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
{
  "PlannrCRM MCP server": {
    "url": "https://apidocs.plannrcrm.com/mcp"
  }
}
Close
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

  • 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 Required

    The selection options for the question IF the question is of type selection.

  • section_uuid string(uuid) 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 object
        Hide form attributes Show form attributes object
        • uuid

          The UUID of the resource.

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • title

          The title of the form

        • description

          The description of the form

        • live

          Whether the form is live

        • visibility

          The visibility of the form

        • allowed_hosts

          Array of allowed domains that this form can be accessed from using different origins

        • draft_submissions_count

          Count of draft submissions against this form

        • submitted_submissions_count

          Count of submitted submissions against this form

        • create_client

          Denotes if this form creates a new client when it is submitted from a public embed

        • client_type

          If create_client is true, then the client_type is the type of client that will be created, possible values are client and prospect

      • title string
      • position integer
      • questions object
        Hide questions attributes Show questions attributes object
        • uuid

          The UUID of the resource.

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • title

          The title of the question

        • help_text

          Input placeholder text

        • caption

          Text to describe the input

        • type

          The type of question

        • required

          Whether the question is required

        • position

          The position of the question in the section

        • selection_options

          The options for selection questions

        • target_field

          The field to update upon question completion

        • key

          The key to use when updating the target field

        • linked_primary

          Will the this linked field become a primary Address/Phone Number/Email Address

    • 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
  • 422 application/json

    Validation error

    Hide response attributes Show response attributes object
    • message string Required

      A human-readable description of the error.

    • errors object

      Validation messages keyed by the field that failed.

      Hide errors attribute Show errors attribute object
      • * array[string] Additional properties
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":"25e93e5c-d9c5-471e-a3ef-20a0f35d55fe","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": "25e93e5c-d9c5-471e-a3ef-20a0f35d55fe",
  "target_field": "client.first_name",
  "linked_question_field": "first_name",
  "linked_primary": false
}
Response examples (200) 
{
  "uuid": "58c80442-dbfe-43b7-a09d-0f2b99d13220",
  "created_at": "2026-08-28T07:34:59+01:00",
  "updated_at": "2026-08-28T07:34:59+01:00",
  "section": {
    "uuid": "c12bf19a-21e0-44bc-856b-c78c6b0e8726",
    "created_at": "2026-08-28T07:34:59+01:00",
    "updated_at": "2026-08-28T07:34:59+01:00",
    "form": {
      "uuid": "8e4cbd9c-54a7-433f-ac50-9bc63be21ec0",
      "created_at": "2026-08-28T07:35:05+01:00",
      "updated_at": "2026-08-28T07:35:05+01:00",
      "title": "Annual Catchup 2022",
      "description": "This is the annual catchup form for 2022",
      "live": true,
      "visibility": "public",
      "allowed_hosts": [
        "domain.com",
        "subdomain.domain.com"
      ],
      "draft_submissions_count": 5,
      "submitted_submissions_count": 5,
      "create_client": true,
      "client_type": "client"
    },
    "title": "Personal Details",
    "position": 1,
    "questions": {
      "uuid": "794698e0-a089-406b-83d3-3351e4c4b7fa",
      "created_at": "2026-08-28T07:35:05+01:00",
      "updated_at": "2026-08-28T07:35:05+01:00",
      "title": "What is your name?",
      "help_text": "Gareth",
      "caption": "Your full legal name",
      "type": "string",
      "required": true,
      "position": 1,
      "selection_options": [
        "option 1",
        "option 2"
      ],
      "target_field": "name",
      "key": "what_is_your_name",
      "linked_primary": true
    }
  },
  "title": "What is your name?",
  "help_text": "Gareth",
  "caption": "Your full legal name",
  "type": "string",
  "required": true,
  "position": 1,
  "selection_options": [
    "option 1",
    "option 2"
  ],
  "target_field": "name",
  "key": "what_is_your_name",
  "linked_question": {
    "type": "selection",
    "field": "gender",
    "label": "Gender",
    "formatted_field": "Gender",
    "selection_options": [
      "male",
      "female",
      "non-binary",
      "transgender",
      "intersex",
      "other",
      "unknown"
    ],
    "is_custom_field": false,
    "forced_required": false,
    "caption": "Your drink preference"
  },
  "linked_primary": true
}
Response examples (422) 
{
  "message": "The given data was invalid.",
  "errors": {
    "field": [
      "The field is invalid."
    ]
  }
}