Belgelere geç
API

Formlar

Bu gruptaki her işlem: neyi kabul ettiği, ne döndürdüğü ve hangi hatalarla yanıt verebileceği.

İşlemler

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

Kapsamlarforms:readOkur

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.

Sorgu parametreleri

limitinteger

Rows per page, 1 to 100.

En az 1En çok 100Varsayılan25
cursorstring

The 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 400 invalid_cursor.

Döndürür

200FormList

A page of forms.

Hatalar

Her işlemin döndürebileceği hatalar400401403404422500Hata kataloğu

Şurada da var

SDK
forms.list()forms.listAll()forms.iterate()
CLI
openemail forms list
MCP
listForms

POST/forms

Create a form

Kapsamlarforms:writeVeriyi değiştirir

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.

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.

İstek gövdesi

namestringZorunlu

What the workspace calls the form, trimmed, 1 to 120 characters. Visitors never see it, and it need not be unique.

1 ile 120 karakter arası
descriptionstring

A note for the workspace, at most 500 characters. Visitors never see it.

null olabilirEn çok 500 karakter
starterstring

Begin from a starter's fields, copy and style. Ignored when document is sent.

Şunlardan biri"blank""newsletter""waitlist""event""early-access""contact"
documentobject

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[]Zorunlu
1 ile 50 arası öğe
idstringZorunlu
1 ile 64 karakter arası
typestringZorunlu
Şunlardan biri"email""text""textarea""number""phone""url""date""select""radio""checkboxes""checkbox""consent""audiences""hidden""heading""paragraph""divider"
keystringZorunlu
En çok 40 karakterDesen^[a-z][a-z0-9_]{0,39}$
labelstringZorunlu
En çok 300 karakter
placeholderstringZorunlu
null olabilirEn çok 200 karakter
helpstringZorunlu
null olabilirEn çok 1000 karakter
requiredbooleanZorunlu
defaultValuestringZorunlu
null olabilirEn çok 1000 karakter
optionsobject[]Zorunlu
En çok 50 öğe
idstringZorunlu
1 ile 64 karakter arası
labelstringZorunlu
1 ile 300 karakter arası
valuestringZorunlu
1 ile 1000 karakter arası
mapsTostringZorunlu
null olabilirŞunlardan biri"email""firstName""lastName""name"
widthstringZorunlu
Şunlardan biri"full""half"
minLengthintegerZorunlu
null olabilirEn az 0En çok 5000
maxLengthintegerZorunlu
null olabilirEn az 1En çok 5000
minnumberZorunlu
null olabilirEn az -1000000000000En çok 1000000000000
maxnumberZorunlu
null olabilirEn az -1000000000000En çok 1000000000000
copyobjectZorunlu
titlestringZorunlu
En çok 200 karakter
descriptionstringZorunlu
null olabilirEn çok 2000 karakter
submitLabelstringZorunlu
1 ile 60 karakter arası
successTitlestringZorunlu
En çok 200 karakter
successMessagestringZorunlu
En çok 2000 karakter
pendingTitlestringZorunlu
En çok 200 karakter
pendingMessagestringZorunlu
En çok 2000 karakter
closedTitlestringZorunlu
En çok 200 karakter
closedMessagestringZorunlu
En çok 2000 karakter
footerstringZorunlu
null olabilirEn çok 2000 karakter
styleobjectZorunlu
accentstringZorunlu
Desen^#[0-9a-fA-F]{6}$
backgroundstringZorunlu
Desen^#[0-9a-fA-F]{6}$
surfacestringZorunlu
Desen^#[0-9a-fA-F]{6}$
textstringZorunlu
Desen^#[0-9a-fA-F]{6}$
fontstringZorunlu
Şunlardan biri"system""sans""serif""mono"
radiusstringZorunlu
Şunlardan biri"none""sm""md""lg""full"
widthstringZorunlu
Şunlardan biri"narrow""normal""wide"
layoutstringZorunlu
Şunlardan biri"card""plain"
alignstringZorunlu
Şunlardan biri"left""center"
logoUrlstringZorunlu
null olabilirEn çok 2000 karakterBiçimuri
settingsobject

Any subset of the settings. An omitted field keeps its value.

audienceIdsstring[]
En çok 20 öğe
doubleOptInboolean
senderAddressstring
null olabilirEn çok 2000 karakter
confirmSubjectstring
1 ile 200 karakter arası
confirmMessagestring
En çok 2000 karakter
confirmButtonstring
1 ile 60 karakter arası
successActionstring
Şunlardan biri"message""redirect"
redirectUrlstring
null olabilirEn çok 2000 karakterBiçimuri
notifyAddressesstring[]
En çok 10 öğe
publishboolean

Publish in the same call, so the form takes sign-ups at once. Nothing is created when the form could not be published.

Döndürür

201Form

Created.

Hatalar

404

audience_not_found on settings.audienceIds.

422

invalid_parameter for an unknown starter or a value of the wrong shape, unknown_parameter for a key the body does not take, invalid_form when the document or settings break a rule together, form_sender_refused when confirmations cannot go out from settings.senderAddress, capability_unsupported for an address outside a limited key, or workspace_limit_reached when the workspace holds the most forms it may.

Her işlemin döndürebileceği hatalar400401403500Hata kataloğu

Şurada da var

SDK
forms.create()
CLI
openemail forms create
MCP
createForm

GET/forms/starters

List the form starters

Kapsamlarforms:readOkur

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.

Döndürür

200FormStarterList

Every starter, documents left out.

Hatalar

Her işlemin döndürebileceği hatalar400401403404422500Hata kataloğu

Şurada da var

SDK
forms.listStarters()
CLI
openemail forms list-starters
MCP
listFormStarters

GET/forms/starters/{slug}

Retrieve a form starter

Kapsamlarforms:readOkur

Adds the starter document, so a client can change it before creating a form from it.

Requires the forms:read scope.

Yol parametreleri

slugstringZorunlu

A slug from GET /forms/starters.

Şunlardan biri"blank""newsletter""waitlist""event""early-access""contact"

Döndürür

200FormStarterDetail

The starter with its document.

Hatalar

404

form_starter_not_found when no starter has that slug.

Her işlemin döndürebileceği hatalar400401403422500Hata kataloğu

Şurada da var

SDK
forms.getStarter()
CLI
openemail forms get-starter
MCP
listFormStarters

GET/forms/{id}

Retrieve a form

Kapsamlarforms:readOkur

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.

Yol parametreleri

idstringZorunlu

The form id, frm_ plus 24 hex.

Döndürür

200Form

The form.

Hatalar

404

form_not_found when the id names no form you can reach.

Her işlemin döndürebileceği hatalar400401403422500Hata kataloğu

Şurada da var

SDK
forms.get()
CLI
openemail forms get
MCP
getForm

PATCH/forms/{id}

Update a form

Kapsamlarforms:writeVeriyi değiştirir

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.

Yol parametreleri

idstringZorunlu

The form id, frm_ plus 24 hex.

İstek gövdesi

namestring

New name, trimmed, 1 to 120 characters.

