Sign in
IntakeForms

Update an IntakeFormSection

Use this endpoint to update an IntakeFormSection.

put/shop/intake-form-sections/{intakeFormSectionId}

Request body

descriptionstring

Admin-facing description of what this intake form section captures. Visible in the questionnaire builder but not shown to customers.

intro_textstring nullable

Optional rich-text shown to the customer at the top of the section. Markdown is rendered.

orderinteger

Zero-based display order of this section relative to others on the same form. Lower values appear first.

outro_textstring nullable

Optional rich-text shown to the customer at the foot of the section, after the questions.

titlestring

Customer-facing heading for the section. Plain text only — HTML tags are stripped.

type'mandatory' nullable

Optional category flag. mandatory marks the section as non-skippable in the intake flow — the customer must complete it before checkout. Null (the default) makes the section advisory.

Example request

{
  "description": "Pre-treatment health questions and consent",
  "intro_text": "Please answer honestly — these questions help us tailor your\ntreatment safely.\n",
  "offerings": [
    {
      "offering_name": "Twilight massage",
      "offering_type": "appointment"
    }
  ],
  "outro_text": "Thank you. Please proceed to checkout when you're ready.\n",
  "title": "Health Declaration"
}

Response

Successfully updated an IntakeFormSection.

201ContentApplication1jsonSchema required— unresolved $ref

Changes

No recorded changes to this endpoint across all 1 revision of this API.