Update a schema section

PUT /api/v1/fact-find/schema/{factFindSchema_uuid}/section/{factFindSchemaSection_uuid}
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, contact_details, debt, dependants, employment, employment_and_income, estate, expenses, fixed_assets, goals, health, income, investments, personal_details, plans, property, protection, state_pension, 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, contact_details, debt, dependants, employment, employment_and_income, estate, expenses, fixed_assets, goals, health, income, investments, personal_details, plans, property, protection, state_pension, 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 \
 -X PUT https://api.plannrcrm.com/api/v1/fact-find/schema/factFindSchema_uuid/section/factFindSchemaSection_uuid \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 -d '{"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
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json
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": "05d968f7-3923-4c7e-a0dd-89111a84553e",
  "position": 1,
  "created_at": "2024-11-20T13:24:03+00:00",
  "updated_at": "2024-11-20T13:24:03+00:00",
  "front_end_section": "basic_details",
  "introduction_html": "<p>Please tell us your <b>basic details.</b></p>"
}