API

양식

이 그룹의 모든 작업: 받는 값, 반환하는 값, 응답할 수 있는 오류.

작업

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

forms:read읽기

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.

쿼리 매개변수

limitinteger: Rows per page, 1 to 100.
1 이상100 이하기본값25
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.

반환값

200FormList

A page of forms.

오류

모든 작업이 반환할 수 있는 오류400401403404422500오류 목록

다른 사용처

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

POST`/forms`

Create a form

forms:write데이터 변경

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.

요청 본문

namestring필수

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

1~120자

descriptionstring

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

null 가능최대 500자

starterstring

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

다음 중 하나"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[]필수

1~50개 항목

idstring필수

1~64자

typestring필수

다음 중 하나"email""text""textarea""number""phone""url""date""select""radio""checkboxes""checkbox""consent""audiences""hidden""heading""paragraph""divider"

keystring필수

최대 40자패턴^[a-z][a-z0-9_]{0,39}$

labelstring필수

최대 300자

placeholderstring필수

null 가능최대 200자

helpstring필수

null 가능최대 1000자

requiredboolean필수

defaultValuestring필수

null 가능최대 1000자

optionsobject[]필수

최대 50개 항목

idstring필수: 1~64자
labelstring필수: 1~300자
valuestring필수: 1~1000자

mapsTostring필수

null 가능다음 중 하나"email""firstName""lastName""name"

widthstring필수

다음 중 하나"full""half"

minLengthinteger필수

null 가능0 이상5000 이하

maxLengthinteger필수

null 가능1 이상5000 이하

minnumber필수

null 가능-1000000000000 이상1000000000000 이하

maxnumber필수

null 가능-1000000000000 이상1000000000000 이하

copyobject필수

titlestring필수: 최대 200자
descriptionstring필수: null 가능최대 2000자
submitLabelstring필수: 1~60자
successTitlestring필수: 최대 200자
successMessagestring필수: 최대 2000자
pendingTitlestring필수: 최대 200자
pendingMessagestring필수: 최대 2000자
closedTitlestring필수: 최대 200자
closedMessagestring필수: 최대 2000자
footerstring필수: null 가능최대 2000자

styleobject필수

accentstring필수: 패턴^#[0-9a-fA-F]{6}$
backgroundstring필수: 패턴^#[0-9a-fA-F]{6}$
surfacestring필수: 패턴^#[0-9a-fA-F]{6}$
textstring필수: 패턴^#[0-9a-fA-F]{6}$
fontstring필수: 다음 중 하나"system""sans""serif""mono"
radiusstring필수: 다음 중 하나"none""sm""md""lg""full"
widthstring필수: 다음 중 하나"narrow""normal""wide"
layoutstring필수: 다음 중 하나"card""plain"
alignstring필수: 다음 중 하나"left""center"
logoUrlstring필수: null 가능최대 2000자형식uri

settingsobject

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

audienceIdsstring[]: 최대 20개 항목
doubleOptInboolean
senderAddressstring: null 가능최대 2000자
confirmSubjectstring: 1~200자
confirmMessagestring: 최대 2000자
confirmButtonstring: 1~60자
successActionstring: 다음 중 하나"message""redirect"
redirectUrlstring: null 가능최대 2000자형식uri
notifyAddressesstring[]: 최대 10개 항목

publishboolean

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

반환값

201Form

Created.

오류

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.

모든 작업이 반환할 수 있는 오류400401403500오류 목록

다른 사용처

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

GET`/forms/starters`

List the form starters

forms:read읽기

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.

반환값

200FormStarterList

Every starter, documents left out.

오류

모든 작업이 반환할 수 있는 오류400401403404422500오류 목록

다른 사용처

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

GET`/forms/starters/{slug}`

Retrieve a form starter

forms:read읽기

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

Requires the forms:read scope.

경로 매개변수

slugstring필수: A slug from GET /forms/starters.
다음 중 하나"blank""newsletter""waitlist""event""early-access""contact"

반환값

200FormStarterDetail

The starter with its document.

오류

404: form_starter_not_found when no starter has that slug.

모든 작업이 반환할 수 있는 오류400401403422500오류 목록

다른 사용처

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

GET`/forms/{id}`

Retrieve a form

forms:read읽기

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.

경로 매개변수

idstring필수: The form id, frm_ plus 24 hex.

반환값

200Form

The form.

오류

404: form_not_found when the id names no form you can reach.

모든 작업이 반환할 수 있는 오류400401403422500오류 목록