1 ile 120 karakter arası
descriptionstring

New note, at most 500 characters. Null clears it.

null olabilirEn çok 500 karakter
documentobject

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[]Zorunlu
1 ile 50 arası öğe
idstringZorunlu
1 ile 64 karakter arası
typestringZorunlu
Şunlardan biri"email""text""textarea""number""phone""url""date""select""radio""checkboxes""checkbox""consent""audiences""hidden""heading""paragraph""divider"
keystringZorunlu
En çok 40 karakterDesen^[a-z][a-z0-9_]{0,39}$
labelstringZorunlu
En çok 300 karakter
placeholderstringZorunlu
null olabilirEn çok 200 karakter
helpstringZorunlu
null olabilirEn çok 1000 karakter
requiredbooleanZorunlu
defaultValuestringZorunlu
null olabilirEn çok 1000 karakter
optionsobject[]Zorunlu
En çok 50 öğe
idstringZorunlu
1 ile 64 karakter arası
labelstringZorunlu
1 ile 300 karakter arası
valuestringZorunlu
1 ile 1000 karakter arası
mapsTostringZorunlu
null olabilirŞunlardan biri"email""firstName""lastName""name"
widthstringZorunlu
Şunlardan biri"full""half"
minLengthintegerZorunlu
null olabilirEn az 0En çok 5000
maxLengthintegerZorunlu
null olabilirEn az 1En çok 5000
minnumberZorunlu
null olabilirEn az -1000000000000En çok 1000000000000
maxnumberZorunlu
null olabilirEn az -1000000000000En çok 1000000000000
copyobjectZorunlu
titlestringZorunlu
En çok 200 karakter
descriptionstringZorunlu
null olabilirEn çok 2000 karakter
submitLabelstringZorunlu
1 ile 60 karakter arası
successTitlestringZorunlu
En çok 200 karakter
successMessagestringZorunlu
En çok 2000 karakter
pendingTitlestringZorunlu
En çok 200 karakter
pendingMessagestringZorunlu
En çok 2000 karakter
closedTitlestringZorunlu
En çok 200 karakter
closedMessagestringZorunlu
En çok 2000 karakter
footerstringZorunlu
null olabilirEn çok 2000 karakter
styleobjectZorunlu
accentstringZorunlu
Desen^#[0-9a-fA-F]{6}$
backgroundstringZorunlu
Desen^#[0-9a-fA-F]{6}$
surfacestringZorunlu
Desen^#[0-9a-fA-F]{6}$
textstringZorunlu
Desen^#[0-9a-fA-F]{6}$
fontstringZorunlu
Şunlardan biri"system""sans""serif""mono"
radiusstringZorunlu
Şunlardan biri"none""sm""md""lg""full"
widthstringZorunlu
Şunlardan biri"narrow""normal""wide"
layoutstringZorunlu
Şunlardan biri"card""plain"
alignstringZorunlu
Şunlardan biri"left""center"
logoUrlstringZorunlu
null olabilirEn çok 2000 karakterBiçimuri
settingsobject

Any subset of the settings. An omitted field keeps its value.

audienceIdsstring[]
En çok 20 öğe
doubleOptInboolean
senderAddressstring
null olabilirEn çok 2000 karakter
confirmSubjectstring
1 ile 200 karakter arası
confirmMessagestring
En çok 2000 karakter
confirmButtonstring
1 ile 60 karakter arası
successActionstring
Şunlardan biri"message""redirect"
redirectUrlstring
null olabilirEn çok 2000 karakterBiçimuri
notifyAddressesstring[]
En çok 10 öğe
expectedUpdatedAtstring

The updatedAt you read. When the form was saved since, nothing is written and the answer is 409 version_conflict.

Biçimdate-time

Döndürür

200Form

Saved.

Hatalar

404

form_not_found, or audience_not_found on settings.audienceIds.

409

version_conflict: the form was saved after expectedUpdatedAt. Nothing was written.

422

invalid_parameter for a value of the wrong shape, unknown_parameter for a key the body does not take, invalid_form when the document or settings break a rule together, form_sender_refused or capability_unsupported, each with param naming the field.

Her işlemin döndürebileceği hatalar400401403500Hata kataloğu

Şurada da var

SDK
forms.update()
CLI
openemail forms update
MCP
updateForm

DELETE/forms/{id}

Delete a form

Kapsamlarforms:writeSiler
Doğrulama kodu ister

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.

Yol parametreleri

idstringZorunlu

The form id, frm_ plus 24 hex.

Döndürür

200DeletedForm

Deleted.

Hatalar

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 with POST /security/step-up, send it to POST /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 OpenEmail website. An API key is never asked for a code.

404

form_not_found when the id names no form you can reach.

Her işlemin döndürebileceği hatalar400401422500Hata kataloğu

Şurada da var

SDK
forms.delete()
CLI
openemail forms delete
MCP
deleteForm

POST/forms/{id}/publish

Publish a form

Kapsamlarforms:writeVeriyi değiştirir

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.

Yol parametreleri

idstringZorunlu

The form id, frm_ plus 24 hex.

Döndürür

200Form

Published.

Hatalar

404

form_not_found when the id names no form you can reach.

422

invalid_form or form_sender_refused, with param naming the field, or capability_unsupported when the key or app is limited to some addresses and the form's settings.senderAddress or settings.notifyAddresses falls outside them.

Her işlemin döndürebileceği hatalar400401403500Hata kataloğu

Şurada da var

SDK
forms.publish()
CLI
openemail forms publish
MCP
publishForm

POST/forms/{id}/pause

Pause a form

Kapsamlarforms:writeVeriyi değiştirir

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.

Yol parametreleri

idstringZorunlu

The form id, frm_ plus 24 hex.

Döndürür

200Form

Paused.

Hatalar

404

form_not_found when the id names no form you can reach.

409

form_not_published: a form that was never published cannot be paused.

Her işlemin döndürebileceği hatalar400401403422500Hata kataloğu

Şurada da var

SDK
forms.pause()
CLI
openemail forms pause
MCP
setFormStatus

POST/forms/{id}/resume

Resume a form

Kapsamlarforms:writeVeriyi değiştirir

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.

Yol parametreleri

idstringZorunlu

The form id, frm_ plus 24 hex.

Döndürür

200Form

Live.

Hatalar

404

form_not_found when the id names no form you can reach.

409

form_not_published: publish the form first.

422

form_sender_refused when a double opt-in form can no longer send confirmations, invalid_form when the published form breaks a rule, or capability_unsupported when the key or app is limited to some addresses and the form's settings.senderAddress or settings.notifyAddresses falls outside them.

Her işlemin döndürebileceği hatalar400401403500Hata kataloğu

Şurada da var

SDK
forms.resume()
CLI
openemail forms resume
MCP
setFormStatus

POST/forms/{id}/duplicate

Duplicate a form

Kapsamlarforms:writeVeriyi değiştirir

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.

Yol parametreleri

idstringZorunlu

The form id, frm_ plus 24 hex.

Döndürür

201Form

The copy.

