Update a form's section | PlannrCRM API documentation

Update a form's 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

{
  "PlannrCRM MCP server": {
    "url": "https://apidocs.plannrcrm.com/mcp"
  }
}

PUT /api/v1/form/{form_uuid}/section/{uuid}

Personal access token & O auth2

Headers

X-PLANNR-ACCOUNT-UUID string

Path parameters

form_uuid string Required
uuid string Required

application/json

Body

title string Required

The title of the section
position integer

The position of the section in the form.

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.
- form object
  
  The form this section belongs to
  
  Hide form attributes Show form attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  title string
  
  description string
  
  live boolean
  
  visibility string
  
  sections object
  
  Hide sections attributes Show sections 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
  
  allowed_hosts array[string]
  
  draft_submissions_count integer
  
  submitted_submissions_count integer
  
  create_client boolean
  
  client_type string
- title string
  
  The title of the section
- position integer
  
  The position of the section
- questions object
  
  The questions in the section
  
  Hide questions attributes Show questions attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  section object
  
  Hide section attributes Show section 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 section
  
  position
  
  The position of the section
  
  title string
  
  help_text string
  
  caption string
  
  type string
  
  required boolean
  
  position integer
  
  selection_options array[string]
  
  target_field string
  
  key string
  
  linked_question object
  
  Hide linked_question attributes Show linked_question attributes object
  
  type
  
  Type of question
  
  field
  
  The field this question is linked to
  
  label
  
  The label this question is linked to
  
  formatted_field
  
  The field formatted in title case
  
  selection_options
  
  The selection options for selection type questions
  
  is_custom_field
  
  Denotes if this is linked to a custom field
  
  forced_required
  
  Denotes if this is question must be required
  
  caption
  
  Placeholder caption for this question
  
  linked_primary boolean
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

PUT /api/v1/form/{form_uuid}/section/{uuid}

curl \
 --request PUT 'https://api.plannrcrm.com/api/v1/form/6ff8f7f6-1eb3-3525-be4a-3932c805afed/section/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{
  "title": "Section 1.1",
  "position": 0
}'

Request examples

# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "title": "Section 1.1",
  "position": 0
}

Response examples (200)

{
  "uuid": "d5938e24-defe-45d1-bc98-ffe642ed8f35",
  "created_at": "2026-10-27T15:44:13+00:00",
  "updated_at": "2026-10-27T15:44:13+00:00",
  "form": {
    "uuid": "314026a1-e425-42e4-96c8-89ce5e24e88c",
    "created_at": "2026-10-27T15:44:13+00:00",
    "updated_at": "2026-10-27T15:44:13+00:00",
    "title": "Annual Catchup 2022",
    "description": "This is the annual catchup form for 2022",
    "live": true,
    "visibility": "public",
    "sections": {
      "uuid": "b7403c60-aa52-4f8e-a100-939ff435226d",
      "created_at": "2026-10-27T15:44:19+00:00",
      "updated_at": "2026-10-27T15:44:19+00: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
    },
    "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": "c4f34efe-d738-4998-bc8e-41609eb506bd",
    "created_at": "2026-10-27T15:44:13+00:00",
    "updated_at": "2026-10-27T15:44:13+00:00",
    "section": {
      "uuid": "e02cea20-3cc5-4dd7-97a2-e9f7b8b486b4",
      "created_at": "2026-10-27T15:44:19+00:00",
      "updated_at": "2026-10-27T15:44:19+00:00",
      "title": "Personal Details",
      "position": 1
    },
    "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."
    ]
  }
}