다른 사용처

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

PATCH`/forms/{id}`

Update a form

forms:write데이터 변경

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.

경로 매개변수

idstring필수: The form id, frm_ plus 24 hex.

요청 본문

namestring

New name, trimmed, 1 to 120 characters.

1~120자

descriptionstring

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

null 가능최대 500자

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[]필수

1~50개 항목

idstring필수

1~64자

typestring필수

다음 중 하나"email""text""textarea""number""phone""url""date""select""radio""checkboxes""checkbox""consent""audiences""hidden""heading""paragraph""divider"

keystring필수

최대 40자패턴^[a-z][a-z0-9_]{0,39}$

labelstring필수

최대 300자

placeholderstring필수

null 가능최대 200자

helpstring필수

null 가능최대 1000자

requiredboolean필수

defaultValuestring필수

null 가능최대 1000자

optionsobject[]필수

최대 50개 항목

idstring필수: 1~64자
labelstring필수: 1~300자
valuestring필수: 1~1000자

mapsTostring필수

null 가능다음 중 하나"email""firstName""lastName""name"

widthstring필수

다음 중 하나"full""half"

minLengthinteger필수

null 가능0 이상5000 이하

maxLengthinteger필수

null 가능1 이상5000 이하

minnumber필수

null 가능-1000000000000 이상1000000000000 이하

maxnumber필수

null 가능-1000000000000 이상1000000000000 이하

copyobject필수

titlestring필수: 최대 200자
descriptionstring필수: null 가능최대 2000자
submitLabelstring필수: 1~60자
successTitlestring필수: 최대 200자
successMessagestring필수: 최대 2000자
pendingTitlestring필수: 최대 200자
pendingMessagestring필수: 최대 2000자
closedTitlestring필수: 최대 200자
closedMessagestring필수: 최대 2000자
footerstring필수: null 가능최대 2000자

styleobject필수

accentstring필수: 패턴^#[0-9a-fA-F]{6}$
backgroundstring필수: 패턴^#[0-9a-fA-F]{6}$
surfacestring필수: 패턴^#[0-9a-fA-F]{6}$
textstring필수: 패턴^#[0-9a-fA-F]{6}$
fontstring필수: 다음 중 하나"system""sans""serif""mono"
radiusstring필수: 다음 중 하나"none""sm""md""lg""full"
widthstring필수: 다음 중 하나"narrow""normal""wide"
layoutstring필수: 다음 중 하나"card""plain"
alignstring필수: 다음 중 하나"left""center"
logoUrlstring필수: null 가능최대 2000자형식uri

settingsobject

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

audienceIdsstring[]: 최대 20개 항목
doubleOptInboolean
senderAddressstring: null 가능최대 2000자
confirmSubjectstring: 1~200자
confirmMessagestring: 최대 2000자
confirmButtonstring: 1~60자
successActionstring: 다음 중 하나"message""redirect"
redirectUrlstring: null 가능최대 2000자형식uri
notifyAddressesstring[]: 최대 10개 항목

expectedUpdatedAtstring

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

형식date-time

반환값

200Form

Saved.

오류

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.

모든 작업이 반환할 수 있는 오류400401403500오류 목록

다른 사용처

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

DELETE`/forms/{id}`

Delete a form

forms:write삭제

인증 코드 요청

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.

경로 매개변수

idstring필수: The form id, frm_ plus 24 hex.

반환값

200DeletedForm

Deleted.

오류

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.

모든 작업이 반환할 수 있는 오류400401422500오류 목록

다른 사용처

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

POST`/forms/{id}/publish`

Publish a form

forms:write데이터 변경

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.

경로 매개변수

idstring필수: The form id, frm_ plus 24 hex.

반환값

200Form

Published.

오류

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.

모든 작업이 반환할 수 있는 오류400401403500오류 목록

다른 사용처

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

POST`/forms/{id}/pause`

Pause a form

forms:write데이터 변경

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.

경로 매개변수

idstring필수: The form id, frm_ plus 24 hex.

반환값

200Form

Paused.

오류

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.

모든 작업이 반환할 수 있는 오류400401403422500오류 목록

다른 사용처

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

POST`/forms/{id}/resume`

Resume a form

forms:write데이터 변경

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.

경로 매개변수

idstring필수: The form id, frm_ plus 24 hex.

반환값

200Form

Live.

오류

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.

모든 작업이 반환할 수 있는 오류400401403500오류 목록

다른 사용처

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