Hatalar

404

form_not_found when the id names no form you can reach.

422

workspace_limit_reached when the workspace holds the most forms it may, or capability_unsupported when the key or app is limited to some addresses and the form's settings.senderAddress or settings.notifyAddresses falls outside them.

Her işlemin döndürebileceği hatalar400401403500Hata kataloğu

Şurada da var

SDK
forms.duplicate()
CLI
openemail forms duplicate
MCP
duplicateForm

GET/forms/{id}/analytics

Form analytics

Kapsamlarforms:readOkur

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.

Yol parametreleri

idstringZorunlu

The form id, frm_ plus 24 hex.

Sorgu parametreleri

daysinteger

How far back to look. The oldest bucket is a whole one and the newest is partial.

En az 1En çok 1095Varsayılan30
minutesinteger

The window in minutes, which wins over days when both are sent.

En az 1En çok 1576800
grainstring

How wide one bucket is. Views are kept per hour.

Şunlardan biri"minute""hour""day"Varsayılan"day"
offsetMinutesinteger

Minutes east of UTC to cut the buckets in, so a day breaks where the reader's day does.

En az -840En çok 840Varsayılan0

Döndürür

200FormAnalytics

The window, the totals and the series.

Hatalar

404

form_not_found when the id names no form you can reach.

Her işlemin döndürebileceği hatalar400401403422500Hata kataloğu

Şurada da var

SDK
forms.analytics()
CLI
openemail forms analytics
MCP
getFormAnalytics

GET/forms/{id}/submissions

List submissions

Kapsamlarforms:readOkur

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.

Yol parametreleri

idstringZorunlu

The form id, frm_ plus 24 hex.

Sorgu parametreleri

limitinteger

Rows per page, 1 to 100.

En az 1En çok 100Varsayılan25
cursorstring

A submission id of this form. Keyset, not offset: pass the previous page's nextCursor. One that names nothing in this list is a 400 invalid_cursor.

qstring

Only submissions whose email address contains this text, ignoring case.

En çok 200 karakter
statusstring

Only pending or only added submissions.

Şunlardan biri"pending""added"

Döndürür

200FormSubmissionList

A page of submissions.

Hatalar

400

invalid_cursor when the cursor names no submission of this form.

404

form_not_found when the id names no form you can reach.

Her işlemin döndürebileceği hatalar401403422500Hata kataloğu

Şurada da var

SDK
forms.listSubmissions()forms.listAllSubmissions()forms.iterateSubmissions()
CLI
openemail forms list-submissions
MCP
listFormSubmissions

POST/forms/{id}/submissions/batch-remove

Delete submissions

Kapsamlarforms:writeSiler

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.

Yol parametreleri

idstringZorunlu

The form id, frm_ plus 24 hex.

İstek gövdesi

idsstring[]Zorunlu

Submission ids of this form. An id that names nothing is skipped.

1 ile 200 arası öğe

Döndürür

200FormSubmissionBatch

Deleted.

Hatalar

404

form_not_found when the id names no form you can reach.

Her işlemin döndürebileceği hatalar400401403422500Hata kataloğu

Şurada da var

SDK
forms.deleteSubmissions()
CLI
openemail forms delete-submissions
MCP
removeFormSubmissions

GET/forms/{id}/submissions/{submissionId}

Retrieve a submission

Kapsamlarforms:readOkur

One submission with every answer.

Requires the forms:read scope.

Yol parametreleri

idstringZorunlu

The form id, frm_ plus 24 hex.

submissionIdstringZorunlu

The submission id, fsb_ plus 24 hex.

Döndürür

200FormSubmission

The submission.

Hatalar

404

form_not_found, or form_submission_not_found when the form has no such submission.

Her işlemin döndürebileceği hatalar400401403422500Hata kataloğu

Şurada da var

SDK
forms.getSubmission()
CLI
openemail forms get-submission
MCP
getFormSubmission

DELETE/forms/{id}/submissions/{submissionId}

Delete a submission

Kapsamlarforms:writeSiler

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.

Yol parametreleri

idstringZorunlu

The form id, frm_ plus 24 hex.

submissionIdstringZorunlu

The submission id, fsb_ plus 24 hex.

Döndürür

200DeletedFormSubmission

Deleted.

Hatalar

404

form_not_found or form_submission_not_found.

Her işlemin döndürebileceği hatalar400401403422500Hata kataloğu

Şurada da var

SDK
forms.deleteSubmission()
CLI
openemail forms delete-submission
MCP
removeFormSubmissions

POST/forms/{id}/submissions/{submissionId}/approve

Approve a submission

Kapsamlarforms:writecontacts:writeVeriyi değiştirir

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.

Yol parametreleri

idstringZorunlu

The form id, frm_ plus 24 hex.

submissionIdstringZorunlu

The submission id, fsb_ plus 24 hex.

Döndürür

200FormSubmission

The submission, now added.

Hatalar

404

form_not_found or form_submission_not_found.

Her işlemin döndürebileceği hatalar400401403422500Hata kataloğu

Şurada da var

SDK
forms.approveSubmission()
CLI
openemail forms approve-submission
MCP
approveFormSubmission

POST/forms/{id}/submissions/{submissionId}/resend

Resend a confirmation

Kapsamlarforms:writeemails:sendE-posta gönderir

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.

Yol parametreleri

idstringZorunlu

The form id, frm_ plus 24 hex.

submissionIdstringZorunlu

The submission id, fsb_ plus 24 hex.

Döndürür

200object

The submission.

objectstring
Şunlardan biri"form_submission"
idstring

The durable handle, fsb_ plus 24 hex.

formIdstring
emailstring

The address the person signed up with, lower cased.

statusstring

added once the person is a contact in the audiences. pending while a double opt-in form waits for them to confirm.

Şunlardan biri"pending""added"
expiredboolean

True for a pending submission 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[]
sourceUrlstring

The page the form was filled in on, its origin and path only and at most 500 characters, when it was known.

null olabilir
confirmedAtstring

When the person joined the audiences. Null while pending.

null olabilirBiçimdate-time
createdAtstring
Biçimdate-time
confirmationSentboolean

Whether an email went out on this call.

Hatalar

404

form_not_found or form_submission_not_found.

422

form_sender_refused when confirmations cannot go out from the form's address.

Her işlemin döndürebileceği hatalar400401403500Hata kataloğu

Şurada da var

SDK
forms.resendConfirmation()
CLI
openemail forms resend-confirmation
MCP
resendFormConfirmation

POST/subscribe/{formId}

Sign up through a form

Kapsam yokKimlik bilgisi yokVeriyi değiştirir

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.

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 from an audience stays unsubscribed unless they confirm through a double opt-in form. 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.

Yol parametreleri

formIdstringZorunlu

The id of a published form.

İstek gövdesi

İçerik türüapplication/json, application/x-www-form-urlencoded, multipart/form-data

emailstring

The field keyed email, which every form has.

valuesobject

The answers again, for a client that would rather nest them.

oe_sourcestring

The page the form was filled in on. Defaults to the Referer header.

