Sign in
IntakeForms

Create an IntakeFormSection

Use this endpoint to create a new IntakeFormSection.

post/shop/intake-form-sections

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, before the questions. Markdown is rendered.

outro_textstring nullable

Optional rich-text shown to the customer at the foot of the section, after the questions. Useful for thank-yous or follow-up instructions.

site_idstring uuid required

ID of the site this intake form section belongs to.

titlestring required

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 created an IntakeFormSection.

Example response

{
  "data": {
    "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",
    "updated_at": "2025-02-04T12:00:00+01:00"
  }
}

Changes

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