Build a Form

Create forms from the Integrations page or the authenticated project API.

Basic Form Shape

json
{ "name": "Contact support", "slug": "contact", "fields": [ { "id": "email", "type": "email", "label": "Email", "name": "email", "required": true }, { "id": "message", "type": "long_text", "label": "How can we help?", "name": "message", "required": true } ], "success_action": "inline", "success_message": "Thanks. We received your message.", "allowed_origins": ["https://example.com"], "rate_limit_per_ip": 5, "rate_limit_window_seconds": 600}

Field Types

TypeUse
short_textShort free text.
long_textMessage body or longer explanation.
emailEmail address validation.
numberNumeric values.
phonePhone number text.
checkboxSingle boolean-like field.
radioOne option from a visible list.
single_selectOne option from a select.
multi_selectMultiple selected options.
dateDate input.
fileFile upload.

Submit Button

Forms support:

  • submit_button_label
  • submit_button_align: left, center, right, or full
  • submit_button_color: hex color or null for brand default

Archive and Unarchive

Archived forms stop accepting submissions and return 410 Gone from public endpoints. Unarchive when the form should accept submissions again.

Ask a question... ⌘I