Forms
Every operation in this group: what it accepts, what it returns and the errors it can answer with.
Operations
Sign-up forms that add the people who fill them in to your audiences. A form has a draft document you edit and a published copy visitors see, so design changes go live only when you publish, while settings apply as soon as they are saved. Share a form by its hosted url, embed it with one script tag, or post to its subscribeUrl from your own HTML or code.
With double opt-in on, each person gets a confirmation email from the form's sending address and joins once they confirm or you approve them. Submissions keep every answer, and a person who joins becomes a contact in the workspace.
GET/forms
List forms
Every sign-up form in the workspace, newest first, without the document or settings. stats is counted at the moment of the read.
An app a member connected lists only the forms that member made, as the console does for them.
Requires the forms:read scope.
Query parameters
limitintegerRows per page, 1 to 100.
At least 1At most 100Default25cursorstringThe previous page's
nextCursor, passed back as it came. It is opaque: it holds where the last row sat in this list's order, so a row deleted or edited between pages never breaks the walk, and the next page starts at the first row that sorts after it. A value this list did not hand out is a 400invalid_cursor.
Returns
A page of forms.
Errors
The errors every operation can return400401403404422429500Error catalog
Also available in
- TypeScript
nextmail.forms.list()nextmail.forms.listAll()nextmail.forms.iterate()- Python
forms.list()forms.list_all()forms.iterate()- Ruby
forms.listforms.list_allforms.iterate- PHP
forms->listforms->listAllforms->iterate- Go
Forms.ListForms.ListAllForms.Iterate- Java
forms().listforms().listAllforms().iterate- C#
Forms.ListAsyncForms.ListAllAsyncForms.IterateAsync- CLI
nextmail forms list- MCP
listForms
POST/forms
Create a form
Makes a draft from document, from a starter, or from a one-field email form when neither is sent, and answers with the whole form. Send publish: true to put it live in the same call.
Every audience in settings.audienceIds and in an audience field has to be one the caller can reach in this workspace. settings.senderAddress has to be an address the caller may send as, and a key limited to some addresses may only name ones it holds there and in settings.notifyAddresses. A call that turns on settings.doubleOptIn, names a settings.senderAddress or changes the confirmation email also needs emails:send, because the form then sends mail for you.
A new form asks people to confirm by email: settings.doubleOptIn is true unless you send false. When you leave out both it and settings.senderAddress and the key holds emails:send, confirmations come from the first address the key may send as. A draft can wait without a sender, but publishing a double opt-in form needs one and emails:send, so publish: true without settings.doubleOptIn: false also needs emails:send. Forms made before this keep their setting.
Share it with url, post plain HTML forms to subscribeUrl, or embed it with the script /embed/form.js served from the web app's domain.
Requires the forms:write scope.
Request body
namestringRequiredWhat the workspace calls the form, trimmed, 1 to 120 characters. Visitors never see it, and it need not be unique.
1 to 120 charactersdescriptionstringA note for the workspace, at most 500 characters. Visitors never see it.
Can be nullUp to 500 charactersstarterstringBegin from a starter's fields, copy and style. Ignored when
documentis sent.One of"blank""newsletter""waitlist""event""early-access""contact"documentobjectEverything a visitor sees:
fieldsin order, thecopyaround them and thestyle. Every form has exactly oneemailfield, and every input field has a uniquekeythat answers are posted under.fieldsobject[]Required- 1 to 50 items
idstringRequired- 1 to 64 characters
typestringRequired- One of
"email""text""textarea""number""phone""url""date""select""radio""checkboxes""checkbox""consent""audiences""hidden""heading""paragraph""divider" keystringRequired- Up to 40 charactersPattern
^[a-z][a-z0-9_]{0,39}$ labelstringRequired- Up to 300 characters
placeholderstringRequired- Can be nullUp to 200 characters
helpstringRequired- Can be nullUp to 1000 characters
requiredbooleanRequireddefaultValuestringRequired- Can be nullUp to 1000 characters
optionsobject[]Required- Up to 50 items
idstringRequired- 1 to 64 characters
labelstringRequired- 1 to 300 characters
valuestringRequired- 1 to 1000 characters
mapsTostringRequiredThe contact detail this field fills when the sign-up is accepted, or null for none.
emailgoes on the email field.firstName,lastName,name,companyandjobTitlego on atextfield,phoneon aphonefield,websiteon aurlfield andbirthdayon adatefield. One field per detail, andnamenever together withfirstNameorlastName. The name is saved on the contact. The phone number, company, job title, website and birthday are saved on the contact card, and only where the card has nothing yet: a company, job title or birthday already there is kept, and a phone number or website the card already lists is not added again.Can be nullOne of"email""firstName""lastName""name""phone""company""jobTitle""website""birthday"saveAsstringA custom field of the contact this field fills when the sign-up is accepted, such as
plan, or null for none. A key starts with a letter and holds up to 64 letters, digits and underscores. The answer replaces the field of that name on the contact, an empty answer leaves it alone, and a choice of several options is saved as their labels joined by commas. Not on the email field or an audience choice, one field per custom field, and never together withmapsTo. Left out when a form is updated, a field keeps the custom field it had.Can be nullPattern^[A-Za-z][A-Za-z0-9_]{0,63}$widthstringRequired- One of
"full""half" minLengthintegerRequired- Can be nullAt least 0At most 5000
maxLengthintegerRequired- Can be nullAt least 1At most 5000
minnumberRequired- Can be nullAt least -1000000000000At most 1000000000000
maxnumberRequired- Can be nullAt least -1000000000000At most 1000000000000
copyobjectRequiredtitlestringRequired- Up to 200 characters
descriptionstringRequired- Can be nullUp to 2000 characters
submitLabelstringRequired- 1 to 60 characters
successTitlestringRequired- Up to 200 characters
successMessagestringRequired- Up to 2000 characters
pendingTitlestringRequired- Up to 200 characters
pendingMessagestringRequired- Up to 2000 characters
closedTitlestringRequired- Up to 200 characters
closedMessagestringRequired- Up to 2000 characters
footerstringRequired- Can be nullUp to 2000 characters
styleobjectRequiredaccentstringRequired- Pattern
^#[0-9a-fA-F]{6}$ backgroundstringRequired- Pattern
^#[0-9a-fA-F]{6}$ surfacestringRequired- Pattern
^#[0-9a-fA-F]{6}$ textstringRequired- Pattern
^#[0-9a-fA-F]{6}$ fontstringRequired- One of
"system""sans""serif""mono" radiusstringRequired- One of
"none""sm""md""lg""full" widthstringRequired- One of
"narrow""normal""wide" layoutstringRequired- One of
"card""plain" alignstringRequired- One of
"left""center" logoUrlstringRequired- Can be nullUp to 2000 charactersFormat
uri
settingsobjectAny subset of the settings. An omitted field keeps its value.
audienceIdsstring[]- Up to 20 items
doubleOptInbooleansenderAddressstring- Can be nullUp to 2000 characters
confirmSubjectstring- 1 to 200 characters
confirmMessagestring- Up to 2000 characters
confirmButtonstring- 1 to 60 characters
successActionstring- One of
"message""redirect" redirectUrlstring- Can be nullUp to 2000 charactersFormat
uri notifyAddressesstring[]- Up to 10 items
allowedSitesstring[]The sites that may show this form or post to it, at most 20: a domain (example.com, which covers www.example.com too), every subdomain of one (*.example.com), or either with a path (example.com/pricing, example.com/blog/*). A scheme or a port narrows it further (https://example.com, localhost:3000). An empty list means any site. The form's own page always works.
Up to 20 items
publishbooleanPublish in the same call, so the form takes sign-ups at once. Nothing is created when the form could not be published.
Returns
Created.
Errors
- 404
audience_not_foundonsettings.audienceIds.- 422
invalid_parameterfor an unknownstarteror a value of the wrong shape,unknown_parameterfor a key the body does not take,invalid_formwhen the document or settings break a rule together,form_sender_refusedwhen confirmations cannot go out fromsettings.senderAddress,capability_unsupportedfor an address outside a limited key, orworkspace_limit_reachedwhen the workspace holds the most forms it may.
The errors every operation can return400401403429500Error catalog
Also available in
- TypeScript
nextmail.forms.create()- Python
forms.create()- Ruby
forms.create- PHP
forms->create- Go
Forms.Create- Java
forms().create- C#
Forms.CreateAsync- CLI
nextmail forms create- MCP
createForm
GET/forms/starters
List the form starters
The starting points the console offers when somebody makes a form. Not paginated and not workspace data. The slug is what POST /forms takes as starter.
Requires the forms:read scope.
Returns
Every starter, documents left out.
Errors
The errors every operation can return400401403404422429500Error catalog
Also available in
GET/forms/starters/{slug}
Retrieve a form starter
Adds the starter document, so a client can change it before creating a form from it.
Requires the forms:read scope.
Path parameters
slugstringRequiredA slug from
GET /forms/starters.One of"blank""newsletter""waitlist""event""early-access""contact"
Returns
The starter with its document.
Errors
- 404
form_starter_not_foundwhen no starter has that slug.
The errors every operation can return400401403422429500Error catalog
Also available in
GET/forms/{id}
Retrieve a form
The whole form: the draft document, the publishedDocument visitors see, settings, the named audiences and fresh stats. A form in another workspace is a 404, never a 403.
Requires the forms:read scope.
Path parameters
idstringRequiredThe form id,
frm_plus 24 hex.
Returns
The form.
Errors
- 404
form_not_foundwhen the id names no form you can reach.
The errors every operation can return400401403422429500Error catalog
Also available in
- TypeScript
nextmail.forms.get()- Python
forms.get()- Ruby
forms.get- PHP
forms->get- Go
Forms.Get- Java
forms().get- C#
Forms.GetAsync- CLI
nextmail forms get- MCP
getForm
PATCH/forms/{id}
Update a form
A partial update. document replaces the draft whole and a live form keeps showing its published copy until POST /forms/{id}/publish. settings is merged field by field and takes effect at once. A call that turns on settings.doubleOptIn, names a settings.senderAddress or changes the confirmation email also needs emails:send, because the form then sends mail for you.
Read the form, change it and send expectedUpdatedAt with the updatedAt you read: if someone saved the form in between, your change is refused rather than written over theirs.
Requires the forms:write scope.
Path parameters
idstringRequiredThe form id,
frm_plus 24 hex.
Request body
namestringNew name, trimmed, 1 to 120 characters.
1 to 120 charactersdescriptionstringNew note, at most 500 characters. Null clears it.
Can be nullUp to 500 charactersdocumentobjectEverything a visitor sees:
fieldsin order, thecopyaround them and thestyle. Every form has exactly oneemailfield, and every input field has a uniquekeythat answers are posted under.fieldsobject[]Required- 1 to 50 items
idstringRequired- 1 to 64 characters
typestringRequired- One of
"email""text""textarea""number""phone""url""date""select""radio""checkboxes""checkbox""consent""audiences""hidden""heading""paragraph""divider" keystringRequired- Up to 40 charactersPattern
^[a-z][a-z0-9_]{0,39}$ labelstringRequired- Up to 300 characters
placeholderstringRequired- Can be nullUp to 200 characters
helpstringRequired- Can be nullUp to 1000 characters
requiredbooleanRequireddefaultValuestringRequired- Can be nullUp to 1000 characters
optionsobject[]Required- Up to 50 items
idstringRequired- 1 to 64 characters
labelstringRequired- 1 to 300 characters
valuestringRequired- 1 to 1000 characters
mapsTostringRequiredThe contact detail this field fills when the sign-up is accepted, or null for none.
emailgoes on the email field.firstName,lastName,name,companyandjobTitlego on atextfield,phoneon aphonefield,websiteon aurlfield andbirthdayon adatefield. One field per detail, andnamenever together withfirstNameorlastName. The name is saved on the contact. The phone number, company, job title, website and birthday are saved on the contact card, and only where the card has nothing yet: a company, job title or birthday already there is kept, and a phone number or website the card already lists is not added again.Can be nullOne of"email""firstName""lastName""name""phone""company""jobTitle""website""birthday"saveAsstringA custom field of the contact this field fills when the sign-up is accepted, such as
plan, or null for none. A key starts with a letter and holds up to 64 letters, digits and underscores. The answer replaces the field of that name on the contact, an empty answer leaves it alone, and a choice of several options is saved as their labels joined by commas. Not on the email field or an audience choice, one field per custom field, and never together withmapsTo. Left out when a form is updated, a field keeps the custom field it had.Can be nullPattern^[A-Za-z][A-Za-z0-9_]{0,63}$widthstringRequired- One of
"full""half" minLengthintegerRequired- Can be nullAt least 0At most 5000
maxLengthintegerRequired- Can be nullAt least 1At most 5000
minnumberRequired- Can be nullAt least -1000000000000At most 1000000000000
maxnumberRequired- Can be nullAt least -1000000000000At most 1000000000000
copyobjectRequiredtitlestringRequired- Up to 200 characters
descriptionstringRequired- Can be nullUp to 2000 characters
submitLabelstringRequired- 1 to 60 characters
successTitlestringRequired- Up to 200 characters
successMessagestringRequired- Up to 2000 characters
pendingTitlestringRequired- Up to 200 characters
pendingMessagestringRequired- Up to 2000 characters
closedTitlestringRequired- Up to 200 characters
closedMessagestringRequired- Up to 2000 characters
footerstringRequired- Can be nullUp to 2000 characters
styleobjectRequiredaccentstringRequired- Pattern
^#[0-9a-fA-F]{6}$ backgroundstringRequired- Pattern
^#[0-9a-fA-F]{6}$ surfacestringRequired- Pattern
^#[0-9a-fA-F]{6}$ textstringRequired- Pattern
^#[0-9a-fA-F]{6}$ fontstringRequired- One of
"system""sans""serif""mono" radiusstringRequired- One of
"none""sm""md""lg""full" widthstringRequired- One of
"narrow""normal""wide" layoutstringRequired- One of
"card""plain" alignstringRequired- One of
"left""center" logoUrlstringRequired- Can be nullUp to 2000 charactersFormat
uri
settingsobjectAny subset of the settings. An omitted field keeps its value.
audienceIdsstring[]- Up to 20 items
doubleOptInbooleansenderAddressstring- Can be nullUp to 2000 characters
confirmSubjectstring- 1 to 200 characters
confirmMessagestring- Up to 2000 characters
confirmButtonstring- 1 to 60 characters
successActionstring- One of
"message""redirect" redirectUrlstring- Can be nullUp to 2000 charactersFormat
uri notifyAddressesstring[]- Up to 10 items
allowedSitesstring[]The sites that may show this form or post to it, at most 20: a domain (example.com, which covers www.example.com too), every subdomain of one (*.example.com), or either with a path (example.com/pricing, example.com/blog/*). A scheme or a port narrows it further (https://example.com, localhost:3000). An empty list means any site. The form's own page always works.
Up to 20 items
expectedUpdatedAtstringThe
updatedAtyou read. When the form was saved since, nothing is written and the answer is 409version_conflict.Formatdate-time
Returns
Saved.
Errors
- 404
form_not_found, oraudience_not_foundonsettings.audienceIds.- 409
version_conflict: the form was saved afterexpectedUpdatedAt. Nothing was written.- 422
invalid_parameterfor a value of the wrong shape,unknown_parameterfor a key the body does not take,invalid_formwhen the document or settings break a rule together,form_sender_refusedorcapability_unsupported, each withparamnaming the field.
The errors every operation can return400401403429500Error catalog
Also available in
- TypeScript
nextmail.forms.update()- Python
forms.update()- Ruby
forms.update- PHP
forms->update- Go
Forms.Update- Java
forms().update- C#
Forms.UpdateAsync- CLI
nextmail forms update- MCP
updateForm
DELETE/forms/{id}
Delete a form
Deletes the form and every submission it holds. Its hosted page and embed stop working at once. The people it added stay in your contacts and audiences.
There is no undo.
Requires the forms:write scope.
Path parameters
idstringRequiredThe form id,
frm_plus 24 hex.
Returns
Deleted.
Errors
- 403
The key lacks the scope, or may not send as that address.
step_up_required: the call was made with an OAuth access token that has not been verified in the last 60 minutes. Ask for a code withPOST /security/step-up, send it toPOST /security/step-up/verify, then repeat the call. The person can also choose Allow changes for 60 minutes on the app in Account settings, Connected apps, on the Nextmail website. An API key is never asked for a code.- 404
form_not_foundwhen the id names no form you can reach.
The errors every operation can return400401422429500Error catalog
Also available in
- TypeScript
nextmail.forms.delete()- Python
forms.delete()- Ruby
forms.delete- PHP
forms->delete- Go
Forms.Delete- Java
forms().delete- C#
Forms.DeleteAsync- CLI
nextmail forms delete- MCP
deleteForm
POST/forms/{id}/publish
Publish a form
Copies the draft document to publishedDocument and sets the form live, so the hosted page, the embed and the subscribe endpoint show and take the new version. Publishing a paused form opens it again. No body.
A double opt-in form also needs a senderAddress that can send confirmations, and the caller needs emails:send.
Requires the forms:write scope.
Path parameters
idstringRequiredThe form id,
frm_plus 24 hex.
Returns
Published.
Errors
- 404
form_not_foundwhen the id names no form you can reach.- 422
invalid_formorform_sender_refused, withparamnaming the field, orcapability_unsupportedwhen the key or app is limited to some addresses and the form'ssettings.senderAddressorsettings.notifyAddressesfalls outside them.
The errors every operation can return400401403429500Error catalog
Also available in
- TypeScript
nextmail.forms.publish()- Python
forms.publish()- Ruby
forms.publish- PHP
forms->publish- Go
Forms.Publish- Java
forms().publish- C#
Forms.PublishAsync- CLI
nextmail forms publish- MCP
publishForm
POST/forms/{id}/pause
Pause a form
Stops a published form taking sign-ups. Its page stays up and shows the closed message from its copy, and a JSON post to its subscribe endpoint answers 409 form_closed while a plain HTML form goes to the hosted page. Pausing a paused form changes nothing. No body.
Requires the forms:write scope.
Path parameters
idstringRequiredThe form id,
frm_plus 24 hex.
Returns
Paused.
Errors
- 404
form_not_foundwhen the id names no form you can reach.- 409
form_not_published: a form that was never published cannot be paused.
The errors every operation can return400401403422429500Error catalog
Also available in
- TypeScript
nextmail.forms.pause()- Python
forms.pause()- Ruby
forms.pause- PHP
forms->pause- Go
Forms.Pause- Java
forms().pause- C#
Forms.PauseAsync- CLI
nextmail forms pause- MCP
setFormStatus
POST/forms/{id}/resume
Resume a form
Opens a paused form again, with the version that was published last. Resuming a live form changes nothing. No body.
Resuming a double opt-in form also needs emails:send.
Requires the forms:write scope.
Path parameters
idstringRequiredThe form id,
frm_plus 24 hex.
Returns
Live.
Errors
- 404
form_not_foundwhen the id names no form you can reach.- 409
form_not_published: publish the form first.- 422
form_sender_refusedwhen a double opt-in form can no longer send confirmations,invalid_formwhen the published form breaks a rule, orcapability_unsupportedwhen the key or app is limited to some addresses and the form'ssettings.senderAddressorsettings.notifyAddressesfalls outside them.
The errors every operation can return400401403429500Error catalog
Also available in
- TypeScript
nextmail.forms.resume()- Python
forms.resume()- Ruby
forms.resume- PHP
forms->resume- Go
Forms.Resume- Java
forms().resume- C#
Forms.ResumeAsync- CLI
nextmail forms resume- MCP
setFormStatus
POST/forms/{id}/duplicate
Duplicate a form
Makes a new draft with the same document and settings and "copy" after the name. Submissions and statistics are not copied. No body.
Requires the forms:write scope.
Path parameters
idstringRequiredThe form id,
frm_plus 24 hex.
Returns
The copy.
Errors
- 404
form_not_foundwhen the id names no form you can reach.- 422
workspace_limit_reachedwhen the workspace holds the most forms it may, orcapability_unsupportedwhen the key or app is limited to some addresses and the form'ssettings.senderAddressorsettings.notifyAddressesfalls outside them.
The errors every operation can return400401403429500Error catalog
Also available in
GET/forms/{id}/analytics
Form analytics
Views, submissions and people added over a window, in buckets, with totals and the conversion rate. A view is one load of the hosted page or the embed while the form is live, and views are not deduplicated by visitor.
Requires the forms:read scope.
Path parameters
idstringRequiredThe form id,
frm_plus 24 hex.
Query parameters
daysintegerHow far back to look. The oldest bucket is a whole one and the newest is partial.
At least 1At most 1095Default30minutesintegerThe window in minutes, which wins over
dayswhen both are sent.At least 1At most 1576800grainstringHow wide one bucket is. Views are kept per hour.
One of"minute""hour""day"Default"day"offsetMinutesintegerMinutes east of UTC to cut the buckets in, so a day breaks where the reader's day does.
At least -840At most 840Default0
Returns
The window, the totals and the series.
Errors
- 404
form_not_foundwhen the id names no form you can reach.
The errors every operation can return400401403422429500Error catalog
Also available in
GET/forms/{id}/submissions
List submissions
Newest first. Each row keeps the answers as they were sent, labels included, so it still reads right after the form changes.
Requires the forms:read scope.
Path parameters
idstringRequiredThe form id,
frm_plus 24 hex.
Query parameters
limitintegerRows per page, 1 to 100.
At least 1At most 100Default25cursorstringA submission id of this form. Keyset, not offset: pass the previous page's
nextCursor. One that names nothing in this list is a 400invalid_cursor.qstringOnly submissions whose email address contains this text, ignoring case.
Up to 200 charactersstatusstringOnly
pendingor onlyaddedsubmissions.One of"pending""added"
Returns
A page of submissions.
Errors
- 400
invalid_cursorwhen the cursor names no submission of this form.- 404
form_not_foundwhen the id names no form you can reach.
The errors every operation can return401403422429500Error catalog
Also available in
- TypeScript
nextmail.forms.listSubmissions()nextmail.forms.listAllSubmissions()nextmail.forms.iterateSubmissions()- Python
forms.list_submissions()forms.list_all_submissions()forms.iterate_submissions()- Ruby
forms.list_submissionsforms.list_all_submissionsforms.iterate_submissions- PHP
forms->listSubmissionsforms->listAllSubmissionsforms->iterateSubmissions- Go
Forms.ListSubmissionsForms.ListAllSubmissionsForms.IterateSubmissions- Java
forms().listSubmissionsforms().listAllSubmissionsforms().iterateSubmissions- C#
Forms.ListSubmissionsAsyncForms.ListAllSubmissionsAsyncForms.IterateSubmissionsAsync- CLI
nextmail forms list-submissions- MCP
listFormSubmissions
POST/forms/{id}/submissions/batch-remove
Delete submissions
Deletes up to 200 submissions of this form in one call and answers with how many went. A person a submission added stays in your contacts and audiences. A pending one can no longer be confirmed.
Requires the forms:write scope.
Path parameters
idstringRequiredThe form id,
frm_plus 24 hex.
Request body
idsstring[]RequiredSubmission ids of this form. An id that names nothing is skipped.
1 to 200 items
Returns
Deleted.
Errors
- 404
form_not_foundwhen the id names no form you can reach.
The errors every operation can return400401403422429500Error catalog
Also available in
GET/forms/{id}/submissions/{submissionId}
Retrieve a submission
One submission with every answer.
Requires the forms:read scope.
Path parameters
idstringRequiredThe form id,
frm_plus 24 hex.submissionIdstringRequiredThe submission id,
fsb_plus 24 hex.
Returns
The submission.
Errors
- 404
form_not_found, orform_submission_not_foundwhen the form has no such submission.
The errors every operation can return400401403422429500Error catalog
Also available in
DELETE/forms/{id}/submissions/{submissionId}
Delete a submission
Deletes the submission. The person it added stays in your contacts and audiences, and a pending one can no longer be confirmed.
Requires the forms:write scope.
Path parameters
idstringRequiredThe form id,
frm_plus 24 hex.submissionIdstringRequiredThe submission id,
fsb_plus 24 hex.
Returns
Deleted.
Errors
The errors every operation can return400401403422429500Error catalog
Also available in
POST/forms/{id}/submissions/{submissionId}/approve
Approve a submission
Adds the person of a pending submission to its audiences without waiting for them to confirm, for when you know them. It does not resubscribe someone who unsubscribed from an audience, as their own confirmation would. An added submission is returned as it is. No body.
Requires the forms:write and contacts:write scopes.
Path parameters
idstringRequiredThe form id,
frm_plus 24 hex.submissionIdstringRequiredThe submission id,
fsb_plus 24 hex.
Returns
The submission, now added.
Errors
The errors every operation can return400401403422429500Error catalog
Also available in
POST/forms/{id}/submissions/{submissionId}/resend
Resend a confirmation
Emails a pending submission a fresh confirmation link from the form's senderAddress. To protect the person, one address gets at most one confirmation per form every ten minutes and five a day across the workspace. A call that runs into those limits, or one for an added submission, sends nothing and answers confirmationSent: false. No body.
Requires the forms:write and emails:send scopes.
Path parameters
idstringRequiredThe form id,
frm_plus 24 hex.submissionIdstringRequiredThe submission id,
fsb_plus 24 hex.
Returns
The submission.
objectstring- One of
"form_submission" idstringThe durable handle,
fsb_plus 24 hex.formIdstringemailstringThe address the person signed up with, lower cased.
statusstringaddedonce the person is a contact in the audiences.pendingwhile a double opt-in form waits for them to confirm.One of"pending""added"expiredbooleanTrue for a
pendingsubmission whose confirmation link has run out. Approve it, or send a fresh link.answersFormAnswer[]A snapshot of every answer, kept as it was even after the form changes.
audienceIdsstring[]sourceUrlstringThe page the form was filled in on, its origin and path only and at most 500 characters, when it was known.
Can be nullconfirmedAtstringWhen the person joined the audiences. Null while pending.
Can be nullFormatdate-timecreatedAtstring- Format
date-time confirmationSentbooleanWhether an email went out on this call.
Errors
- 422
form_sender_refusedwhen confirmations cannot go out from the form's address.
The errors every operation can return400401403429500Error catalog
Also available in
POST/subscribe/{formId}
Sign up through a form
Takes no credential: this is where a published form's visitors post. A browser <form method="post"> sends its fields form encoded and is redirected with a 303 to the form's thank-you page or to its redirect. A script that sends Accept: application/json or a JSON body gets JSON answers and the error codes below instead. Cross-origin requests are allowed.
A form that lists the sites that may use it (settings.allowedSites) takes sign-ups only from those. The site is the Origin header a browser sends, or the Referer when there is none, so another website cannot post to it from a visitor's browser. A path in a rule is checked whenever the page address is known, from the Referer or from oe_source. A server has neither header, so it names the page in oe_source; a request that names no site at all is refused. This keeps other websites out, and it is not a secret: anything that is not a browser can send any address.
On a double opt-in form the person is emailed a confirmation link and joins the audiences once they open it, so outcome is pending. Signing up again before confirming updates that pending submission rather than storing another. Otherwise they join at once and outcome is added.
A person who unsubscribed stays unsubscribed unless they confirm from their inbox: on a form with a sending address they are emailed a confirmation link even when the form does not ask everyone for one, so outcome is pending, and opening it is fresh consent that subscribes them again. On a form without one they join its audiences still unsubscribed. Sign-ups are limited to 40 every 10 minutes from one network, and a submission that looks automated gets a normal answer and is dropped.
A sign-up that carries a bot check token is verified: the cf-turnstile-response field a Cloudflare Turnstile widget adds to the form, oe_bot_check, or the X-Bot-Check header. A token that does not pass is refused with 403 bot_check_failed and nothing is stored. A sign-up without a token is judged by the checks above.
Path parameters
formIdstringRequiredThe id of a published form.
Request body
Content typeapplication/json, application/x-www-form-urlencoded, multipart/form-data
emailstringThe field keyed
email, which every form has.valuesobjectThe answers again, for a client that would rather nest them.
oe_sourcestringThe page the form was filled in on. Defaults to the
Refererheader.
Returns
Signed up, for a JSON caller.
Signed up or refused, for a browser form: follow the Location header.
Errors
- 400
malformed_jsonwhen a JSON body does not parse or is not an object.- 403
form_site_not_allowedwhen the form lists the sites that may use it and the sign-up came from another one, or named none.bot_check_failedwhen the sign-up carried a bot check token that did not pass.- 404
form_not_foundwhen no published form has that id.- 409
form_closedwhen the form is paused.- 422
invalid_form_submissionwhen an answer is missing or not valid. The error carriesfields, one entry per problem with the fieldkeyand the reason.- 429
form_rate_limitedwhen too many sign-ups came from the same network.
The errors every operation can return500Error catalog
Also available in
POST/forms/design
Design a form from a brief
A designer builds a new sign-up form from a written brief, as Create with AI does on the Forms page of the app: it picks the fields, writes the copy and sets the look, then saves the form as a draft. Publish it with POST /forms/{id}/publish. It spends one AI action and can take up to half a minute.
Requires the forms:write scope.
Request body
briefstringRequiredEverything the form must ask and say, up to 4,000 characters.
1 to 4000 charactersnamestringA short name for the form, up to 120 characters. Left out, the designer names it.
1 to 120 characters
Returns
The new form, a draft.
objectstring- One of
"form" idstringThe durable handle,
frm_plus 24 hex.namestringWhat the workspace calls the form. Visitors never see it.
descriptionstring- Can be null
statusstringdraftuntil the first publish, thenlivewhile it takes sign-ups andpausedwhile it does not. A form never goes back todraft.One of"draft""live""paused"urlstringThe hosted page that shows the published form. Share it as a link, or add
?embed=1for the frame the embed script loads.subscribeUrlstringWhere a plain HTML
<form method="post">sends its fields, and where a script posts JSON for a JSON answer.audienceIdsstring[]The audiences every sign-up joins, besides the default audience that holds every contact. An audiences field adds the ones the person ticks.
doubleOptInbooleanWhether a sign-up waits for the person to confirm their address by email.
hasUnpublishedChangesbooleanTrue when the draft
documentdiffers from what the live form shows. Always false before the first publish.statsFormStatspublishedAtstring- Can be nullFormat
date-time createdAtstring- Format
date-time updatedAtstringSend it back as
expectedUpdatedAtonPATCH /forms/{id}to refuse a save that would overwrite someone else's.Formatdate-timedocumentobjectEverything a visitor sees:
fieldsin order, thecopyaround them and thestyle. Every form has exactly oneemailfield, and every input field has a uniquekeythat answers are posted under.fieldsobject[]Required- 1 to 50 items
idstringRequired- 1 to 64 characters
typestringRequired- One of
"email""text""textarea""number""phone""url""date""select""radio""checkboxes""checkbox""consent""audiences""hidden""heading""paragraph""divider" keystringRequired- Up to 40 charactersPattern
^[a-z][a-z0-9_]{0,39}$ labelstringRequired- Up to 300 characters
placeholderstringRequired- Can be nullUp to 200 characters
helpstringRequired- Can be nullUp to 1000 characters
requiredbooleanRequireddefaultValuestringRequired- Can be nullUp to 1000 characters
optionsobject[]Required- Up to 50 items
idstringRequired- 1 to 64 characters
labelstringRequired- 1 to 300 characters
valuestringRequired- 1 to 1000 characters
mapsTostringRequiredThe contact detail this field fills when the sign-up is accepted, or null for none.
emailgoes on the email field.firstName,lastName,name,companyandjobTitlego on atextfield,phoneon aphonefield,websiteon aurlfield andbirthdayon adatefield. One field per detail, andnamenever together withfirstNameorlastName. The name is saved on the contact. The phone number, company, job title, website and birthday are saved on the contact card, and only where the card has nothing yet: a company, job title or birthday already there is kept, and a phone number or website the card already lists is not added again.Can be nullOne of"email""firstName""lastName""name""phone""company""jobTitle""website""birthday"saveAsstringA custom field of the contact this field fills when the sign-up is accepted, such as
plan, or null for none. A key starts with a letter and holds up to 64 letters, digits and underscores. The answer replaces the field of that name on the contact, an empty answer leaves it alone, and a choice of several options is saved as their labels joined by commas. Not on the email field or an audience choice, one field per custom field, and never together withmapsTo. Left out when a form is updated, a field keeps the custom field it had.Can be nullPattern^[A-Za-z][A-Za-z0-9_]{0,63}$widthstringRequired- One of
"full""half" minLengthintegerRequired- Can be nullAt least 0At most 5000
maxLengthintegerRequired- Can be nullAt least 1At most 5000
minnumberRequired- Can be nullAt least -1000000000000At most 1000000000000
maxnumberRequired- Can be nullAt least -1000000000000At most 1000000000000
copyobjectRequiredtitlestringRequired- Up to 200 characters
descriptionstringRequired- Can be nullUp to 2000 characters
submitLabelstringRequired- 1 to 60 characters
successTitlestringRequired- Up to 200 characters
successMessagestringRequired- Up to 2000 characters
pendingTitlestringRequired- Up to 200 characters
pendingMessagestringRequired- Up to 2000 characters
closedTitlestringRequired- Up to 200 characters
closedMessagestringRequired- Up to 2000 characters
footerstringRequired- Can be nullUp to 2000 characters
styleobjectRequiredaccentstringRequired- Pattern
^#[0-9a-fA-F]{6}$ backgroundstringRequired- Pattern
^#[0-9a-fA-F]{6}$ surfacestringRequired- Pattern
^#[0-9a-fA-F]{6}$ textstringRequired- Pattern
^#[0-9a-fA-F]{6}$ fontstringRequired- One of
"system""sans""serif""mono" radiusstringRequired- One of
"none""sm""md""lg""full" widthstringRequired- One of
"narrow""normal""wide" layoutstringRequired- One of
"card""plain" alignstringRequired- One of
"left""center" logoUrlstringRequired- Can be nullUp to 2000 charactersFormat
uri
publishedDocumentobjectEverything a visitor sees:
fieldsin order, thecopyaround them and thestyle. Every form has exactly oneemailfield, and every input field has a uniquekeythat answers are posted under.Can be nullfieldsobject[]Required- 1 to 50 items
idstringRequired- 1 to 64 characters
typestringRequired- One of
"email""text""textarea""number""phone""url""date""select""radio""checkboxes""checkbox""consent""audiences""hidden""heading""paragraph""divider" keystringRequired- Up to 40 charactersPattern
^[a-z][a-z0-9_]{0,39}$ labelstringRequired- Up to 300 characters
placeholderstringRequired- Can be nullUp to 200 characters
helpstringRequired- Can be nullUp to 1000 characters
requiredbooleanRequireddefaultValuestringRequired- Can be nullUp to 1000 characters
optionsobject[]Required- Up to 50 items
idstringRequired- 1 to 64 characters
labelstringRequired- 1 to 300 characters
valuestringRequired- 1 to 1000 characters
mapsTostringRequiredThe contact detail this field fills when the sign-up is accepted, or null for none.
emailgoes on the email field.firstName,lastName,name,companyandjobTitlego on atextfield,phoneon aphonefield,websiteon aurlfield andbirthdayon adatefield. One field per detail, andnamenever together withfirstNameorlastName. The name is saved on the contact. The phone number, company, job title, website and birthday are saved on the contact card, and only where the card has nothing yet: a company, job title or birthday already there is kept, and a phone number or website the card already lists is not added again.Can be nullOne of"email""firstName""lastName""name""phone""company""jobTitle""website""birthday"saveAsstringA custom field of the contact this field fills when the sign-up is accepted, such as
plan, or null for none. A key starts with a letter and holds up to 64 letters, digits and underscores. The answer replaces the field of that name on the contact, an empty answer leaves it alone, and a choice of several options is saved as their labels joined by commas. Not on the email field or an audience choice, one field per custom field, and never together withmapsTo. Left out when a form is updated, a field keeps the custom field it had.Can be nullPattern^[A-Za-z][A-Za-z0-9_]{0,63}$widthstringRequired- One of
"full""half" minLengthintegerRequired- Can be nullAt least 0At most 5000
maxLengthintegerRequired- Can be nullAt least 1At most 5000
minnumberRequired- Can be nullAt least -1000000000000At most 1000000000000
maxnumberRequired- Can be nullAt least -1000000000000At most 1000000000000
copyobjectRequiredtitlestringRequired- Up to 200 characters
descriptionstringRequired- Can be nullUp to 2000 characters
submitLabelstringRequired- 1 to 60 characters
successTitlestringRequired- Up to 200 characters
successMessagestringRequired- Up to 2000 characters
pendingTitlestringRequired- Up to 200 characters
pendingMessagestringRequired- Up to 2000 characters
closedTitlestringRequired- Up to 200 characters
closedMessagestringRequired- Up to 2000 characters
footerstringRequired- Can be nullUp to 2000 characters
styleobjectRequiredaccentstringRequired- Pattern
^#[0-9a-fA-F]{6}$ backgroundstringRequired- Pattern
^#[0-9a-fA-F]{6}$ surfacestringRequired- Pattern
^#[0-9a-fA-F]{6}$ textstringRequired- Pattern
^#[0-9a-fA-F]{6}$ fontstringRequired- One of
"system""sans""serif""mono" radiusstringRequired- One of
"none""sm""md""lg""full" widthstringRequired- One of
"narrow""normal""wide" layoutstringRequired- One of
"card""plain" alignstringRequired- One of
"left""center" logoUrlstringRequired- Can be nullUp to 2000 charactersFormat
uri
settingsobjectWhere sign-ups go and what happens after one.
audienceIdsstring[]Required- Up to 20 items
doubleOptInbooleanRequiredsenderAddressstringRequired- Can be nullUp to 2000 characters
confirmSubjectstringRequired- 1 to 200 characters
confirmMessagestringRequired- Up to 2000 characters
confirmButtonstringRequired- 1 to 60 characters
successActionstringRequired- One of
"message""redirect" redirectUrlstringRequired- Can be nullUp to 2000 charactersFormat
uri notifyAddressesstring[]Required- Up to 10 items
allowedSitesstring[]The sites that may show this form or post to it, at most 20: a domain (example.com, which covers www.example.com too), every subdomain of one (*.example.com), or either with a path (example.com/pricing, example.com/blog/*). A scheme or a port narrows it further (https://example.com, localhost:3000). An empty list means any site. The form's own page always works.
Up to 20 items
audiencesFormAudience[]The audiences in
audienceIdswith their names.senderIssuestringWhy confirmation emails cannot go out right now, for a form with
doubleOptInon.missingmeans nosenderAddressis set,not_sendablethat the address cannot send,not_allowedthat the form's maker may not send as it. Null when they can go out, and always null withdoubleOptInoff.Can be nullOne of"missing""not_sendable""not_allowed"senderProblemstringThe same problem in a sentence, or null.
Can be nulldesignobjectnotesstring[]What the designer adjusted or left out while making the design valid.
Errors
- 409
ai_not_configured: this server has no model to design with.version_conflict: the form was saved sinceexpectedUpdatedAt, or while the designer worked, and nothing was written.- 422
invalid_formwhen the designer could not make a valid form, so nothing was created or changed.workspace_limit_reachedwhen the workspace already holds as many forms as it may.invalid_parameterfor a body that does not validate.- 429
ai_quota_exceeded: the workspace has used its AI actions for today.rate_limited: the key or app made more than 600 requests in 60 seconds. Wait for the seconds inRetry-After.
The errors every operation can return400401403404500Error catalog
Also available in
- TypeScript
nextmail.forms.design()- Python
forms.design()- Ruby
forms.design- PHP
forms->design- Go
Forms.Design- Java
forms().design- C#
Forms.DesignAsync- CLI
nextmail forms design- MCP
designForm
POST/forms/{id}/redesign
Change a form’s design from instructions
A designer applies written instructions to the draft of the form and leaves the rest alone, as Ask AI does in the form builder of the app: add, remove or reorder fields, rewrite or translate the copy, change colours or fonts. The change is saved to the draft, and a live form keeps showing its published version until POST /forms/{id}/publish. It spends one AI action and can take up to half a minute.
Requires the forms:write scope.
Path parameters
idstringRequiredForm id such as
frm_8d2f6a1c9b3e47d0a5f1c2e9.
Request body
instructionsstringRequiredWhat to change, with every detail, up to 4,000 characters.
1 to 4000 charactersexpectedUpdatedAtstringThe
updatedAtyou read, as it came. When the form was saved since, nothing is written and the answer is 409version_conflict.Formatdate-time
Returns
The form, with the change in its draft.
objectstring- One of
"form" idstringThe durable handle,
frm_plus 24 hex.namestringWhat the workspace calls the form. Visitors never see it.
descriptionstring- Can be null
statusstringdraftuntil the first publish, thenlivewhile it takes sign-ups andpausedwhile it does not. A form never goes back todraft.One of"draft""live""paused"urlstringThe hosted page that shows the published form. Share it as a link, or add
?embed=1for the frame the embed script loads.subscribeUrlstringWhere a plain HTML
<form method="post">sends its fields, and where a script posts JSON for a JSON answer.audienceIdsstring[]The audiences every sign-up joins, besides the default audience that holds every contact. An audiences field adds the ones the person ticks.
doubleOptInbooleanWhether a sign-up waits for the person to confirm their address by email.
hasUnpublishedChangesbooleanTrue when the draft
documentdiffers from what the live form shows. Always false before the first publish.statsFormStatspublishedAtstring- Can be nullFormat
date-time createdAtstring- Format
date-time updatedAtstringSend it back as
expectedUpdatedAtonPATCH /forms/{id}to refuse a save that would overwrite someone else's.Formatdate-timedocumentobjectEverything a visitor sees:
fieldsin order, thecopyaround them and thestyle. Every form has exactly oneemailfield, and every input field has a uniquekeythat answers are posted under.fieldsobject[]Required- 1 to 50 items
idstringRequired- 1 to 64 characters
typestringRequired- One of
"email""text""textarea""number""phone""url""date""select""radio""checkboxes""checkbox""consent""audiences""hidden""heading""paragraph""divider" keystringRequired- Up to 40 charactersPattern
^[a-z][a-z0-9_]{0,39}$ labelstringRequired- Up to 300 characters
placeholderstringRequired- Can be nullUp to 200 characters
helpstringRequired- Can be nullUp to 1000 characters
requiredbooleanRequireddefaultValuestringRequired- Can be nullUp to 1000 characters
optionsobject[]Required- Up to 50 items
idstringRequired- 1 to 64 characters
labelstringRequired- 1 to 300 characters
valuestringRequired- 1 to 1000 characters
mapsTostringRequiredThe contact detail this field fills when the sign-up is accepted, or null for none.
emailgoes on the email field.firstName,lastName,name,companyandjobTitlego on atextfield,phoneon aphonefield,websiteon aurlfield andbirthdayon adatefield. One field per detail, andnamenever together withfirstNameorlastName. The name is saved on the contact. The phone number, company, job title, website and birthday are saved on the contact card, and only where the card has nothing yet: a company, job title or birthday already there is kept, and a phone number or website the card already lists is not added again.Can be nullOne of"email""firstName""lastName""name""phone""company""jobTitle""website""birthday"saveAsstringA custom field of the contact this field fills when the sign-up is accepted, such as
plan, or null for none. A key starts with a letter and holds up to 64 letters, digits and underscores. The answer replaces the field of that name on the contact, an empty answer leaves it alone, and a choice of several options is saved as their labels joined by commas. Not on the email field or an audience choice, one field per custom field, and never together withmapsTo. Left out when a form is updated, a field keeps the custom field it had.Can be nullPattern^[A-Za-z][A-Za-z0-9_]{0,63}$widthstringRequired- One of
"full""half" minLengthintegerRequired- Can be nullAt least 0At most 5000
maxLengthintegerRequired- Can be nullAt least 1At most 5000
minnumberRequired- Can be nullAt least -1000000000000At most 1000000000000
maxnumberRequired- Can be nullAt least -1000000000000At most 1000000000000
copyobjectRequiredtitlestringRequired- Up to 200 characters
descriptionstringRequired- Can be nullUp to 2000 characters
submitLabelstringRequired- 1 to 60 characters
successTitlestringRequired- Up to 200 characters
successMessagestringRequired- Up to 2000 characters
pendingTitlestringRequired- Up to 200 characters
pendingMessagestringRequired- Up to 2000 characters
closedTitlestringRequired- Up to 200 characters
closedMessagestringRequired- Up to 2000 characters
footerstringRequired- Can be nullUp to 2000 characters
styleobjectRequiredaccentstringRequired- Pattern
^#[0-9a-fA-F]{6}$ backgroundstringRequired- Pattern
^#[0-9a-fA-F]{6}$ surfacestringRequired- Pattern
^#[0-9a-fA-F]{6}$ textstringRequired- Pattern
^#[0-9a-fA-F]{6}$ fontstringRequired- One of
"system""sans""serif""mono" radiusstringRequired- One of
"none""sm""md""lg""full" widthstringRequired- One of
"narrow""normal""wide" layoutstringRequired- One of
"card""plain" alignstringRequired- One of
"left""center" logoUrlstringRequired- Can be nullUp to 2000 charactersFormat
uri
publishedDocumentobjectEverything a visitor sees:
fieldsin order, thecopyaround them and thestyle. Every form has exactly oneemailfield, and every input field has a uniquekeythat answers are posted under.Can be nullfieldsobject[]Required- 1 to 50 items
idstringRequired- 1 to 64 characters
typestringRequired- One of
"email""text""textarea""number""phone""url""date""select""radio""checkboxes""checkbox""consent""audiences""hidden""heading""paragraph""divider" keystringRequired- Up to 40 charactersPattern
^[a-z][a-z0-9_]{0,39}$ labelstringRequired- Up to 300 characters
placeholderstringRequired- Can be nullUp to 200 characters
helpstringRequired- Can be nullUp to 1000 characters
requiredbooleanRequireddefaultValuestringRequired- Can be nullUp to 1000 characters
optionsobject[]Required- Up to 50 items
idstringRequired- 1 to 64 characters
labelstringRequired- 1 to 300 characters
valuestringRequired- 1 to 1000 characters
mapsTostringRequiredThe contact detail this field fills when the sign-up is accepted, or null for none.
emailgoes on the email field.firstName,lastName,name,companyandjobTitlego on atextfield,phoneon aphonefield,websiteon aurlfield andbirthdayon adatefield. One field per detail, andnamenever together withfirstNameorlastName. The name is saved on the contact. The phone number, company, job title, website and birthday are saved on the contact card, and only where the card has nothing yet: a company, job title or birthday already there is kept, and a phone number or website the card already lists is not added again.Can be nullOne of"email""firstName""lastName""name""phone""company""jobTitle""website""birthday"saveAsstringA custom field of the contact this field fills when the sign-up is accepted, such as
plan, or null for none. A key starts with a letter and holds up to 64 letters, digits and underscores. The answer replaces the field of that name on the contact, an empty answer leaves it alone, and a choice of several options is saved as their labels joined by commas. Not on the email field or an audience choice, one field per custom field, and never together withmapsTo. Left out when a form is updated, a field keeps the custom field it had.Can be nullPattern^[A-Za-z][A-Za-z0-9_]{0,63}$widthstringRequired- One of
"full""half" minLengthintegerRequired- Can be nullAt least 0At most 5000
maxLengthintegerRequired- Can be nullAt least 1At most 5000
minnumberRequired- Can be nullAt least -1000000000000At most 1000000000000
maxnumberRequired- Can be nullAt least -1000000000000At most 1000000000000
copyobjectRequiredtitlestringRequired- Up to 200 characters
descriptionstringRequired- Can be nullUp to 2000 characters
submitLabelstringRequired- 1 to 60 characters
successTitlestringRequired- Up to 200 characters
successMessagestringRequired- Up to 2000 characters
pendingTitlestringRequired- Up to 200 characters
pendingMessagestringRequired- Up to 2000 characters
closedTitlestringRequired- Up to 200 characters
closedMessagestringRequired- Up to 2000 characters
footerstringRequired- Can be nullUp to 2000 characters
styleobjectRequiredaccentstringRequired- Pattern
^#[0-9a-fA-F]{6}$ backgroundstringRequired- Pattern
^#[0-9a-fA-F]{6}$ surfacestringRequired- Pattern
^#[0-9a-fA-F]{6}$ textstringRequired- Pattern
^#[0-9a-fA-F]{6}$ fontstringRequired- One of
"system""sans""serif""mono" radiusstringRequired- One of
"none""sm""md""lg""full" widthstringRequired- One of
"narrow""normal""wide" layoutstringRequired- One of
"card""plain" alignstringRequired- One of
"left""center" logoUrlstringRequired- Can be nullUp to 2000 charactersFormat
uri
settingsobjectWhere sign-ups go and what happens after one.
audienceIdsstring[]Required- Up to 20 items
doubleOptInbooleanRequiredsenderAddressstringRequired- Can be nullUp to 2000 characters
confirmSubjectstringRequired- 1 to 200 characters
confirmMessagestringRequired- Up to 2000 characters
confirmButtonstringRequired- 1 to 60 characters
successActionstringRequired- One of
"message""redirect" redirectUrlstringRequired- Can be nullUp to 2000 charactersFormat
uri notifyAddressesstring[]Required- Up to 10 items
allowedSitesstring[]The sites that may show this form or post to it, at most 20: a domain (example.com, which covers www.example.com too), every subdomain of one (*.example.com), or either with a path (example.com/pricing, example.com/blog/*). A scheme or a port narrows it further (https://example.com, localhost:3000). An empty list means any site. The form's own page always works.
Up to 20 items
audiencesFormAudience[]The audiences in
audienceIdswith their names.senderIssuestringWhy confirmation emails cannot go out right now, for a form with
doubleOptInon.missingmeans nosenderAddressis set,not_sendablethat the address cannot send,not_allowedthat the form's maker may not send as it. Null when they can go out, and always null withdoubleOptInoff.Can be nullOne of"missing""not_sendable""not_allowed"senderProblemstringThe same problem in a sentence, or null.
Can be nulldesignobjectnotesstring[]What the designer adjusted or left out while making the design valid.
Errors
- 409
ai_not_configured: this server has no model to design with.version_conflict: the form was saved sinceexpectedUpdatedAt, or while the designer worked, and nothing was written.- 422
invalid_formwhen the designer could not make a valid form, so nothing was created or changed.workspace_limit_reachedwhen the workspace already holds as many forms as it may.invalid_parameterfor a body that does not validate.- 429
ai_quota_exceeded: the workspace has used its AI actions for today.rate_limited: the key or app made more than 600 requests in 60 seconds. Wait for the seconds inRetry-After.
The errors every operation can return400401403404500Error catalog
Also available in
Objects
DeletedFormobject
objectstring- One of
"form" idstringdeletedboolean- One of
true
DeletedFormSubmissionobject
objectstring- One of
"form_submission" idstringformIdstringdeletedboolean- One of
true
Formobject
objectstring- One of
"form" idstringThe durable handle,
frm_plus 24 hex.namestringWhat the workspace calls the form. Visitors never see it.
descriptionstring- Can be null
statusstringdraftuntil the first publish, thenlivewhile it takes sign-ups andpausedwhile it does not. A form never goes back todraft.One of"draft""live""paused"urlstringThe hosted page that shows the published form. Share it as a link, or add
?embed=1for the frame the embed script loads.subscribeUrlstringWhere a plain HTML
<form method="post">sends its fields, and where a script posts JSON for a JSON answer.audienceIdsstring[]The audiences every sign-up joins, besides the default audience that holds every contact. An audiences field adds the ones the person ticks.
doubleOptInbooleanWhether a sign-up waits for the person to confirm their address by email.
hasUnpublishedChangesbooleanTrue when the draft
documentdiffers from what the live form shows. Always false before the first publish.statsFormStatspublishedAtstring- Can be nullFormat
date-time createdAtstring- Format
date-time updatedAtstringSend it back as
expectedUpdatedAtonPATCH /forms/{id}to refuse a save that would overwrite someone else's.Formatdate-timedocumentobjectEverything a visitor sees:
fieldsin order, thecopyaround them and thestyle. Every form has exactly oneemailfield, and every input field has a uniquekeythat answers are posted under.fieldsobject[]Required- 1 to 50 items
idstringRequired- 1 to 64 characters
typestringRequired- One of
"email""text""textarea""number""phone""url""date""select""radio""checkboxes""checkbox""consent""audiences""hidden""heading""paragraph""divider" keystringRequired- Up to 40 charactersPattern
^[a-z][a-z0-9_]{0,39}$ labelstringRequired- Up to 300 characters
placeholderstringRequired- Can be nullUp to 200 characters
helpstringRequired- Can be nullUp to 1000 characters
requiredbooleanRequireddefaultValuestringRequired- Can be nullUp to 1000 characters
optionsobject[]Required- Up to 50 items
idstringRequired- 1 to 64 characters
labelstringRequired- 1 to 300 characters
valuestringRequired- 1 to 1000 characters
mapsTostringRequiredThe contact detail this field fills when the sign-up is accepted, or null for none.
emailgoes on the email field.firstName,lastName,name,companyandjobTitlego on atextfield,phoneon aphonefield,websiteon aurlfield andbirthdayon adatefield. One field per detail, andnamenever together withfirstNameorlastName. The name is saved on the contact. The phone number, company, job title, website and birthday are saved on the contact card, and only where the card has nothing yet: a company, job title or birthday already there is kept, and a phone number or website the card already lists is not added again.Can be nullOne of"email""firstName""lastName""name""phone""company""jobTitle""website""birthday"saveAsstringA custom field of the contact this field fills when the sign-up is accepted, such as
plan, or null for none. A key starts with a letter and holds up to 64 letters, digits and underscores. The answer replaces the field of that name on the contact, an empty answer leaves it alone, and a choice of several options is saved as their labels joined by commas. Not on the email field or an audience choice, one field per custom field, and never together withmapsTo. Left out when a form is updated, a field keeps the custom field it had.Can be nullPattern^[A-Za-z][A-Za-z0-9_]{0,63}$widthstringRequired- One of
"full""half" minLengthintegerRequired- Can be nullAt least 0At most 5000
maxLengthintegerRequired- Can be nullAt least 1At most 5000
minnumberRequired- Can be nullAt least -1000000000000At most 1000000000000
maxnumberRequired- Can be nullAt least -1000000000000At most 1000000000000
copyobjectRequiredtitlestringRequired- Up to 200 characters
descriptionstringRequired- Can be nullUp to 2000 characters
submitLabelstringRequired- 1 to 60 characters
successTitlestringRequired- Up to 200 characters
successMessagestringRequired- Up to 2000 characters
pendingTitlestringRequired- Up to 200 characters
pendingMessagestringRequired- Up to 2000 characters
closedTitlestringRequired- Up to 200 characters
closedMessagestringRequired- Up to 2000 characters
footerstringRequired- Can be nullUp to 2000 characters
styleobjectRequiredaccentstringRequired- Pattern
^#[0-9a-fA-F]{6}$ backgroundstringRequired- Pattern
^#[0-9a-fA-F]{6}$ surfacestringRequired- Pattern
^#[0-9a-fA-F]{6}$ textstringRequired- Pattern
^#[0-9a-fA-F]{6}$ fontstringRequired- One of
"system""sans""serif""mono" radiusstringRequired- One of
"none""sm""md""lg""full" widthstringRequired- One of
"narrow""normal""wide" layoutstringRequired- One of
"card""plain" alignstringRequired- One of
"left""center" logoUrlstringRequired- Can be nullUp to 2000 charactersFormat
uri
publishedDocumentobjectEverything a visitor sees:
fieldsin order, thecopyaround them and thestyle. Every form has exactly oneemailfield, and every input field has a uniquekeythat answers are posted under.Can be nullfieldsobject[]Required- 1 to 50 items
idstringRequired- 1 to 64 characters
typestringRequired- One of
"email""text""textarea""number""phone""url""date""select""radio""checkboxes""checkbox""consent""audiences""hidden""heading""paragraph""divider" keystringRequired- Up to 40 charactersPattern
^[a-z][a-z0-9_]{0,39}$ labelstringRequired- Up to 300 characters
placeholderstringRequired- Can be nullUp to 200 characters
helpstringRequired- Can be nullUp to 1000 characters
requiredbooleanRequireddefaultValuestringRequired- Can be nullUp to 1000 characters
optionsobject[]Required- Up to 50 items
idstringRequired- 1 to 64 characters
labelstringRequired- 1 to 300 characters
valuestringRequired- 1 to 1000 characters
mapsTostringRequiredThe contact detail this field fills when the sign-up is accepted, or null for none.
emailgoes on the email field.firstName,lastName,name,companyandjobTitlego on atextfield,phoneon aphonefield,websiteon aurlfield andbirthdayon adatefield. One field per detail, andnamenever together withfirstNameorlastName. The name is saved on the contact. The phone number, company, job title, website and birthday are saved on the contact card, and only where the card has nothing yet: a company, job title or birthday already there is kept, and a phone number or website the card already lists is not added again.Can be nullOne of"email""firstName""lastName""name""phone""company""jobTitle""website""birthday"saveAsstringA custom field of the contact this field fills when the sign-up is accepted, such as
plan, or null for none. A key starts with a letter and holds up to 64 letters, digits and underscores. The answer replaces the field of that name on the contact, an empty answer leaves it alone, and a choice of several options is saved as their labels joined by commas. Not on the email field or an audience choice, one field per custom field, and never together withmapsTo. Left out when a form is updated, a field keeps the custom field it had.Can be nullPattern^[A-Za-z][A-Za-z0-9_]{0,63}$widthstringRequired- One of
"full""half" minLengthintegerRequired- Can be nullAt least 0At most 5000
maxLengthintegerRequired- Can be nullAt least 1At most 5000
minnumberRequired- Can be nullAt least -1000000000000At most 1000000000000
maxnumberRequired- Can be nullAt least -1000000000000At most 1000000000000
copyobjectRequiredtitlestringRequired- Up to 200 characters
descriptionstringRequired- Can be nullUp to 2000 characters
submitLabelstringRequired- 1 to 60 characters
successTitlestringRequired- Up to 200 characters
successMessagestringRequired- Up to 2000 characters
pendingTitlestringRequired- Up to 200 characters
pendingMessagestringRequired- Up to 2000 characters
closedTitlestringRequired- Up to 200 characters
closedMessagestringRequired- Up to 2000 characters
footerstringRequired- Can be nullUp to 2000 characters
styleobjectRequiredaccentstringRequired- Pattern
^#[0-9a-fA-F]{6}$ backgroundstringRequired- Pattern
^#[0-9a-fA-F]{6}$ surfacestringRequired- Pattern
^#[0-9a-fA-F]{6}$ textstringRequired- Pattern
^#[0-9a-fA-F]{6}$ fontstringRequired- One of
"system""sans""serif""mono" radiusstringRequired- One of
"none""sm""md""lg""full" widthstringRequired- One of
"narrow""normal""wide" layoutstringRequired- One of
"card""plain" alignstringRequired- One of
"left""center" logoUrlstringRequired- Can be nullUp to 2000 charactersFormat
uri
settingsobjectWhere sign-ups go and what happens after one.
audienceIdsstring[]Required- Up to 20 items
doubleOptInbooleanRequiredsenderAddressstringRequired- Can be nullUp to 2000 characters
confirmSubjectstringRequired- 1 to 200 characters
confirmMessagestringRequired- Up to 2000 characters
confirmButtonstringRequired- 1 to 60 characters
successActionstringRequired- One of
"message""redirect" redirectUrlstringRequired- Can be nullUp to 2000 charactersFormat
uri notifyAddressesstring[]Required- Up to 10 items
allowedSitesstring[]The sites that may show this form or post to it, at most 20: a domain (example.com, which covers www.example.com too), every subdomain of one (*.example.com), or either with a path (example.com/pricing, example.com/blog/*). A scheme or a port narrows it further (https://example.com, localhost:3000). An empty list means any site. The form's own page always works.
Up to 20 items
audiencesFormAudience[]The audiences in
audienceIdswith their names.senderIssuestringWhy confirmation emails cannot go out right now, for a form with
doubleOptInon.missingmeans nosenderAddressis set,not_sendablethat the address cannot send,not_allowedthat the form's maker may not send as it. Null when they can go out, and always null withdoubleOptInoff.Can be nullOne of"missing""not_sendable""not_allowed"senderProblemstringThe same problem in a sentence, or null.
Can be null
FormAnalyticsobject
objectstring- One of
"form_analytics" formIdstringsincestring- Format
date-time untilstring- Format
date-time grainstring- One of
"minute""hour""day" offsetMinutesintegertotalsobjectviewsintegerTimes the hosted page or the embed was opened while the form was live.
submissionsintegerEvery submission stored, waiting or added.
addedintegerSubmissions whose person is in the audiences.
pendingintegerSubmissions still waiting for the person to confirm their address.
lastSubmittedAtstring- Can be nullFormat
date-time conversionnumberSubmissions divided by views over the window, at most 1. Null with no views.
Can be null
seriesFormAnalyticsPoint[]Sparse: a bucket with nothing in it is left out.
FormAnalyticsPointobject
bucketstringYYYY-MM-DDfor a day,YYYY-MM-DDTHHfor an hour,YYYY-MM-DDTHH:MMfor a minute.viewsintegersubmissionsintegeraddedintegerPeople who joined the audiences in the bucket, dated when they confirmed.
FormAnswerobject
fieldIdstringkeystringThe field key the value was posted under.
labelstringThe field label when the person signed up.
typestring- One of
"email""text""textarea""number""phone""url""date""select""radio""checkboxes""checkbox""consent""audiences""hidden""heading""paragraph""divider" valuestring | string[] | booleanText for most fields, a list for multiple choice, true or false for a checkbox.
displaystringThe value as a person reads it, option labels included.
FormAudienceobject
idstringnamestringbuiltinbooleanTrue for the default audience every contact joins.
FormDocumentobject
Everything a visitor sees: fields in order, the copy around them and the style. Every form has exactly one email field, and every input field has a unique key that answers are posted under.
fieldsobject[]Required- 1 to 50 items
idstringRequired- 1 to 64 characters
typestringRequired- One of
"email""text""textarea""number""phone""url""date""select""radio""checkboxes""checkbox""consent""audiences""hidden""heading""paragraph""divider" keystringRequired- Up to 40 charactersPattern
^[a-z][a-z0-9_]{0,39}$ labelstringRequired- Up to 300 characters
placeholderstringRequired- Can be nullUp to 200 characters
helpstringRequired- Can be nullUp to 1000 characters
requiredbooleanRequireddefaultValuestringRequired- Can be nullUp to 1000 characters
optionsobject[]Required- Up to 50 items
idstringRequired- 1 to 64 characters
labelstringRequired- 1 to 300 characters
valuestringRequired- 1 to 1000 characters
mapsTostringRequiredThe contact detail this field fills when the sign-up is accepted, or null for none.
emailgoes on the email field.firstName,lastName,name,companyandjobTitlego on atextfield,phoneon aphonefield,websiteon aurlfield andbirthdayon adatefield. One field per detail, andnamenever together withfirstNameorlastName. The name is saved on the contact. The phone number, company, job title, website and birthday are saved on the contact card, and only where the card has nothing yet: a company, job title or birthday already there is kept, and a phone number or website the card already lists is not added again.Can be nullOne of"email""firstName""lastName""name""phone""company""jobTitle""website""birthday"saveAsstringA custom field of the contact this field fills when the sign-up is accepted, such as
plan, or null for none. A key starts with a letter and holds up to 64 letters, digits and underscores. The answer replaces the field of that name on the contact, an empty answer leaves it alone, and a choice of several options is saved as their labels joined by commas. Not on the email field or an audience choice, one field per custom field, and never together withmapsTo. Left out when a form is updated, a field keeps the custom field it had.Can be nullPattern^[A-Za-z][A-Za-z0-9_]{0,63}$widthstringRequired- One of
"full""half" minLengthintegerRequired- Can be nullAt least 0At most 5000
maxLengthintegerRequired- Can be nullAt least 1At most 5000
minnumberRequired- Can be nullAt least -1000000000000At most 1000000000000
maxnumberRequired- Can be nullAt least -1000000000000At most 1000000000000
copyobjectRequiredtitlestringRequired- Up to 200 characters
descriptionstringRequired- Can be nullUp to 2000 characters
submitLabelstringRequired- 1 to 60 characters
successTitlestringRequired- Up to 200 characters
successMessagestringRequired- Up to 2000 characters
pendingTitlestringRequired- Up to 200 characters
pendingMessagestringRequired- Up to 2000 characters
closedTitlestringRequired- Up to 200 characters
closedMessagestringRequired- Up to 2000 characters
footerstringRequired- Can be nullUp to 2000 characters
styleobjectRequiredaccentstringRequired- Pattern
^#[0-9a-fA-F]{6}$ backgroundstringRequired- Pattern
^#[0-9a-fA-F]{6}$ surfacestringRequired- Pattern
^#[0-9a-fA-F]{6}$ textstringRequired- Pattern
^#[0-9a-fA-F]{6}$ fontstringRequired- One of
"system""sans""serif""mono" radiusstringRequired- One of
"none""sm""md""lg""full" widthstringRequired- One of
"narrow""normal""wide" layoutstringRequired- One of
"card""plain" alignstringRequired- One of
"left""center" logoUrlstringRequired- Can be nullUp to 2000 charactersFormat
uri
FormListobject
objectstring- One of
"list" dataFormSummary[]hasMorebooleanTrue when another page follows. Pass
nextCursorback ascursorto read it.nextCursorstringAn opaque cursor for the next page, or null on the last page. Pass it back unchanged.
Can be null
FormStarterobject
objectstring- One of
"form_starter" slugstring- One of
"blank""newsletter""waitlist""event""early-access""contact" namestringdescriptionstring
FormStarterDetailobject
objectstring- One of
"form_starter" slugstring- One of
"blank""newsletter""waitlist""event""early-access""contact" namestringdescriptionstringdocumentFormDocument
FormStarterListobject
objectstring- One of
"list" dataFormStarter[]
FormStatsobject
viewsintegerTimes the hosted page or the embed was opened while the form was live.
submissionsintegerEvery submission stored, waiting or added.
addedintegerSubmissions whose person is in the audiences.
pendingintegerSubmissions still waiting for the person to confirm their address.
lastSubmittedAtstring- Can be nullFormat
date-time
FormSubmissionobject
objectstring- One of
"form_submission" idstringThe durable handle,
fsb_plus 24 hex.formIdstringemailstringThe address the person signed up with, lower cased.
statusstringaddedonce the person is a contact in the audiences.pendingwhile a double opt-in form waits for them to confirm.One of"pending""added"expiredbooleanTrue for a
pendingsubmission whose confirmation link has run out. Approve it, or send a fresh link.answersFormAnswer[]A snapshot of every answer, kept as it was even after the form changes.
audienceIdsstring[]sourceUrlstringThe page the form was filled in on, its origin and path only and at most 500 characters, when it was known.
Can be nullconfirmedAtstringWhen the person joined the audiences. Null while pending.
Can be nullFormatdate-timecreatedAtstring- Format
date-time
FormSubmissionBatchobject
objectstring- One of
"form_submission_batch" formIdstringdeletedintegerHow many submissions were deleted.
FormSubmissionListobject
objectstring- One of
"list" dataFormSubmission[]hasMorebooleannextCursorstring- Can be null
formIdstring
FormSubscriptionobject
objectstring- One of
"form_subscription" formIdstringoutcomestringaddedwhen the person is in the audiences now.pendingon a double opt-in form: they join once they confirm by email, and that email goes out after this answer unless this form emailed the address in the last ten minutes or the address has had five from this workspace today.One of"added""pending"redirectUrlstringWhere the form sends people after a sign-up, when it is set to redirect.
Can be null
FormSummaryobject
objectstring- One of
"form" idstringThe durable handle,
frm_plus 24 hex.namestringWhat the workspace calls the form. Visitors never see it.
descriptionstring- Can be null
statusstringdraftuntil the first publish, thenlivewhile it takes sign-ups andpausedwhile it does not. A form never goes back todraft.One of"draft""live""paused"urlstringThe hosted page that shows the published form. Share it as a link, or add
?embed=1for the frame the embed script loads.subscribeUrlstringWhere a plain HTML
<form method="post">sends its fields, and where a script posts JSON for a JSON answer.audienceIdsstring[]The audiences every sign-up joins, besides the default audience that holds every contact. An audiences field adds the ones the person ticks.
doubleOptInbooleanWhether a sign-up waits for the person to confirm their address by email.
hasUnpublishedChangesbooleanTrue when the draft
documentdiffers from what the live form shows. Always false before the first publish.statsFormStatspublishedAtstring- Can be nullFormat
date-time createdAtstring- Format
date-time updatedAtstringSend it back as
expectedUpdatedAtonPATCH /forms/{id}to refuse a save that would overwrite someone else's.Formatdate-time
Google Workspace
Fastmail