1. Docs
2. /
3. Tool reference
4. /
5. Forms
6. /
7. createForm

Forms

createForm

Create Form

Create a form in the Forms app, filed in a Space when you pass spaceId, a Studio app that belongs to a Space, or a Space-scoped connection.

write

Arguments

• appIdstringoptionalStudio app id. When that app belongs to a Space and spaceId is omitted, the form files there.
• capacityintegeroptionalMax responses before the form auto-closes to a full state (Sanctuary gatherings cap at 6). Omit for uncapped.
• descriptionstringoptionalOptional short description.
• fieldsobject[]optionalFields to seed, in order.
• iconDataobjectoptionalForm icon for the sidebar + public page. Use { type: 'emoji', value: '📝' } (one emoji aligned with the form's subject); defaulted from the title when omitted.
• publishbooleanoptionalPublish now so it accepts anonymous submissions. Default false (creates a draft).
• spaceIdstringoptionalSpace to file the form in. Omit to inherit from appId or a Space-scoped connection.
• titlestringrequiredForm title, e.g. 'july 12 gathering RSVP'.

Returns

Returns the form id, slug, status, and its canonical public URL (the ready-to-share /f/<slug> link; use it directly, never rebuild it from the slug).

Declared limits

• capacity: greater than 0
• capacity: maximum 9007199254740991

Ask for it

The Cloud routes these requests to this verb.

• make a form
• create an RSVP form
• set up a signup

Pair it with

The verbs that finish the job.

• listFormResponses
• getFormResponse