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.

Properties1 <= properties

title?string

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

captcha?boolean

fields?array<>

Items1 <= items

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.

closed?boolean

Stop or resume accepting responses, without publishing. Reopening only clears the manual close — a passed close date or a met response limit still closes the form.

closed_message?string

What respondents see while the form is closed. null restores the default.

archived?boolean

File the form away. Archiving closes it as a side effect unless you pass closed too.

Response Body

`application/json`

curl -X PATCH "https://example.com/api/v1/forms/string" \  -H "Content-Type: application/json" \  -d '{    "title": "Book a trial class",    "fields": [      {        "key": "parent_name",        "type": "text",        "label": "Your name",        "required": true      },      {        "key": "parent_email",        "type": "email",        "label": "Email",        "required": true      },      {        "key": "heard_from",        "type": "text",        "label": "How did you hear about us?"      }    ]  }'

{  "id": "cm4frm2xy0001kp04a7c9v1de",  "title": "Book a trial class",  "status": "published",  "version": 2,  "warnings": [    "Removed field \"message\".",    "Dropped 1 conditional logic rule(s) that depended on a removed field."  ]}

Update a form

Authorization

Path Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

Update a form

Authorization

Path Parameters

Request Body

Response Body

200application/json

401application/json

404application/json

422application/json

`application/json`

`application/json`

`application/json`

`application/json`