Update a form's section

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

Path parameters

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

      Additional properties are allowed.

    • title string

      The title of the section

    • position integer

      The position of the section

    • questions object

      The questions in the section

      Additional properties are allowed.
PUT /api/v1/form/{form_uuid}/section/{uuid} 
curl \
 -X PUT https://api.plannrcrm.com/api/v1/form/form_uuid/section/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 '{"title":"Section 1.1","position":0}'
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
{
  "title": "Section 1.1",
  "position": 0
}
Response examples (200) 
{
  "form": {
    "live": true,
    "uuid": "015f9a87-a4e6-4d7c-8932-7ed9c791e9a2",
    "title": "Annual Catchup 2022",
    "sections": "App\\Http\\Resources\\FormQuestionResource",
    "created_at": "2024-11-20T13:24:01+00:00",
    "updated_at": "2024-11-20T13:24:01+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": "3931da8a-d063-4481-8be9-6c0001d4312a",
  "title": "Personal Details",
  "position": 1,
  "questions": {
    "key": "what_is_your_name",
    "type": "string",
    "uuid": "d6fbe7ec-f6e4-4e9c-ac59-1c1f7f4cb474",
    "title": "What is your name?",
    "caption": "Your full legal name",
    "section": "App\\Http\\Resources\\FormSectionResource",
    "position": 1,
    "required": true,
    "help_text": "Gareth",
    "created_at": "2024-11-20T13:24:01+00:00",
    "updated_at": "2024-11-20T13:24:01+00:00",
    "target_field": "name",
    "linked_primary": true,
    "linked_question": "App\\Http\\Resources\\FormBuilder\\LinkedFormQuestionResource",
    "selection_options": [
      "option 1",
      "option 2"
    ]
  },
  "created_at": "2024-11-20T13:24:01+00:00",
  "updated_at": "2024-11-20T13:24:01+00:00"
}