Update a schema section

PUT /api/v1/fact-find/schema/{factFindSchema_uuid}/section/{factFindSchemaSection_uuid}

Personal access token & O auth2

Headers

X-PLANNR-ACCOUNT-UUID string

Path parameters

factFindSchema_uuid string Required
factFindSchemaSection_uuid string Required

application/json

Body

name string

The name of the fact-find schema section. Must be unique.
front_end_section string

The reference to the Plannr front-end. Must be unique. Available options:basic_details, be_iq_profiler, contact_details, debt, dependants, employment, employment_and_income, estate, expenses, fixed_assets, goals, health, income, introduction, investments, personal_details, plans, property, protection, state_pension, summary, vulnerability
introduction_html string

The HTML that should be displayed on the section.
position integer

The position/order of the section

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.
- name string
  
  The name of the fact-find schema section.
- front_end_section string
  
  The reference to the Plannr front-end. Available options:basic_details, be_iq_profiler, contact_details, debt, dependants, employment, employment_and_income, estate, expenses, fixed_assets, goals, health, income, introduction, investments, personal_details, plans, property, protection, state_pension, summary, vulnerability
- introduction_html string
  
  The HTML that should be displayed on the section.
- position integer
  
  The position/order of the section

PUT /api/v1/fact-find/schema/{factFindSchema_uuid}/section/{factFindSchemaSection_uuid}

curl \
 --request PUT 'https://api.plannrcrm.com/api/v1/fact-find/schema/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 '{"name":"Basic Details","front_end_section":"basic_details","introduction_html":"\u003cp\u003ePlease tell us your \u003cb\u003ebasic details.\u003c/b\u003e\u003c/p\u003e","position":1}'

Request examples

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

# Payload
{
  "name": "Basic Details",
  "front_end_section": "basic_details",
  "introduction_html": "<p>Please tell us your <b>basic details.</b></p>",
  "position": 1
}

Response examples (200)

{
  "name": "Basic Details",
  "uuid": "9ca80c94-d08d-4b7a-80e4-d19fe40cb9c4",
  "position": 1,
  "created_at": "2025-06-26T11:37:09+01:00",
  "updated_at": "2025-06-26T11:37:09+01:00",
  "front_end_section": "basic_details",
  "introduction_html": "<p>Please tell us your <b>basic details.</b></p>"
}