Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Paste your API key as the CMS showed it: fsk_<site>_<key id>_<secret> (issued under API Keys). ApiKey in front of it works too. Leave it empty to read as the public.

Scopes

content:forms:publish

Path Parameters

_id
string
required

The document’s _id: a full id names its own locale and mode (the draft’s …:en:draft, the published one’s …:en:published; no aposMode needed), a bare aposDocId takes the request’s (aposLocale, aposMode).

Response

Done.

Form content type

title
string
default:""
required

Its title: the name it goes by in every list, and the heading of its page where it has one.

slug
string
default:""
required

The URL name: lowercase words joined by hyphens (letters outside a–z, even emoji, are kept).

visibility
enum<string>
default:public
required

Select whether this content is public or private

Available options:
public,
loginRequired
email
string
default:""
required

The "from" address on this form's emails. A new form starts with the Email in Site settings → Brand; change it here for this form.

_id
string
required
read-only

The document’s id. On a type with drafts it ends in its locale and mode (…:en:published, …:en:draft): the part before the first colon is its aposDocId, shared by both copies. The {_id} the type’s routes take.

type
string
required
read-only

The document type’s name: always this type’s.

createdAt
string<date-time>
required
read-only

When it was created (ISO 8601).

updatedAt
string<date-time>
required
read-only

When it last changed (ISO 8601).

contents
Form contents · object

Widgets, top to bottom: send { "items": [ … ] }, one object per widget with its type. Writing it replaces the whole area. A new document starts with form-section.

Example:
scheduledPublish
string | null

An ISO 8601 date and time, e.g. 2026-10-21T14:30:00.000Z.

scheduledUnpublish
string | null

An ISO 8601 date and time, e.g. 2026-10-21T14:30:00.000Z.

thankYouHeading
string | null
default:""

Thank you message title.

thankYouBody
Thank you message content · object

Widgets, top to bottom: send { "items": [ … ] }, one object per widget with its type. Writing it replaces the whole area.

Example:
sendConfirmationEmail
boolean | null

Enable this to send a message to the person who submits this form.

emailConfirmationField
string | null
default:""

Enter the "name" value of the field where people with enter their email address. For best results, make sure this field only accepts email addresses.

emails
Email Address(es) for Results · object[] | null

Email Address(es) for Results.

googleSheetSubmissions
boolean | null

Submit to Google Spreadsheets.

googleSpreadsheetId
string | null
default:""

Google Spreadsheet ID.

googleSheetName
string | null
default:""

The name of the sheet tab in your Google spreadsheet where you want the submission appended. If not provided, the first sheet of the spreadsheet will be used.

submitLabel
string | null
default:""

Submit button label.

enableRecaptcha
boolean | null

To use, reCAPTCHA a site ID and secret key must be configured in website code or the website global settings.

enableQueryParams
boolean | null

Enable query parameter capture.

queryParamList
Query parameter keys · object[] | null

Create an array item for each query parameter value you wish to capture.

formActions
Actions · object[] | null

What happens to each submission, beyond being stored in the CMS. Add one row per destination; several can run for one form. Storage always happens regardless.

archived
boolean | null
default:false

In the archive: kept, but out of every list and off the site until it is restored. false (or null) for a live document.

aposShareKey
string | null
read-only

The draft’s preview share key, while its share link is on: the link is the draft’s _url with aposShareKey and aposShareId (the draft’s _id) in its query. Absent otherwise, and on published documents.

Example:

"k3v9x2m7q1z8w4p6"