POST`/forms/{id}/duplicate`

Duplicate a form

forms:write데이터 변경

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.

경로 매개변수

idstring필수: The form id, frm_ plus 24 hex.

반환값

201Form

The copy.

오류

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.

모든 작업이 반환할 수 있는 오류400401403500오류 목록

다른 사용처

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

GET`/forms/{id}/analytics`

Form analytics

forms:read읽기

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.

경로 매개변수

idstring필수: The form id, frm_ plus 24 hex.

쿼리 매개변수

daysinteger: How far back to look. The oldest bucket is a whole one and the newest is partial.
1 이상1095 이하기본값30
minutesinteger: The window in minutes, which wins over days when both are sent.
1 이상1576800 이하
grainstring: How wide one bucket is. Views are kept per hour.
다음 중 하나"minute""hour""day"기본값"day"
offsetMinutesinteger: Minutes east of UTC to cut the buckets in, so a day breaks where the reader's day does.
-840 이상840 이하기본값0

반환값

200FormAnalytics

The window, the totals and the series.

오류

404: form_not_found when the id names no form you can reach.

모든 작업이 반환할 수 있는 오류400401403422500오류 목록

다른 사용처

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

GET`/forms/{id}/submissions`

List submissions

forms:read읽기

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.

경로 매개변수

idstring필수: The form id, frm_ plus 24 hex.

쿼리 매개변수

limitinteger: Rows per page, 1 to 100.
1 이상100 이하기본값25
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.
최대 200자
statusstring: Only pending or only added submissions.
다음 중 하나"pending""added"

반환값

200FormSubmissionList

A page of submissions.

오류

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.

모든 작업이 반환할 수 있는 오류401403422500오류 목록

다른 사용처

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

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

Delete submissions

forms:write삭제

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.

경로 매개변수

idstring필수: The form id, frm_ plus 24 hex.

요청 본문

idsstring[]필수: Submission ids of this form. An id that names nothing is skipped.
1~200개 항목

반환값

200FormSubmissionBatch

Deleted.

오류

404: form_not_found when the id names no form you can reach.

모든 작업이 반환할 수 있는 오류400401403422500오류 목록

다른 사용처

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

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

Retrieve a submission

forms:read읽기

One submission with every answer.

Requires the forms:read scope.

경로 매개변수

idstring필수: The form id, frm_ plus 24 hex.
submissionIdstring필수: The submission id, fsb_ plus 24 hex.

반환값

200FormSubmission

The submission.

오류

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

모든 작업이 반환할 수 있는 오류400401403422500오류 목록

다른 사용처

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

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

Delete a submission

forms:write삭제

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.

경로 매개변수

idstring필수: The form id, frm_ plus 24 hex.
submissionIdstring필수: The submission id, fsb_ plus 24 hex.

반환값

200DeletedFormSubmission

Deleted.

오류

404: form_not_found or form_submission_not_found.

모든 작업이 반환할 수 있는 오류400401403422500오류 목록

다른 사용처

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

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

Approve a submission

forms:writecontacts:write데이터 변경

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.

경로 매개변수

idstring필수: The form id, frm_ plus 24 hex.
submissionIdstring필수: The submission id, fsb_ plus 24 hex.

반환값

200FormSubmission

The submission, now added.

오류

404: form_not_found or form_submission_not_found.

모든 작업이 반환할 수 있는 오류400401403422500오류 목록

다른 사용처

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

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

Resend a confirmation

forms:writeemails:send메일 발송

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.

경로 매개변수

idstring필수: The form id, frm_ plus 24 hex.
submissionIdstring필수: The submission id, fsb_ plus 24 hex.

반환값

200object

The submission.

objectstring: 다음 중 하나"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.
다음 중 하나"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 가능
confirmedAtstring: When the person joined the audiences. Null while pending.
null 가능형식date-time
createdAtstring: 형식date-time
confirmationSentboolean: Whether an email went out on this call.

오류

404: form_not_found or form_submission_not_found.
422: form_sender_refused when confirmations cannot go out from the form's address.

모든 작업이 반환할 수 있는 오류400401403500오류 목록

다른 사용처

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

POST`/forms/design`

Design a form from a brief

forms:write데이터 변경

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.

요청 본문

briefstring필수: Everything the form must ask and say, up to 4,000 characters.
1~4000자
namestring: A short name for the form, up to 120 characters. Left out, the designer names it.
1~120자

반환값

201object

The new form, a draft.

objectstring

다음 중 하나"form"