Döndürür

200FormSubscription

Signed up, for a JSON caller.

303

Signed up or refused, for a browser form: follow the Location header.

Hatalar

400

malformed_json when a JSON body does not parse or is not an object.

404

form_not_found when no published form has that id.

409

form_closed when the form is paused.

422

invalid_form_submission when an answer is missing or not valid. The error carries fields, one entry per problem with the field key and the reason.

429

form_rate_limited when too many sign-ups came from the same network.

Her işlemin döndürebileceği hatalar500Hata kataloğu

Şurada da var

SDK
forms.subscribe()
CLI
openemail forms subscribe

POST/forms/design

Design a form from a brief

Kapsamlarforms:writeVeriyi değiştirir

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.

İstek gövdesi

briefstringZorunlu

Everything the form must ask and say, up to 4,000 characters.

1 ile 4000 karakter arası
namestring

A short name for the form, up to 120 characters. Left out, the designer names it.

1 ile 120 karakter arası

Döndürür

201object

The new form, a draft.

objectstring
Şunlardan biri"form"
idstring

The durable handle, frm_ plus 24 hex.

namestring

What the workspace calls the form. Visitors never see it.

descriptionstring
null olabilir
statusstring

draft until the first publish, then live while it takes sign-ups and paused while it does not. A form never goes back to draft.

Şunlardan biri"draft""live""paused"
urlstring

The hosted page that shows the published form. Share it as a link, or add ?embed=1 for the frame the embed script loads.

subscribeUrlstring

Where 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.

doubleOptInboolean

Whether a sign-up waits for the person to confirm their address by email.

hasUnpublishedChangesboolean

True when the draft document differs from what the live form shows. Always false before the first publish.

statsFormStats
publishedAtstring
null olabilirBiçimdate-time
createdAtstring
Biçimdate-time
updatedAtstring

Send it back as expectedUpdatedAt on PATCH /forms/{id} to refuse a save that would overwrite someone else's.

Biçimdate-time
documentobject

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[]Zorunlu
1 ile 50 arası öğe
idstringZorunlu
1 ile 64 karakter arası
typestringZorunlu
Şunlardan biri"email""text""textarea""number""phone""url""date""select""radio""checkboxes""checkbox""consent""audiences""hidden""heading""paragraph""divider"
keystringZorunlu
En çok 40 karakterDesen^[a-z][a-z0-9_]{0,39}$
labelstringZorunlu
En çok 300 karakter
placeholderstringZorunlu
null olabilirEn çok 200 karakter
helpstringZorunlu
null olabilirEn çok 1000 karakter
requiredbooleanZorunlu
defaultValuestringZorunlu
null olabilirEn çok 1000 karakter
optionsobject[]Zorunlu
En çok 50 öğe
idstringZorunlu
1 ile 64 karakter arası
labelstringZorunlu
1 ile 300 karakter arası
valuestringZorunlu
1 ile 1000 karakter arası
mapsTostringZorunlu
null olabilirŞunlardan biri"email""firstName""lastName""name"
widthstringZorunlu
Şunlardan biri"full""half"
minLengthintegerZorunlu
null olabilirEn az 0En çok 5000
maxLengthintegerZorunlu
null olabilirEn az 1En çok 5000
minnumberZorunlu
null olabilirEn az -1000000000000En çok 1000000000000
maxnumberZorunlu
null olabilirEn az -1000000000000En çok 1000000000000
copyobjectZorunlu
titlestringZorunlu
En çok 200 karakter
descriptionstringZorunlu
null olabilirEn çok 2000 karakter
submitLabelstringZorunlu
1 ile 60 karakter arası
successTitlestringZorunlu
En çok 200 karakter
successMessagestringZorunlu
En çok 2000 karakter
pendingTitlestringZorunlu
En çok 200 karakter
pendingMessagestringZorunlu
En çok 2000 karakter
closedTitlestringZorunlu
En çok 200 karakter
closedMessagestringZorunlu
En çok 2000 karakter
footerstringZorunlu
null olabilirEn çok 2000 karakter
styleobjectZorunlu
accentstringZorunlu
Desen^#[0-9a-fA-F]{6}$
backgroundstringZorunlu
Desen^#[0-9a-fA-F]{6}$
surfacestringZorunlu
Desen^#[0-9a-fA-F]{6}$
textstringZorunlu
Desen^#[0-9a-fA-F]{6}$
fontstringZorunlu
Şunlardan biri"system""sans""serif""mono"
radiusstringZorunlu
Şunlardan biri"none""sm""md""lg""full"
widthstringZorunlu
Şunlardan biri"narrow""normal""wide"
layoutstringZorunlu
Şunlardan biri"card""plain"
alignstringZorunlu
Şunlardan biri"left""center"
logoUrlstringZorunlu
null olabilirEn çok 2000 karakterBiçimuri
publishedDocumentobject

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.

null olabilir
fieldsobject[]Zorunlu
1 ile 50 arası öğe
idstringZorunlu
1 ile 64 karakter arası
typestringZorunlu
Şunlardan biri"email""text""textarea""number""phone""url""date""select""radio""checkboxes""checkbox""consent""audiences""hidden""heading""paragraph""divider"
keystringZorunlu
En çok 40 karakterDesen^[a-z][a-z0-9_]{0,39}$
labelstringZorunlu
En çok 300 karakter
placeholderstringZorunlu
null olabilirEn çok 200 karakter
helpstringZorunlu
null olabilirEn çok 1000 karakter
requiredbooleanZorunlu
defaultValuestringZorunlu
null olabilirEn çok 1000 karakter
optionsobject[]Zorunlu
En çok 50 öğe
idstringZorunlu
1 ile 64 karakter arası
labelstringZorunlu
1 ile 300 karakter arası
valuestringZorunlu
1 ile 1000 karakter arası
mapsTostringZorunlu
null olabilirŞunlardan biri"email""firstName""lastName""name"
widthstringZorunlu
Şunlardan biri"full""half"
minLengthintegerZorunlu
null olabilirEn az 0En çok 5000
maxLengthintegerZorunlu
null olabilirEn az 1En çok 5000
minnumberZorunlu
null olabilirEn az -1000000000000En çok 1000000000000
maxnumberZorunlu
null olabilirEn az -1000000000000En çok 1000000000000
copyobjectZorunlu
titlestringZorunlu
En çok 200 karakter
descriptionstringZorunlu
null olabilirEn çok 2000 karakter
submitLabelstringZorunlu
1 ile 60 karakter arası
successTitlestringZorunlu
En çok 200 karakter
successMessagestringZorunlu
En çok 2000 karakter
pendingTitlestringZorunlu
En çok 200 karakter
pendingMessagestringZorunlu
En çok 2000 karakter
closedTitlestringZorunlu
En çok 200 karakter
closedMessagestringZorunlu
En çok 2000 karakter
footerstringZorunlu
null olabilirEn çok 2000 karakter
styleobjectZorunlu
accentstringZorunlu
Desen^#[0-9a-fA-F]{6}$
backgroundstringZorunlu
Desen^#[0-9a-fA-F]{6}$
surfacestringZorunlu
Desen^#[0-9a-fA-F]{6}$
textstringZorunlu
Desen^#[0-9a-fA-F]{6}$
fontstringZorunlu
Şunlardan biri"system""sans""serif""mono"
radiusstringZorunlu
Şunlardan biri"none""sm""md""lg""full"
widthstringZorunlu
Şunlardan biri"narrow""normal""wide"
layoutstringZorunlu
Şunlardan biri"card""plain"
alignstringZorunlu
Şunlardan biri"left""center"
logoUrlstringZorunlu
null olabilirEn çok 2000 karakterBiçimuri
settingsobject

