Update a form's section | PlannrCRM API documentation

Update a form's section Run in API Explorer

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 Required

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 string
  
  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 string
  
  title string
  
  help_text string
  
  caption string
  
  type string
  
  required boolean
  
  position integer
  
  selection_options array[string]
  
  target_field string
  
  key string
  
  linked_question string
  
  linked_primary boolean

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)

{
  "form": {
    "live": true,
    "uuid": "5c9694c7-dcb3-49d6-8a78-984988296f22",
    "title": "Annual Catchup 2022",
    "sections": "App\\Http\\Resources\\FormQuestionResource",
    "created_at": "2025-11-17T21:14:39+00:00",
    "updated_at": "2025-11-17T21:14:39+00:00",
    "visibility": "public",
    "client_type": "client",
    "description": "This is the annual catchup form for 2022",
    "allowed_hosts": [
      "domain.com",
      "subdomain.domain.com"
    ],
    "create_client": true,
    "draft_submissions_count": 5,
    "submitted_submissions_count": 5
  },
  "uuid": "930a0442-884e-42e1-ab69-fc82dfc364c3",
  "title": "Personal Details",
  "position": 1,
  "questions": {
    "key": "what_is_your_name",
    "type": "string",
    "uuid": "eaf18e6a-947a-4af9-b414-880000bda86e",
    "title": "What is your name?",
    "caption": "Your full legal name",
    "section": "App\\Http\\Resources\\FormSectionResource",
    "position": 1,
    "required": true,
    "help_text": "Gareth",
    "created_at": "2025-11-17T21:14:39+00:00",
    "updated_at": "2025-11-17T21:14:39+00:00",
    "target_field": "name",
    "linked_primary": true,
    "linked_question": "App\\Http\\Resources\\FormBuilder\\LinkedFormQuestionResource",
    "selection_options": [
      "option 1",
      "option 2"
    ]
  },
  "created_at": "2025-11-17T21:14:39+00:00",
  "updated_at": "2025-11-17T21:14:39+00:00"
}