idstring

The durable handle, frm_ plus 24 hex.

namestring

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

descriptionstring

null 가능

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.

다음 중 하나"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 가능형식date-time

createdAtstring

형식date-time

updatedAtstring

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

형식date-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[]필수

1~50개 항목

idstring필수

1~64자

typestring필수

다음 중 하나"email""text""textarea""number""phone""url""date""select""radio""checkboxes""checkbox""consent""audiences""hidden""heading""paragraph""divider"

keystring필수

최대 40자패턴^[a-z][a-z0-9_]{0,39}$

labelstring필수

최대 300자

placeholderstring필수

null 가능최대 200자

helpstring필수

null 가능최대 1000자

requiredboolean필수

defaultValuestring필수

null 가능최대 1000자

optionsobject[]필수

최대 50개 항목

idstring필수: 1~64자
labelstring필수: 1~300자
valuestring필수: 1~1000자

mapsTostring필수

null 가능다음 중 하나"email""firstName""lastName""name"

widthstring필수

다음 중 하나"full""half"

minLengthinteger필수

null 가능0 이상5000 이하

maxLengthinteger필수

null 가능1 이상5000 이하

minnumber필수

null 가능-1000000000000 이상1000000000000 이하

maxnumber필수

null 가능-1000000000000 이상1000000000000 이하

copyobject필수

titlestring필수: 최대 200자
descriptionstring필수: null 가능최대 2000자
submitLabelstring필수: 1~60자
successTitlestring필수: 최대 200자
successMessagestring필수: 최대 2000자
pendingTitlestring필수: 최대 200자
pendingMessagestring필수: 최대 2000자
closedTitlestring필수: 최대 200자
closedMessagestring필수: 최대 2000자
footerstring필수: null 가능최대 2000자

styleobject필수

accentstring필수: 패턴^#[0-9a-fA-F]{6}$
backgroundstring필수: 패턴^#[0-9a-fA-F]{6}$
surfacestring필수: 패턴^#[0-9a-fA-F]{6}$
textstring필수: 패턴^#[0-9a-fA-F]{6}$
fontstring필수: 다음 중 하나"system""sans""serif""mono"
radiusstring필수: 다음 중 하나"none""sm""md""lg""full"
widthstring필수: 다음 중 하나"narrow""normal""wide"
layoutstring필수: 다음 중 하나"card""plain"
alignstring필수: 다음 중 하나"left""center"
logoUrlstring필수: null 가능최대 2000자형식uri

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 가능

fieldsobject[]필수

1~50개 항목

idstring필수

1~64자

typestring필수

다음 중 하나"email""text""textarea""number""phone""url""date""select""radio""checkboxes""checkbox""consent""audiences""hidden""heading""paragraph""divider"

keystring필수

최대 40자패턴^[a-z][a-z0-9_]{0,39}$

labelstring필수

최대 300자

placeholderstring필수

null 가능최대 200자

helpstring필수

null 가능최대 1000자

requiredboolean필수

defaultValuestring필수

null 가능최대 1000자

optionsobject[]필수

최대 50개 항목

idstring필수: 1~64자
labelstring필수: 1~300자
valuestring필수: 1~1000자

mapsTostring필수

null 가능다음 중 하나"email""firstName""lastName""name"

widthstring필수

다음 중 하나"full""half"

minLengthinteger필수

null 가능0 이상5000 이하

maxLengthinteger필수

null 가능1 이상5000 이하

minnumber필수

null 가능-1000000000000 이상1000000000000 이하

maxnumber필수

null 가능-1000000000000 이상1000000000000 이하

copyobject필수

titlestring필수: 최대 200자
descriptionstring필수: null 가능최대 2000자
submitLabelstring필수: 1~60자
successTitlestring필수: 최대 200자
successMessagestring필수: 최대 2000자
pendingTitlestring필수: 최대 200자
pendingMessagestring필수: 최대 2000자
closedTitlestring필수: 최대 200자
closedMessagestring필수: 최대 2000자
footerstring필수: null 가능최대 2000자

styleobject필수

accentstring필수: 패턴^#[0-9a-fA-F]{6}$
backgroundstring필수: 패턴^#[0-9a-fA-F]{6}$
surfacestring필수: 패턴^#[0-9a-fA-F]{6}$
textstring필수: 패턴^#[0-9a-fA-F]{6}$
fontstring필수: 다음 중 하나"system""sans""serif""mono"
radiusstring필수: 다음 중 하나"none""sm""md""lg""full"
widthstring필수: 다음 중 하나"narrow""normal""wide"
layoutstring필수: 다음 중 하나"card""plain"
alignstring필수: 다음 중 하나"left""center"
logoUrlstring필수: null 가능최대 2000자형식uri