Where sign-ups go and what happens after one.

audienceIdsstring[]Zorunlu
En çok 20 öğe
doubleOptInbooleanZorunlu
senderAddressstringZorunlu
null olabilirEn çok 2000 karakter
confirmSubjectstringZorunlu
1 ile 200 karakter arası
confirmMessagestringZorunlu
En çok 2000 karakter
confirmButtonstringZorunlu
1 ile 60 karakter arası
successActionstringZorunlu
Şunlardan biri"message""redirect"
redirectUrlstringZorunlu
null olabilirEn çok 2000 karakterBiçimuri
notifyAddressesstring[]Zorunlu
En çok 10 öğe
audiencesFormAudience[]

The audiences in audienceIds with their names.

senderIssuestring

Why confirmation emails cannot go out right now, for a form with doubleOptIn on. missing means no senderAddress is set, not_sendable that the address cannot send, not_allowed that the form's maker may not send as it. Null when they can go out, and always null with doubleOptIn off.

null olabilirŞunlardan biri"missing""not_sendable""not_allowed"
senderProblemstring

The same problem in a sentence, or null.

null olabilir
designobject
notesstring[]

What the designer adjusted or left out while making the design valid.

Hatalar

409

ai_not_configured: this server has no model to design with. version_conflict: the form was saved since expectedUpdatedAt, or while the designer worked, and nothing was written.

422

invalid_form when the designer could not make a valid form, so nothing was created or changed. workspace_limit_reached when the workspace already holds as many forms as it may. invalid_parameter for a body that does not validate.

429

ai_quota_exceeded: the workspace has used its AI actions for today.

Her işlemin döndürebileceği hatalar400401403404500Hata kataloğu

Şurada da var

SDK
forms.design()
CLI
openemail forms design
MCP
designForm

POST/forms/{id}/redesign

Change a form’s design from instructions

Kapsamlarforms:writeVeriyi değiştirir

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.

Yol parametreleri

idstringZorunlu

Form id such as frm_8d2f6a1c9b3e47d0a5f1c2e9.

İstek gövdesi

instructionsstringZorunlu

What to change, with every detail, up to 4,000 characters.

1 ile 4000 karakter arası
expectedUpdatedAtstring

The updatedAt you read, as it came. When the form was saved since, nothing is written and the answer is 409 version_conflict.

Biçimdate-time

Döndürür

200object

The form, with the change in its draft.

objectstring
Şunlardan biri"form"
idstring

The durable handle, frm_ plus 24 hex.

namestring

What the workspace calls the form. Visitors never see it.

descriptionstring
null olabilir
statusstring

draft until the first publish, then live while it takes sign-ups and paused while it does not. A form never goes back to draft.

Şunlardan biri"draft""live""paused"
urlstring

The hosted page that shows the published form. Share it as a link, or add ?embed=1 for the frame the embed script loads.

subscribeUrlstring

Where 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.

doubleOptInboolean

Whether a sign-up waits for the person to confirm their address by email.

hasUnpublishedChangesboolean

True when the draft document differs from what the live form shows. Always false before the first publish.

statsFormStats
publishedAtstring
null olabilirBiçimdate-time
createdAtstring
Biçimdate-time
updatedAtstring

Send it back as expectedUpdatedAt on PATCH /forms/{id} to refuse a save that would overwrite someone else's.

Biçimdate-time
documentobject

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[]Zorunlu
1 ile 50 arası öğe
idstringZorunlu
1 ile 64 karakter arası
typestringZorunlu
Şunlardan biri"email""text""textarea""number""phone""url""date""select""radio""checkboxes""checkbox""consent""audiences""hidden""heading""paragraph""divider"
keystringZorunlu
En çok 40 karakterDesen^[a-z][a-z0-9_]{0,39}$
labelstringZorunlu
En çok 300 karakter
placeholderstringZorunlu
null olabilirEn çok 200 karakter
helpstringZorunlu
null olabilirEn çok 1000 karakter
requiredbooleanZorunlu
defaultValuestringZorunlu
null olabilirEn çok 1000 karakter
optionsobject[]Zorunlu
En çok 50 öğe
idstringZorunlu
1 ile 64 karakter arası
labelstringZorunlu
1 ile 300 karakter arası
valuestringZorunlu
1 ile 1000 karakter arası
mapsTostringZorunlu
null olabilirŞunlardan biri"email""firstName""lastName""name"
widthstringZorunlu
Şunlardan biri"full""half"
minLengthintegerZorunlu
null olabilirEn az 0En çok 5000
maxLengthintegerZorunlu
null olabilirEn az 1En çok 5000
minnumberZorunlu
null olabilirEn az -1000000000000En çok 1000000000000
maxnumberZorunlu
null olabilirEn az -1000000000000En çok 1000000000000
copyobjectZorunlu
titlestringZorunlu
En çok 200 karakter
descriptionstringZorunlu
null olabilirEn çok 2000 karakter
submitLabelstringZorunlu
1 ile 60 karakter arası
successTitlestringZorunlu
En çok 200 karakter
successMessagestringZorunlu
En çok 2000 karakter
pendingTitlestringZorunlu
En çok 200 karakter
pendingMessagestringZorunlu
En çok 2000 karakter
closedTitlestringZorunlu
En çok 200 karakter
closedMessagestringZorunlu
En çok 2000 karakter
footerstringZorunlu
null olabilirEn çok 2000 karakter
styleobjectZorunlu
accentstringZorunlu
Desen^#[0-9a-fA-F]{6}$
backgroundstringZorunlu
Desen^#[0-9a-fA-F]{6}$
surfacestringZorunlu
Desen^#[0-9a-fA-F]{6}$
textstringZorunlu
Desen^#[0-9a-fA-F]{6}$
fontstringZorunlu
Şunlardan biri"system""sans""serif""mono"
radiusstringZorunlu
Şunlardan biri"none""sm""md""lg""full"
widthstringZorunlu
Şunlardan biri"narrow""normal""wide"
layoutstringZorunlu
Şunlardan biri"card""plain"
alignstringZorunlu
Şunlardan biri"left""center"
logoUrlstringZorunlu
null olabilirEn çok 2000 karakterBiçimuri
publishedDocumentobject

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.

