Create form
create_formCreate a new form and return its public link. A form is a page of questions that collects answers. An animated wedding invitation page is a different object, built by create_invitation, and the phrase "wedding invitation form" usually describes that page rather than a questionnaire.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| rules | No | Conditional show/hide logic: each rule reads one field's answer and shows or hides another. Only set this when asked for a field to depend on another; most forms carry no rules. Every fieldId used must exist in this same `fields` array, a rule referencing a field that isn't there is dropped. | |
| theme | No | Visual preset: the form's entire look, not only its background colour. DESIGNED PRESETS (typography, field styling, depth and background together): `editorial`: warm paper, serif title, understated. This is the answer when the user asks for something beautiful, premium, elegant, polished, smart or professional without naming a colour. Category presets, each with its own title font; pick by what the form is for: `blush`: weddings, engagements, beauty, celebrations. `bistro`: restaurants, cafes, catering, food orders, hotels. `playground`: schools, courses, kids' classes, summer camps. `studio`: gyms, fitness classes, sport, races (dark). `clinic`: healthcare, dental, therapy, patient intake. `noir`: tattoo, photography, music, creative studios (dark). `chambers`: law, accountancy, consulting, anything that ends in a signature. `terminal`: engineering, IT, bug reports, internal tooling (dark). `meadow`: charities, community groups, volunteering, the environment. `civic`: councils, school offices, public services, official reports. `frost`: winter events, travel, and anything that should feel cool and unhurried. These show a cover photo behind the title when the form has one. SCENES (a photograph behind the form, with the card tinted to match it). Reach for one when the form is for a real place or occasion and the user wants it to feel like that place. All are dark: `lane`: pools, gyms, swimming, anything with water. `skyline`: property, architecture, city and office work. `ceremony`: weddings and formal invitations. `nightfield`: festivals, gigs, outdoor events after dark. `kiln`: studios, workshops, craft and making things by hand. `confetti`: parties, birthdays, celebrations. `supper`: restaurants, reservations, hospitality. `roastery`: cafes, coffee, drink orders. `expedition`: tours, travel, the outdoors. `salon`: salons, barbers, beauty appointments. `thermal`: spas, treatments, rest. `lecture`: courses, training, teaching. `atrium`: clinics and practices, calm and clinical. `marquee`: conferences, talks, ticketed events. `trailhead`: races, runs, outdoor signups. `pressroom`: photography, press, creative bookings. A scene carries a photograph the user did not choose, so prefer a category preset unless they asked for imagery or described a setting. PLAIN: `default` (warm neutral, standard field styling). The flat colour palettes that used to sit here are retired: they still render on forms that already use them, but nothing should pick one now. How to choose: - They named a colour → the category preset or scene closest to it. - The form clearly belongs to one of the categories above → that category preset. - They asked for it to look good but named no colour → `editorial`. - They asked for neither → OMIT. A form nobody asked to style stays default. Each preset is a matched set and cannot be mixed or set piecemeal. If the user asked for something none of these express (a specific hex value, two colours combined, a particular font), apply the nearest and tell them plainly what you could and couldn't do. | |
| title | Yes | ||
| fields | No | Do not open with a `heading` field that repeats the form title. The title already renders above the fields. Use `heading` fields only to break a multi-topic form into named sections. For anything the respondent attaches from their device (a CV, resume, photo, receipt, portfolio) the type is `upload`, never `file`. `file` is a plain URL text box and collects no file at all. A `label` or `helpText` may quote an earlier answer back to the respondent by writing `{{<field id>}}`, e.g. a field with id `q1` asking their name lets a later label read `Thanks {{q1}}, what is your email?`. The reference is the other field's **id**, never its label, and that field must appear earlier in this same `fields` array; add `|` and fallback text (`{{q1|there}}`) for what to show when they skipped it. A reference naming a field that is not in this array is rejected. | |
| layout | No | How the form presents itself. `classic` stacks every question on one page and is the default. `conversational` asks one question per screen, with a progress bar and Next/Back, the Typeform-style flow. Set `conversational` when the user asks for one question at a time, a guided or step-by-step form, or something that feels like a conversation; it pairs especially well with labels that quote an earlier answer. It changes nothing about what is collected, so it is safe to set on a form that already has responses. | |
| description | No | ||
| submitLabel | No | Text on the final button, at most 40 characters. Write what pressing it does, in the form's own voice: "Book my table", "Count me in", "Send my RSVP". Omit for "Submit". Ignored on payment forms, whose button always states the amount. | |
| templateSlug | No | Start from one of our ready-made templates. Call list_templates to find the slug. STRONGLY PREFERRED over writing fields by hand whenever a template fits: the template brings its own field set, colour theme and header artwork, none of which you can supply yourself. Omit `fields` to take the template's as-is; supply `fields` only to genuinely replace them, which loses the template's questions but keeps its theme and artwork. | |
| notAnInvitation | No | Leave this out. Set it to true only after the user has been told about the interactive invitation page and has explicitly said they want a plain questionnaire instead. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| slug | Yes | ||
| theme | Yes | ||
| formId | Yes | ||
| publicUrl | Yes |