settingsobject

Where sign-ups go and what happens after one.

audienceIdsstring[]필수: 최대 20개 항목
doubleOptInboolean필수
senderAddressstring필수: null 가능최대 2000자
confirmSubjectstring필수: 1~200자
confirmMessagestring필수: 최대 2000자
confirmButtonstring필수: 1~60자
successActionstring필수: 다음 중 하나"message""redirect"
redirectUrlstring필수: null 가능최대 2000자형식uri
notifyAddressesstring[]필수: 최대 10개 항목

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 가능다음 중 하나"missing""not_sendable""not_allowed"

senderProblemstring

The same problem in a sentence, or null.

null 가능

designobject

notesstring[]: What the designer adjusted or left out while making the design valid.

오류

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.

모든 작업이 반환할 수 있는 오류400401403404500오류 목록

다른 사용처

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

POST`/forms/{id}/redesign`

Change a form’s design from instructions

forms:write데이터 변경

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.

경로 매개변수

idstring필수: Form id such as frm_8d2f6a1c9b3e47d0a5f1c2e9.

요청 본문

instructionsstring필수: What to change, with every detail, up to 4,000 characters.
1~4000자
expectedUpdatedAtstring: The updatedAt you read, as it came. When the form was saved since, nothing is written and the answer is 409 version_conflict.
형식date-time

반환값

200object

The form, with the change in its draft.

objectstring

다음 중 하나"form"

idstring

The durable handle, frm_ plus 24 hex.

namestring

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

descriptionstring

null 가능

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.

다음 중 하나"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 가능형식date-time

createdAtstring

형식date-time

updatedAtstring

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

형식date-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[]필수

1~50개 항목

idstring필수

1~64자

typestring필수

다음 중 하나"email""text""textarea""number""phone""url""date""select""radio""checkboxes""checkbox""consent""audiences""hidden""heading""paragraph""divider"

keystring필수

최대 40자패턴^[a-z][a-z0-9_]{0,39}$

labelstring필수

최대 300자

placeholderstring필수

null 가능최대 200자

helpstring필수

null 가능최대 1000자

requiredboolean필수

defaultValuestring필수

null 가능최대 1000자

optionsobject[]필수

최대 50개 항목

idstring필수: 1~64자
labelstring필수: 1~300자
valuestring필수: 1~1000자

mapsTostring필수

null 가능다음 중 하나"email""firstName""lastName""name"

widthstring필수

다음 중 하나"full""half"

minLengthinteger필수

null 가능0 이상5000 이하

maxLengthinteger필수

null 가능1 이상5000 이하

minnumber필수

null 가능-1000000000000 이상1000000000000 이하

maxnumber필수

null 가능-1000000000000 이상1000000000000 이하

copyobject필수

titlestring필수: 최대 200자
descriptionstring필수: null 가능최대 2000자
submitLabelstring필수: 1~60자
successTitlestring필수: 최대 200자
successMessagestring필수: 최대 2000자
pendingTitlestring필수: 최대 200자
pendingMessagestring필수: 최대 2000자
closedTitlestring필수: 최대 200자
closedMessagestring필수: 최대 2000자
footerstring필수: null 가능최대 2000자

styleobject필수

accentstring필수: 패턴^#[0-9a-fA-F]{6}$
backgroundstring필수: 패턴^#[0-9a-fA-F]{6}$
surfacestring필수: 패턴^#[0-9a-fA-F]{6}$
textstring필수: 패턴^#[0-9a-fA-F]{6}$
fontstring필수: 다음 중 하나"system""sans""serif""mono"
radiusstring필수: 다음 중 하나"none""sm""md""lg""full"
widthstring필수: 다음 중 하나"narrow""normal""wide"
layoutstring필수: 다음 중 하나"card""plain"
alignstring필수: 다음 중 하나"left""center"
logoUrlstring필수: null 가능최대 2000자형식uri

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 가능

fieldsobject[]필수

1~50개 항목

idstring필수

1~64자

typestring필수

다음 중 하나"email""text""textarea""number""phone""url""date""select""radio""checkboxes""checkbox""consent""audiences""hidden""heading""paragraph""divider"

keystring필수

최대 40자패턴^[a-z][a-z0-9_]{0,39}$