null olabilir
fieldsobject[]Zorunlu
1 ile 50 arası öğe
idstringZorunlu
1 ile 64 karakter arası
typestringZorunlu
Şunlardan biri"email""text""textarea""number""phone""url""date""select""radio""checkboxes""checkbox""consent""audiences""hidden""heading""paragraph""divider"
keystringZorunlu
En çok 40 karakterDesen^[a-z][a-z0-9_]{0,39}$
labelstringZorunlu
En çok 300 karakter
placeholderstringZorunlu
null olabilirEn çok 200 karakter
helpstringZorunlu
null olabilirEn çok 1000 karakter
requiredbooleanZorunlu
defaultValuestringZorunlu
null olabilirEn çok 1000 karakter
optionsobject[]Zorunlu
En çok 50 öğe
idstringZorunlu
1 ile 64 karakter arası
labelstringZorunlu
1 ile 300 karakter arası
valuestringZorunlu
1 ile 1000 karakter arası
mapsTostringZorunlu
null olabilirŞunlardan biri"email""firstName""lastName""name"
widthstringZorunlu
Şunlardan biri"full""half"
minLengthintegerZorunlu
null olabilirEn az 0En çok 5000
maxLengthintegerZorunlu
null olabilirEn az 1En çok 5000
minnumberZorunlu
null olabilirEn az -1000000000000En çok 1000000000000
maxnumberZorunlu
null olabilirEn az -1000000000000En çok 1000000000000
copyobjectZorunlu
titlestringZorunlu
En çok 200 karakter
descriptionstringZorunlu
null olabilirEn çok 2000 karakter
submitLabelstringZorunlu
1 ile 60 karakter arası
successTitlestringZorunlu
En çok 200 karakter
successMessagestringZorunlu
En çok 2000 karakter
pendingTitlestringZorunlu
En çok 200 karakter
pendingMessagestringZorunlu
En çok 2000 karakter
closedTitlestringZorunlu
En çok 200 karakter
closedMessagestringZorunlu
En çok 2000 karakter
footerstringZorunlu
null olabilirEn çok 2000 karakter
styleobjectZorunlu
accentstringZorunlu
Desen^#[0-9a-fA-F]{6}$
backgroundstringZorunlu
Desen^#[0-9a-fA-F]{6}$
surfacestringZorunlu
Desen^#[0-9a-fA-F]{6}$
textstringZorunlu
Desen^#[0-9a-fA-F]{6}$
fontstringZorunlu
Şunlardan biri"system""sans""serif""mono"
radiusstringZorunlu
Şunlardan biri"none""sm""md""lg""full"
widthstringZorunlu
Şunlardan biri"narrow""normal""wide"
layoutstringZorunlu
Şunlardan biri"card""plain"
alignstringZorunlu
Şunlardan biri"left""center"
logoUrlstringZorunlu
null olabilirEn çok 2000 karakterBiçimuri
settingsobject

Where sign-ups go and what happens after one.

audienceIdsstring[]Zorunlu
En çok 20 öğe
doubleOptInbooleanZorunlu
senderAddressstringZorunlu
null olabilirEn çok 2000 karakter
confirmSubjectstringZorunlu
1 ile 200 karakter arası
confirmMessagestringZorunlu
En çok 2000 karakter
confirmButtonstringZorunlu
1 ile 60 karakter arası
successActionstringZorunlu
Şunlardan biri"message""redirect"
redirectUrlstringZorunlu
null olabilirEn çok 2000 karakterBiçimuri
notifyAddressesstring[]Zorunlu
En çok 10 öğe
audiencesFormAudience[]

The audiences in audienceIds with their names.

senderIssuestring

Why confirmation emails cannot go out right now, for a form with doubleOptIn on. missing means no senderAddress is set, not_sendable that the address cannot send, not_allowed that the form's maker may not send as it. Null when they can go out, and always null with doubleOptIn off.

null olabilirŞunlardan biri"missing""not_sendable""not_allowed"
senderProblemstring

The same problem in a sentence, or null.

null olabilir
designobject
notesstring[]

What the designer adjusted or left out while making the design valid.

Hatalar

409

ai_not_configured: this server has no model to design with. version_conflict: the form was saved since expectedUpdatedAt, or while the designer worked, and nothing was written.

422

invalid_form when the designer could not make a valid form, so nothing was created or changed. workspace_limit_reached when the workspace already holds as many forms as it may. invalid_parameter for a body that does not validate.

429

ai_quota_exceeded: the workspace has used its AI actions for today.

Her işlemin döndürebileceği hatalar400401403404500Hata kataloğu

Şurada da var

SDK
forms.redesign()
CLI
openemail forms redesign
MCP
editFormDesign

Nesneler

DeletedFormobject

objectstring
Şunlardan biri"form"
idstring
deletedboolean
Şunlardan biritrue

DeletedFormSubmissionobject

objectstring
Şunlardan biri"form_submission"
idstring
formIdstring
deletedboolean
Şunlardan biritrue

Formobject

objectstring
Şunlardan biri"form"
idstring

The durable handle, frm_ plus 24 hex.

namestring

What the workspace calls the form. Visitors never see it.

descriptionstring
null olabilir
statusstring

draft until the first publish, then live while it takes sign-ups and paused while it does not. A form never goes back to draft.

Şunlardan biri"draft""live""paused"
urlstring

The hosted page that shows the published form. Share it as a link, or add ?embed=1 for the frame the embed script loads.

subscribeUrlstring

Where 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.

doubleOptInboolean

Whether a sign-up waits for the person to confirm their address by email.

hasUnpublishedChangesboolean

True when the draft document differs from what the live form shows. Always false before the first publish.

statsFormStats
publishedAtstring
null olabilirBiçimdate-time
createdAtstring
Biçimdate-time
updatedAtstring

Send it back as expectedUpdatedAt on PATCH /forms/{id} to refuse a save that would overwrite someone else's.

