Automette

Authorization

ApiKeyAuth

AuthorizationBearer <token>

API key from Settings → API Keys.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

title*string

Names the form in your dashboard. Not rendered — see heading.

heading?string

The <h1> respondents read, stored as a content block. Defaults to title on create; null renders no heading at all — useful in an embed where the host page supplies its own headline.

This is separate from title, which names the form in the dashboard and is never rendered.

description?string

Intro paragraph shown under the heading, stored as a content block. null or "" removes it.

appearance?

Design belongs in the builder; these three exist because an embedded form has to sit inside a page you control and we do not.

Embeds are already fully transparent — page, card, and document background — so a form drops onto a coloured surface without setting anything here. Use these when you want the form to carry its own colours.

submit_label?string

Text on the submit button. Defaults to "Submit".

captcha?boolean

Spam protection on the public form. Defaults to true, which is right for a form real people fill in — the hosted and embedded pages solve the challenge for them.

Set it to false if your own code posts to the submission endpoint, which otherwise fails the challenge and gets a 403.

fields*array<>

Items1 <= items <= 100

notifications?

Who is told when a response arrives. Fields are referenced by the key you chose, never by an internal id.

respondent_confirmation?|

Automatic email back to the person who submitted. null turns it off.

sender_name?string

Display name respondents see on email from this form. Unset sends as the platform default.

limits?

When the form should stop accepting responses on its own.

after_submit?

Where the respondent lands after submitting. The authored thank-you page is designed in the builder; the API only chooses between it and a redirect.

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/forms" \  -H "Content-Type: application/json" \  -d '{    "title": "Book a free class",    "fields": [      {        "key": "parent_name",        "type": "text",        "label": "Your name",        "required": true      },      {        "key": "parent_email",        "type": "email",        "label": "Email",        "required": true      },      {        "key": "whatsapp",        "type": "tel",        "label": "WhatsApp",        "required": false      },      {        "key": "child_age",        "type": "select",        "label": "How old is your child?",        "required": true,        "options": [          {            "value": "8_9",            "label": "8–9 years"          },          {            "value": "10_11",            "label": "10–11 years"          }        ]      },      {        "key": "message",        "type": "textarea",        "label": "Anything else?",        "required": false      }    ]  }'

{  "id": "cm4frm2xy0001kp04a7c9v1de",  "self": "https://automette.com/api/v1/forms/cm4frm2xy0001kp04a7c9v1de",  "title": "Book a free class",  "status": "draft",  "version": null,  "public_url": null,  "embed_url": null,  "accepting_submissions": false,  "submission_count": 0,  "fields": [    {      "key": "parent_name",      "type": "text",      "label": "Your name",      "required": true    }  ]}

Create a form

Authorization

Request Body

Response Body

201application/json

401application/json

422application/json

`application/json`

`application/json`

`application/json`