labelstring필수

최대 300자

placeholderstring필수

null 가능최대 200자

helpstring필수

null 가능최대 1000자

requiredboolean필수

defaultValuestring필수

null 가능최대 1000자

optionsobject[]필수

최대 50개 항목

idstring필수: 1~64자
labelstring필수: 1~300자
valuestring필수: 1~1000자

mapsTostring필수

null 가능다음 중 하나"email""firstName""lastName""name"

widthstring필수

다음 중 하나"full""half"

minLengthinteger필수

null 가능0 이상5000 이하

maxLengthinteger필수

null 가능1 이상5000 이하

minnumber필수

null 가능-1000000000000 이상1000000000000 이하

maxnumber필수

null 가능-1000000000000 이상1000000000000 이하

copyobject필수

titlestring필수: 최대 200자
descriptionstring필수: null 가능최대 2000자
submitLabelstring필수: 1~60자
successTitlestring필수: 최대 200자
successMessagestring필수: 최대 2000자
pendingTitlestring필수: 최대 200자
pendingMessagestring필수: 최대 2000자
closedTitlestring필수: 최대 200자
closedMessagestring필수: 최대 2000자
footerstring필수: null 가능최대 2000자

styleobject필수

accentstring필수: 패턴^#[0-9a-fA-F]{6}$
backgroundstring필수: 패턴^#[0-9a-fA-F]{6}$
surfacestring필수: 패턴^#[0-9a-fA-F]{6}$
textstring필수: 패턴^#[0-9a-fA-F]{6}$
fontstring필수: 다음 중 하나"system""sans""serif""mono"
radiusstring필수: 다음 중 하나"none""sm""md""lg""full"
widthstring필수: 다음 중 하나"narrow""normal""wide"
layoutstring필수: 다음 중 하나"card""plain"
alignstring필수: 다음 중 하나"left""center"
logoUrlstring필수: null 가능최대 2000자형식uri

settingsobject

Where sign-ups go and what happens after one.

audienceIdsstring[]필수: 최대 20개 항목
doubleOptInboolean필수
senderAddressstring필수: null 가능최대 2000자
confirmSubjectstring필수: 1~200자
confirmMessagestring필수: 최대 2000자
confirmButtonstring필수: 1~60자
successActionstring필수: 다음 중 하나"message""redirect"
redirectUrlstring필수: null 가능최대 2000자형식uri
notifyAddressesstring[]필수: 최대 10개 항목

audiencesFormAudience[]

The audiences in audienceIds with their names.

senderIssuestring

null 가능다음 중 하나"missing""not_sendable""not_allowed"

senderProblemstring

The same problem in a sentence, or null.

null 가능

designobject

notesstring[]: What the designer adjusted or left out while making the design valid.

오류

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.

모든 작업이 반환할 수 있는 오류400401403404500오류 목록

다른 사용처

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

객체

`DeletedForm`object

objectstring: 다음 중 하나"form"
idstring
deletedboolean: 다음 중 하나true

`DeletedFormSubmission`object

objectstring: 다음 중 하나"form_submission"
idstring
formIdstring
deletedboolean: 다음 중 하나true

`Form`object

objectstring

다음 중 하나"form"

idstring

The durable handle, frm_ plus 24 hex.

namestring

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

descriptionstring

null 가능

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.

다음 중 하나"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 가능형식date-time

createdAtstring

형식date-time

updatedAtstring

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

형식date-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[]필수

1~50개 항목

idstring필수

1~64자

typestring필수

다음 중 하나"email""text""textarea""number""phone""url""date""select""radio""checkboxes""checkbox""consent""audiences""hidden""heading""paragraph""divider"

keystring필수

최대 40자패턴^[a-z][a-z0-9_]{0,39}$

labelstring필수

최대 300자

placeholderstring필수

null 가능최대 200자

helpstring필수

null 가능최대 1000자

requiredboolean필수

defaultValuestring필수

null 가능최대 1000자

optionsobject[]필수

최대 50개 항목

idstring필수: 1~64자
labelstring필수: 1~300자
valuestring필수: 1~1000자

mapsTostring필수

null 가능다음 중 하나"email""firstName""lastName""name"

widthstring필수

다음 중 하나"full""half"

minLengthinteger필수

null 가능0 이상5000 이하

maxLengthinteger필수

null 가능1 이상5000 이하

minnumber필수

null 가능-1000000000000 이상1000000000000 이하

maxnumber필수