Biçimdate-time
documentobject

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[]Zorunlu
1 ile 50 arası öğe
idstringZorunlu
1 ile 64 karakter arası
typestringZorunlu
Şunlardan biri"email""text""textarea""number""phone""url""date""select""radio""checkboxes""checkbox""consent""audiences""hidden""heading""paragraph""divider"
keystringZorunlu
En çok 40 karakterDesen^[a-z][a-z0-9_]{0,39}$
labelstringZorunlu
En çok 300 karakter
placeholderstringZorunlu
null olabilirEn çok 200 karakter
helpstringZorunlu
null olabilirEn çok 1000 karakter
requiredbooleanZorunlu
defaultValuestringZorunlu
null olabilirEn çok 1000 karakter
optionsobject[]Zorunlu
En çok 50 öğe
idstringZorunlu
1 ile 64 karakter arası
labelstringZorunlu
1 ile 300 karakter arası
valuestringZorunlu
1 ile 1000 karakter arası
mapsTostringZorunlu
null olabilirŞunlardan biri"email""firstName""lastName""name"
widthstringZorunlu
Şunlardan biri"full""half"
minLengthintegerZorunlu
null olabilirEn az 0En çok 5000
maxLengthintegerZorunlu
null olabilirEn az 1En çok 5000
minnumberZorunlu
null olabilirEn az -1000000000000En çok 1000000000000
maxnumberZorunlu
null olabilirEn az -1000000000000En çok 1000000000000
copyobjectZorunlu
titlestringZorunlu
En çok 200 karakter
descriptionstringZorunlu
null olabilirEn çok 2000 karakter
submitLabelstringZorunlu
1 ile 60 karakter arası
successTitlestringZorunlu
En çok 200 karakter
successMessagestringZorunlu
En çok 2000 karakter
pendingTitlestringZorunlu
En çok 200 karakter
pendingMessagestringZorunlu
En çok 2000 karakter
closedTitlestringZorunlu
En çok 200 karakter
closedMessagestringZorunlu
En çok 2000 karakter
footerstringZorunlu
null olabilirEn çok 2000 karakter
styleobjectZorunlu
accentstringZorunlu
Desen^#[0-9a-fA-F]{6}$
backgroundstringZorunlu
Desen^#[0-9a-fA-F]{6}$
surfacestringZorunlu
Desen^#[0-9a-fA-F]{6}$
textstringZorunlu
Desen^#[0-9a-fA-F]{6}$
fontstringZorunlu
Şunlardan biri"system""sans""serif""mono"
radiusstringZorunlu
Şunlardan biri"none""sm""md""lg""full"
widthstringZorunlu
Şunlardan biri"narrow""normal""wide"
layoutstringZorunlu
Şunlardan biri"card""plain"
alignstringZorunlu
Şunlardan biri"left""center"
logoUrlstringZorunlu
null olabilirEn çok 2000 karakterBiçimuri
publishedDocumentobject

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.

null olabilir
fieldsobject[]Zorunlu
1 ile 50 arası öğe
idstringZorunlu
1 ile 64 karakter arası
typestringZorunlu
Şunlardan biri"email""text""textarea""number""phone""url""date""select""radio""checkboxes""checkbox""consent""audiences""hidden""heading""paragraph""divider"
keystringZorunlu
En çok 40 karakterDesen^[a-z][a-z0-9_]{0,39}$
labelstringZorunlu
En çok 300 karakter
placeholderstringZorunlu
null olabilirEn çok 200 karakter
helpstringZorunlu
null olabilirEn çok 1000 karakter
requiredbooleanZorunlu
defaultValuestringZorunlu
null olabilirEn çok 1000 karakter
optionsobject[]Zorunlu
En çok 50 öğe
idstringZorunlu
1 ile 64 karakter arası
labelstringZorunlu
1 ile 300 karakter arası
valuestringZorunlu
1 ile 1000 karakter arası
mapsTostringZorunlu
null olabilirŞunlardan biri"email""firstName""lastName""name"
widthstringZorunlu
Şunlardan biri"full""half"
minLengthintegerZorunlu
null olabilirEn az 0En çok 5000
maxLengthintegerZorunlu
null olabilirEn az 1En çok 5000
minnumberZorunlu
null olabilirEn az -1000000000000En çok 1000000000000
maxnumberZorunlu
null olabilirEn az -1000000000000En çok 1000000000000
copyobjectZorunlu
titlestringZorunlu
En çok 200 karakter
descriptionstringZorunlu
null olabilirEn çok 2000 karakter
submitLabelstringZorunlu
1 ile 60 karakter arası
successTitlestringZorunlu
En çok 200 karakter
successMessagestringZorunlu
En çok 2000 karakter
pendingTitlestringZorunlu
En çok 200 karakter
pendingMessagestringZorunlu
En çok 2000 karakter
closedTitlestringZorunlu
En çok 200 karakter
closedMessagestringZorunlu
En çok 2000 karakter
footerstringZorunlu
null olabilirEn çok 2000 karakter
styleobjectZorunlu
accentstringZorunlu
Desen^#[0-9a-fA-F]{6}$
backgroundstringZorunlu
Desen^#[0-9a-fA-F]{6}$
surfacestringZorunlu
Desen^#[0-9a-fA-F]{6}$
textstringZorunlu
Desen^#[0-9a-fA-F]{6}$
fontstringZorunlu
Şunlardan biri"system""sans""serif""mono"
radiusstringZorunlu
Şunlardan biri"none""sm""md""lg""full"
widthstringZorunlu
Şunlardan biri"narrow""normal""wide"
layoutstringZorunlu
Şunlardan biri"card""plain"
alignstringZorunlu
Şunlardan biri"left""center"
logoUrlstringZorunlu
null olabilirEn çok 2000 karakterBiçimuri
settingsobject

Where sign-ups go and what happens after one.

audienceIdsstring[]Zorunlu
En çok 20 öğe
doubleOptInbooleanZorunlu
senderAddressstringZorunlu
null olabilirEn çok 2000 karakter
confirmSubjectstringZorunlu
1 ile 200 karakter arası
confirmMessagestringZorunlu
En çok 2000 karakter
confirmButtonstringZorunlu
1 ile 60 karakter arası
successActionstringZorunlu
Şunlardan biri"message""redirect"
redirectUrlstringZorunlu
null olabilirEn çok 2000 karakterBiçimuri
notifyAddressesstring[]Zorunlu
En çok 10 öğe
audiencesFormAudience[]

The audiences in audienceIds with their names.

senderIssuestring

Why confirmation emails cannot go out right now, for a form with doubleOptIn on. missing means no senderAddress is set, not_sendable that the address cannot send, not_allowed that the form's maker may not send as it. Null when they can go out, and always null with doubleOptIn off.

null olabilirŞunlardan biri"missing""not_sendable""not_allowed"
senderProblemstring

The same problem in a sentence, or null.

null olabilir

FormAnalyticsobject

objectstring
Şunlardan biri"form_analytics"
formIdstring
sincestring
Biçimdate-time
untilstring
Biçimdate-time
grainstring
Şunlardan biri"minute""hour""day"
offsetMinutesinteger
totalsobject
viewsinteger

Times the hosted page or the embed was opened while the form was live.

submissionsinteger

Every submission stored, waiting or added.

addedinteger

Submissions whose person is in the audiences.

pendinginteger

Submissions still waiting for the person to confirm their address.

lastSubmittedAtstring
null olabilirBiçimdate-time
conversionnumber

Submissions divided by views over the window, at most 1. Null with no views.

null olabilir
seriesFormAnalyticsPoint[]

Sparse: a bucket with nothing in it is left out.

FormAnalyticsPointobject

bucketstring

YYYY-MM-DD for a day, YYYY-MM-DDTHH for an hour, YYYY-MM-DDTHH:MM for a minute.

viewsinteger
submissionsinteger
addedinteger

People who joined the audiences in the bucket, dated when they confirmed.

FormAnswerobject

fieldIdstring
keystring

The field key the value was posted under.

labelstring

The field label when the person signed up.

typestring
Şunlardan biri"email""text""textarea""number""phone""url""date""select""radio""checkboxes""checkbox""consent""audiences""hidden""heading""paragraph""divider"
valuestring | string[] | boolean

Text for most fields, a list for multiple choice, true or false for a checkbox.

displaystring

The value as a person reads it, option labels included.

FormAudienceobject