null 가능-1000000000000 이상1000000000000 이하

copyobject필수

titlestring필수: 최대 200자
descriptionstring필수: null 가능최대 2000자
submitLabelstring필수: 1~60자
successTitlestring필수: 최대 200자
successMessagestring필수: 최대 2000자
pendingTitlestring필수: 최대 200자
pendingMessagestring필수: 최대 2000자
closedTitlestring필수: 최대 200자
closedMessagestring필수: 최대 2000자
footerstring필수: null 가능최대 2000자

styleobject필수

accentstring필수: 패턴^#[0-9a-fA-F]{6}$
backgroundstring필수: 패턴^#[0-9a-fA-F]{6}$
surfacestring필수: 패턴^#[0-9a-fA-F]{6}$
textstring필수: 패턴^#[0-9a-fA-F]{6}$
fontstring필수: 다음 중 하나"system""sans""serif""mono"
radiusstring필수: 다음 중 하나"none""sm""md""lg""full"
widthstring필수: 다음 중 하나"narrow""normal""wide"
layoutstring필수: 다음 중 하나"card""plain"
alignstring필수: 다음 중 하나"left""center"
logoUrlstring필수: null 가능최대 2000자형식uri

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 가능

fieldsobject[]필수

1~50개 항목

idstring필수

1~64자

typestring필수

다음 중 하나"email""text""textarea""number""phone""url""date""select""radio""checkboxes""checkbox""consent""audiences""hidden""heading""paragraph""divider"

keystring필수

최대 40자패턴^[a-z][a-z0-9_]{0,39}$

labelstring필수

최대 300자

placeholderstring필수

null 가능최대 200자

helpstring필수

null 가능최대 1000자

requiredboolean필수

defaultValuestring필수

null 가능최대 1000자

optionsobject[]필수

최대 50개 항목

idstring필수: 1~64자
labelstring필수: 1~300자
valuestring필수: 1~1000자

mapsTostring필수

null 가능다음 중 하나"email""firstName""lastName""name"

widthstring필수

다음 중 하나"full""half"

minLengthinteger필수

null 가능0 이상5000 이하

maxLengthinteger필수

null 가능1 이상5000 이하

minnumber필수

null 가능-1000000000000 이상1000000000000 이하

maxnumber필수

null 가능-1000000000000 이상1000000000000 이하

copyobject필수

titlestring필수: 최대 200자
descriptionstring필수: null 가능최대 2000자
submitLabelstring필수: 1~60자
successTitlestring필수: 최대 200자
successMessagestring필수: 최대 2000자
pendingTitlestring필수: 최대 200자
pendingMessagestring필수: 최대 2000자
closedTitlestring필수: 최대 200자
closedMessagestring필수: 최대 2000자
footerstring필수: null 가능최대 2000자

styleobject필수

accentstring필수: 패턴^#[0-9a-fA-F]{6}$
backgroundstring필수: 패턴^#[0-9a-fA-F]{6}$
surfacestring필수: 패턴^#[0-9a-fA-F]{6}$
textstring필수: 패턴^#[0-9a-fA-F]{6}$
fontstring필수: 다음 중 하나"system""sans""serif""mono"
radiusstring필수: 다음 중 하나"none""sm""md""lg""full"
widthstring필수: 다음 중 하나"narrow""normal""wide"
layoutstring필수: 다음 중 하나"card""plain"
alignstring필수: 다음 중 하나"left""center"
logoUrlstring필수: null 가능최대 2000자형식uri

settingsobject

Where sign-ups go and what happens after one.

audienceIdsstring[]필수: 최대 20개 항목
doubleOptInboolean필수
senderAddressstring필수: null 가능최대 2000자
confirmSubjectstring필수: 1~200자
confirmMessagestring필수: 최대 2000자
confirmButtonstring필수: 1~60자
successActionstring필수: 다음 중 하나"message""redirect"
redirectUrlstring필수: null 가능최대 2000자형식uri
notifyAddressesstring[]필수: 최대 10개 항목

audiencesFormAudience[]

The audiences in audienceIds with their names.

senderIssuestring

null 가능다음 중 하나"missing""not_sendable""not_allowed"

senderProblemstring

The same problem in a sentence, or null.

null 가능

`FormAnalytics`object

objectstring

다음 중 하나"form_analytics"

formIdstring

sincestring

형식date-time

untilstring

형식date-time

grainstring

다음 중 하나"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 가능형식date-time
conversionnumber: Submissions divided by views over the window, at most 1. Null with no views.
null 가능