idstring
namestring
builtinboolean

True 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[]Zorunlu
1 ile 50 arası öğe
idstringZorunlu
1 ile 64 karakter arası
typestringZorunlu
Şunlardan biri"email""text""textarea""number""phone""url""date""select""radio""checkboxes""checkbox""consent""audiences""hidden""heading""paragraph""divider"
keystringZorunlu
En çok 40 karakterDesen^[a-z][a-z0-9_]{0,39}$
labelstringZorunlu
En çok 300 karakter
placeholderstringZorunlu
null olabilirEn çok 200 karakter
helpstringZorunlu
null olabilirEn çok 1000 karakter
requiredbooleanZorunlu
defaultValuestringZorunlu
null olabilirEn çok 1000 karakter
optionsobject[]Zorunlu
En çok 50 öğe
idstringZorunlu
1 ile 64 karakter arası
labelstringZorunlu
1 ile 300 karakter arası
valuestringZorunlu
1 ile 1000 karakter arası
mapsTostringZorunlu
null olabilirŞunlardan biri"email""firstName""lastName""name"
widthstringZorunlu
Şunlardan biri"full""half"
minLengthintegerZorunlu
null olabilirEn az 0En çok 5000
maxLengthintegerZorunlu
null olabilirEn az 1En çok 5000
minnumberZorunlu
null olabilirEn az -1000000000000En çok 1000000000000
maxnumberZorunlu
null olabilirEn az -1000000000000En çok 1000000000000
copyobjectZorunlu
titlestringZorunlu
En çok 200 karakter
descriptionstringZorunlu
null olabilirEn çok 2000 karakter
submitLabelstringZorunlu
1 ile 60 karakter arası
successTitlestringZorunlu
En çok 200 karakter
successMessagestringZorunlu
En çok 2000 karakter
pendingTitlestringZorunlu
En çok 200 karakter
pendingMessagestringZorunlu
En çok 2000 karakter
closedTitlestringZorunlu
En çok 200 karakter
closedMessagestringZorunlu
En çok 2000 karakter
footerstringZorunlu
null olabilirEn çok 2000 karakter
styleobjectZorunlu
accentstringZorunlu
Desen^#[0-9a-fA-F]{6}$
backgroundstringZorunlu
Desen^#[0-9a-fA-F]{6}$
surfacestringZorunlu
Desen^#[0-9a-fA-F]{6}$
textstringZorunlu
Desen^#[0-9a-fA-F]{6}$
fontstringZorunlu
Şunlardan biri"system""sans""serif""mono"
radiusstringZorunlu
Şunlardan biri"none""sm""md""lg""full"
widthstringZorunlu
Şunlardan biri"narrow""normal""wide"
layoutstringZorunlu
Şunlardan biri"card""plain"
alignstringZorunlu
Şunlardan biri"left""center"
logoUrlstringZorunlu
null olabilirEn çok 2000 karakterBiçimuri

FormListobject

objectstring
Şunlardan biri"list"
dataFormSummary[]
hasMoreboolean

True when another page follows. Pass nextCursor back as cursor to read it.

nextCursorstring

An opaque cursor for the next page, or null on the last page. Pass it back unchanged.

null olabilir

FormStarterobject

objectstring
Şunlardan biri"form_starter"
slugstring
Şunlardan biri"blank""newsletter""waitlist""event""early-access""contact"
namestring
descriptionstring

FormStarterDetailobject

objectstring
Şunlardan biri"form_starter"
slugstring
Şunlardan biri"blank""newsletter""waitlist""event""early-access""contact"
namestring
descriptionstring
documentFormDocument

FormStarterListobject

objectstring
Şunlardan biri"list"
dataFormStarter[]

FormStatsobject

viewsinteger

Times the hosted page or the embed was opened while the form was live.

submissionsinteger

Every submission stored, waiting or added.

addedinteger

Submissions whose person is in the audiences.

pendinginteger

Submissions still waiting for the person to confirm their address.

lastSubmittedAtstring
null olabilirBiçimdate-time

FormSubmissionobject

objectstring
Şunlardan biri"form_submission"
idstring

The durable handle, fsb_ plus 24 hex.

formIdstring
emailstring

The address the person signed up with, lower cased.

statusstring

added once the person is a contact in the audiences. pending while a double opt-in form waits for them to confirm.

Şunlardan biri"pending""added"
expiredboolean

True for a pending submission 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[]
sourceUrlstring

The page the form was filled in on, its origin and path only and at most 500 characters, when it was known.

null olabilir
confirmedAtstring

When the person joined the audiences. Null while pending.

null olabilirBiçimdate-time
createdAtstring
Biçimdate-time

FormSubmissionBatchobject

objectstring
Şunlardan biri"form_submission_batch"
formIdstring
deletedinteger

How many submissions were deleted.

FormSubmissionListobject

objectstring
Şunlardan biri"list"
dataFormSubmission[]
hasMoreboolean
nextCursorstring
null olabilir
formIdstring

FormSubscriptionobject

objectstring
Şunlardan biri"form_subscription"
formIdstring
outcomestring

added when the person is in the audiences now. pending on 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.

Şunlardan biri"added""pending"
redirectUrlstring

Where the form sends people after a sign-up, when it is set to redirect.

null olabilir

FormSummaryobject

objectstring
Şunlardan biri"form"
idstring

The durable handle, frm_ plus 24 hex.

namestring

What the workspace calls the form. Visitors never see it.

descriptionstring
null olabilir
statusstring

draft until the first publish, then live while it takes sign-ups and paused while it does not. A form never goes back to draft.

Şunlardan biri"draft""live""paused"
urlstring

The hosted page that shows the published form. Share it as a link, or add ?embed=1 for the frame the embed script loads.

subscribeUrlstring

Where 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.

doubleOptInboolean

Whether a sign-up waits for the person to confirm their address by email.

hasUnpublishedChangesboolean

True when the draft document differs from what the live form shows. Always false before the first publish.

statsFormStats
publishedAtstring
null olabilirBiçimdate-time
createdAtstring
Biçimdate-time
updatedAtstring

Send it back as expectedUpdatedAt on PATCH /forms/{id} to refuse a save that would overwrite someone else's.

Biçimdate-time

Gelen kutunuz,
kendi kurallarınızla.

Postayı açBaşla
Ürünler
KurumsalGeliştiricilerYapay zekâ ve ajanlarBireysel
OpenEmail
FiyatlandırmaÖzelliklerGeliştirici özellikleriAjan özellikleriİndirKarşılaştırHakkımızdaİletişimGizlilik PolitikasıHizmet Şartları
Kaynaklar
BelgelerAPI referansıTypeScript SDKKomut satırıMCP sunucusuE-posta şablonlarıYapay zekâ şablon oluşturucuKullanım alanlarıDurum
Araçlar
Teslim edilebilirlik denetleyicisiBIMI logo denetleyicisiGeçici e-posta adresiDMARC kaydı oluşturucuE-posta maliyet hesaplayıcı
© 2026 OpenEmail. Tüm hakları saklıdır.