seriesFormAnalyticsPoint[]

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

`FormAnalyticsPoint`object

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.

`FormAnswer`object

fieldIdstring
keystring: The field key the value was posted under.
labelstring: The field label when the person signed up.
typestring: 다음 중 하나"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.

`FormAudience`object

idstring
namestring
builtinboolean: True for the default audience every contact joins.

`FormDocument`object

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[]필수

1~50개 항목

idstring필수

1~64자

typestring필수

다음 중 하나"email""text""textarea""number""phone""url""date""select""radio""checkboxes""checkbox""consent""audiences""hidden""heading""paragraph""divider"

keystring필수

최대 40자패턴^[a-z][a-z0-9_]{0,39}$

labelstring필수

최대 300자

placeholderstring필수

null 가능최대 200자

helpstring필수

null 가능최대 1000자

requiredboolean필수

defaultValuestring필수

null 가능최대 1000자

optionsobject[]필수

최대 50개 항목

idstring필수: 1~64자
labelstring필수: 1~300자
valuestring필수: 1~1000자

mapsTostring필수

null 가능다음 중 하나"email""firstName""lastName""name"

widthstring필수

다음 중 하나"full""half"

minLengthinteger필수

null 가능0 이상5000 이하

maxLengthinteger필수

null 가능1 이상5000 이하

minnumber필수

null 가능-1000000000000 이상1000000000000 이하

maxnumber필수

null 가능-1000000000000 이상1000000000000 이하

copyobject필수

titlestring필수: 최대 200자
descriptionstring필수: null 가능최대 2000자
submitLabelstring필수: 1~60자
successTitlestring필수: 최대 200자
successMessagestring필수: 최대 2000자
pendingTitlestring필수: 최대 200자
pendingMessagestring필수: 최대 2000자
closedTitlestring필수: 최대 200자
closedMessagestring필수: 최대 2000자
footerstring필수: null 가능최대 2000자

styleobject필수

accentstring필수: 패턴^#[0-9a-fA-F]{6}$
backgroundstring필수: 패턴^#[0-9a-fA-F]{6}$
surfacestring필수: 패턴^#[0-9a-fA-F]{6}$
textstring필수: 패턴^#[0-9a-fA-F]{6}$
fontstring필수: 다음 중 하나"system""sans""serif""mono"
radiusstring필수: 다음 중 하나"none""sm""md""lg""full"
widthstring필수: 다음 중 하나"narrow""normal""wide"
layoutstring필수: 다음 중 하나"card""plain"
alignstring필수: 다음 중 하나"left""center"
logoUrlstring필수: null 가능최대 2000자형식uri

`FormList`object

objectstring: 다음 중 하나"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 가능

`FormStarter`object

objectstring: 다음 중 하나"form_starter"
slugstring: 다음 중 하나"blank""newsletter""waitlist""event""early-access""contact"
namestring
descriptionstring

`FormStarterDetail`object

objectstring: 다음 중 하나"form_starter"
slugstring: 다음 중 하나"blank""newsletter""waitlist""event""early-access""contact"
namestring
descriptionstring
documentFormDocument

`FormStarterList`object

objectstring: 다음 중 하나"list"
dataFormStarter[]

`FormStats`object

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 가능형식date-time

`FormSubmission`object

objectstring: 다음 중 하나"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.
다음 중 하나"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 가능
confirmedAtstring: When the person joined the audiences. Null while pending.
null 가능형식date-time
createdAtstring: 형식date-time

`FormSubmissionBatch`object

objectstring: 다음 중 하나"form_submission_batch"
formIdstring
deletedinteger: How many submissions were deleted.

`FormSubmissionList`object

objectstring: 다음 중 하나"list"
dataFormSubmission[]
hasMoreboolean
nextCursorstring: null 가능
formIdstring

`FormSubscription`object

objectstring: 다음 중 하나"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.
다음 중 하나"added""pending"
redirectUrlstring: Where the form sends people after a sign-up, when it is set to redirect.
null 가능

`FormSummary`object

objectstring: 다음 중 하나"form"
idstring: The durable handle, frm_ plus 24 hex.
namestring: What the workspace calls the form. Visitors never see it.
descriptionstring: null 가능
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.
다음 중 하나"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 가능형식date-time
createdAtstring: 형식date-time
updatedAtstring: Send it back as expectedUpdatedAt on PATCH /forms/{id} to refuse a save that would overwrite someone else's.
형식date-time