SDK

openemail.forms

Jede Methode in diesem Namespace: ihre Signatur, ihre Parameter, was sie zurückgibt und ein Beispiel.

Methoden

Forms that add the people who fill them in to your audiences, with an optional confirmation email first: make them from a starter or your own fields, publish, pause and copy them, read their analytics, manage what people sent, and sign someone up without a credential.

`forms.list()`

List one page of the sign-up forms in the workspace

forms:readBlättert durch die Ergebnisse

Signatur

list(options?: FormListOptions): Promise<Page<FormResource>>

Returns one page of the sign-up forms the caller can reach, newest first, without their documents or settings. Paging is keyset: options.limit takes 1 to 100 and defaults to 25, and nextCursor goes back as options.cursor while hasMore is true. listAll and iterate do that walk for you.

Each form carries its status, url, the hosted page that shows it, subscribeUrl, where a plain HTML form posts, audienceIds, doubleOptIn, hasUnpublishedChanges and stats. stats is counted at the moment of the read: views of the hosted page and the embed while the form was live, submissions stored, added, the sign-ups added to the audiences, pending, the ones still to confirm, and lastSubmittedAt.

Read one with get for the draft document, the publishedDocument visitors see and the settings.

Parameter

options.limitnumber: Rows per page, a whole number from 1 to 100. The server defaults to 25.
options.cursorstring: The nextCursor from the previous page, passed back exactly as it came. One the server cannot read is a 400 invalid_cursor.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Rückgabe

Page<FormResource> with items, hasMore and nextCursor. Each item has id, name, description, status, url, subscribeUrl, audienceIds, doubleOptIn, hasUnpublishedChanges, stats, publishedAt, createdAt and updatedAt.

Beispiel

const page = await openemail.forms.list({ limit: 50 }) for (const form of page.items) {    console.log(form.name, form.status, `${form.stats.submissions} sign-ups`)}

Hinweise

An app a member connected lists only the forms that member made, as the console does for them. An API key and an app the owner connected list every form in the workspace.
Read only, so the SDK retries it after a network failure like any other read.

Auch verfügbar über

API: GET /forms
CLI: openemail forms list

`forms.listAll()`

Collect every sign-up form you can reach into one array

forms:readBlättert durch die Ergebnisse

Signatur

listAll(options?: FormListOptions): Promise<Array<FormResource>>

Follows nextCursor from page to page and resolves with every form the caller can reach, newest first, in the shape list returns. limit sets the page size of each request, not the total.

Parameter

options.limitnumber: Page size per request, from 1 to 100, defaulting to 25 on the server.
options.cursorstring: A nextCursor from an earlier page to start after.
options.signalAbortSignal: Cancels the request in flight and rejects the whole walk.
options.apiKeystring: Overrides the client's API key for every page of this walk.

Rückgabe

Array<FormResource> holding every form across all pages.

Beispiel

const forms = await openemail.forms.listAll({ limit: 100 }) const live = forms.filter((form) => form.status === 'live') console.log(`${live.length} of ${forms.length} forms take sign-ups`)

Hinweise

A failure on any page rejects the whole call.

Auch verfügbar über

API: GET /forms

`forms.iterate()`

Stream the sign-up forms you can reach one at a time

forms:readBlättert durch die Ergebnisse

Signatur

iterate(options?: FormListOptions): AsyncGenerator<FormResource, void, undefined>

Returns an async generator that yields forms one by one, newest first, and requests the next page only once the current one is drained. Breaking out of the loop stops the requests.

Parameter

options.limitnumber: Page size per request, from 1 to 100, defaulting to 25 on the server.
options.cursorstring: A nextCursor from an earlier page to start after.
options.signalAbortSignal: Cancels the request in flight and rejects the whole walk.
options.apiKeystring: Overrides the client's API key for every page of this walk.

Rückgabe

AsyncGenerator<FormResource, void, undefined> yielding one form per step.

Beispiel

for await (const form of openemail.forms.iterate()) {    if (form.hasUnpublishedChanges) console.log('unpublished edits:', form.name)}

Hinweise

The generator is lazy, so an abandoned loop costs only the pages you consumed.

Auch verfügbar über

API: GET /forms

`forms.create()`

Create a sign-up form

forms:write

Signatur

create(body: FormCreate, options?: RequestScope): Promise<FormDetailResource>

Makes a draft form and returns it whole, in the shape get returns. Its fields, copy and style come from document when you send one, from the starter named in starter when you do not, and otherwise from a one-field email form. settings changes any of the defaults, which add people to the default audience only, send no confirmation email, show the thank-you message from the copy and notify nobody.

A form takes no sign-ups until it is published. Send publish: true to put it live in the same call, or call publish later. Nothing is created when the document or settings break a rule.

Once it is live, share it with url, point a plain HTML <form method="post"> at subscribeUrl, embed it with the script at /embed/form.js on the OpenEmail web app, or sign people up from your own code with subscribe.

Parameter

body.namestringErforderlich: What the workspace calls the form, trimmed, 1 to 120 characters. Visitors never see it, and it need not be unique.
body.descriptionstring | null: A note for the workspace, at most 500 characters. Visitors never see it.
body.starterFormStarterSlug: Begin from a starter: blank, newsletter, waitlist, event, early-access or contact. Ignored when document is sent.
body.documentFormDocument: The whole form, fields, copy and style, in the shape get and getStarter return. Every field carries all 15 of its keys, with null for the ones it does not use, and a document needs exactly one email field, keyed email and required, and its field keys and ids must be unique. Leave it out to use starter or a one-field email form.
body.settings.audienceIdsArray<string>: The audiences every sign-up joins, at most 20 ids such as aud_9f2c4b7e1a0d63d84c5f2e7b. Every contact is in the default audience as well, so an empty list adds people there only. An id that is not an audience the caller can reach is a 404 audience_not_found.
body.settings.doubleOptInboolean: Email each person a confirmation link and add them only once they open it. Defaults to false. True needs senderAddress.
body.settings.senderAddressstring | null: The workspace address confirmation emails come from, required for doubleOptIn. It has to be an address the caller may send as, or the call is refused with 422 form_sender_refused.
body.settings.confirmSubjectstring: The subject of the confirmation email, 1 to 200 characters. Defaults to Please confirm your subscription.
body.settings.confirmMessagestring: The text of the confirmation email above its button, at most 2000 characters.
body.settings.confirmButtonstring: The label of the confirmation button, 1 to 60 characters. Defaults to Confirm my subscription.
body.settings.successActionFormSuccessAction: What a person sees after signing up: message, the thank-you copy in the document, which is the default, or redirect, which sends them to redirectUrl.
body.settings.redirectUrlstring | null: The http or https page redirect sends people to, at most 2000 characters. Required while successAction is redirect.
body.settings.notifyAddressesArray<string>: Up to 10 addresses of this workspace that get an email about each sign-up. Each has to be one the caller can read, or the call is refused with 422 invalid_form.
body.publishboolean: Publish in the same call, so the form takes sign-ups at once.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Rückgabe

FormDetailResource: the FormResource fields, with status draft, or live when publish was true, plus document, publishedDocument, settings, audiences, senderIssue and senderProblem.

Beispiel

const form = await openemail.forms.create({    name: 'Newsletter',    starter: 'newsletter',    settings: { audienceIds: ['aud_9f2c4b7e1a0d63d84c5f2e7b'] },    publish: true}) console.log(form.id, form.status, form.url)

Hinweise

A value of the wrong type or length is 422 invalid_parameter with param naming it, and a key the body does not take is 422 unknown_parameter. A document or settings that break a rule, such as a form without its required email field, doubleOptIn without senderAddress or redirect without redirectUrl, is 422 invalid_form.
A key or app limited to particular addresses may only name addresses it holds in senderAddress and notifyAddresses. Anything else is 422 capability_unsupported.
Turning on doubleOptIn, naming a senderAddress or changing the confirmation email also needs emails:send, because the form then sends mail for you.
A workspace holds 100 forms by default, and support can raise that for a workspace that needs more. The next one past the limit is 422 workspace_limit_reached.
Not retried automatically, and nothing deduplicates by name, so a retry after a lost response can leave two forms. List them and delete the spare.

Auch verfügbar über

API: POST /forms
CLI: openemail forms create

`forms.design()`

Design a form from a brief

forms:write

Signatur

design(body: FormDesignInput, options?: RequestScope): Promise<DesignedFormResource>

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. Review it with get, change it with update or redesign, and put it live with publish.

Put everything the form must ask and say in brief: what it is for, the fields, the wording word for word, the colours and the tone. It spends one AI action and can take up to half a minute.

Parameter

body.briefstringErforderlich: Everything the form must ask and say, up to 4,000 characters.
body.namestring: A short name for the form, up to 120 characters. Left out, the designer names it.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Rückgabe

DesignedFormResource: the new draft, as get returns it, plus design.notes on what the designer adjusted or left out.

Beispiel

const form = await openemail.forms.design({    brief: 'A waitlist for our beta: email, first name and company, with a short line on what joining means. Dark green button that says Join the waitlist.'}) console.log(form.id, form.status, form.design.notes)

Hinweise

The SDK does not retry it, because a second call designs and saves a second form.
A design that cannot be made valid is a 422 invalid_form, a workspace that already holds as many forms as it may a 422 workspace_limit_reached, a server with no model a 409 ai_not_configured, and a workspace out of AI actions a 429 ai_quota_exceeded. Nothing is created in any of them.

Auch verfügbar über

API: POST /forms/design
CLI: openemail forms design

`forms.redesign()`

Change a form’s design from instructions

forms:write

Signatur

redesign(id: string, body: FormRedesignInput, options?: RequestScope): Promise<DesignedFormResource>

A designer applies written instructions to the draft of a form and leaves the rest alone, as Ask AI does in the form builder of the app: add, remove or reorder fields, make one required, rewrite or translate the copy, change colours or fonts. The change is saved to the draft, so a live form keeps showing its published version until publish.

Send the updatedAt you read as expectedUpdatedAt to refuse the change when somebody saved the form since. It spends one AI action and can take up to half a minute.

Parameter

idstringErforderlich: Form id such as frm_8d2f6a1c9b3e47d0a5f1c2e9.
body.instructionsstringErforderlich: What to change, with every detail, up to 4,000 characters.
body.expectedUpdatedAtstring: The updatedAt you read, as it came. When the form was saved since, nothing is written and the answer is 409 version_conflict.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Rückgabe

DesignedFormResource: the form with the change in its draft, plus design.notes on what the designer changed.

Beispiel

const form = await openemail.forms.redesign('frm_8d2f6a1c9b3e47d0a5f1c2e9', {    instructions: 'Add a required company field after the name, and make the button say Join.'}) console.log(form.hasUnpublishedChanges, form.design.notes)

Hinweise

The SDK does not retry it, because each call is a fresh design pass.
The same errors as design, plus 404 form_not_found for a form the caller cannot reach and 409 version_conflict when the form was saved since expectedUpdatedAt, or while the designer worked.

Auch verfügbar über

API: POST /forms/{id}/redesign
CLI: openemail forms redesign

`forms.listStarters()`

List the starting points for a new form

forms:read

Signatur

listStarters(options?: RequestScope): Promise<Array<FormStarterResource>>

Returns the starters the console offers when somebody makes a form, as a plain array: blank, just the email field, then newsletter, waitlist, event, early-access and contact. Each carries its slug, name and description, and the documents are left out.

Pass a slug to create as starter to begin a form from it, or read it whole with getStarter to change its fields first.

Starters are part of the product rather than workspace data, so the answer is the same for every key and changes only when a release adds one.

Parameter

options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Rückgabe

Array<FormStarterResource>, each { object: 'form_starter', slug, name, description }.

Beispiel

const starters = await openemail.forms.listStarters() for (const starter of starters) console.log(starter.slug, starter.name)

Hinweise

Not paginated, and there is no cursor. The list is short.

Auch verfügbar über

API: GET /forms/starters
CLI: openemail forms list-starters

`forms.getStarter()`

Retrieve one starter with its document

forms:read

Signatur

getStarter(slug: string, options?: RequestScope): Promise<FormStarterDetailResource>

Returns one starter in full: everything listStarters carries plus document, the fields, copy and style a form made from it begins with.

The document is there so a client can change it before it creates a form, rather than creating from the starter and updating afterwards. Send it, changed or not, as document on create.

Parameter

slugstringErforderlich: A starter slug from listStarters: blank, newsletter, waitlist, event, early-access or contact.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Rückgabe

FormStarterDetailResource: object, slug, name and description, plus document with fields, copy and style.

Beispiel

const starter = await openemail.forms.getStarter('newsletter') const form = await openemail.forms.create({    name: 'Product news',    document: { ...starter.document, copy: { ...starter.document.copy, title: 'Get our product news' } }}) console.log(form.id, form.document.fields.length)

Hinweise

An unknown slug is a 404 form_starter_not_found.
Passing starter: 'newsletter' to create does the same seeding on the server, in one call instead of two.

Auch verfügbar über

API: GET /forms/starters/{slug}
CLI: openemail forms get-starter

`forms.get()`

Retrieve a form with its documents and settings

forms:read

Signatur

get(id: string, options?: RequestScope): Promise<FormDetailResource>

Returns the whole form: the fields list carries with fresh stats, the draft document, the publishedDocument visitors see, which is null until the first publish, the settings and the named audiences sign-ups join.

hasUnpublishedChanges is true while the draft differs from what the live form shows. Settings take effect when they are saved, published or not.

For a form with doubleOptIn on, senderIssue says why confirmation emails cannot go out right now: missing when no senderAddress is set, not_sendable when the address cannot send, and not_allowed when its owner may not send as it. senderProblem says the same in a sentence. Both are null when confirmations can go out.

Parameter

idstringErforderlich: Form id such as frm_8d2f6a1c9b3e47d0a5f1c2e9.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Rückgabe

FormDetailResource: id, name, description, status, url, subscribeUrl, audienceIds, doubleOptIn, hasUnpublishedChanges, stats, publishedAt, createdAt and updatedAt, plus document, publishedDocument, settings, audiences, each { id, name, builtin }, senderIssue and senderProblem.

Beispiel

const form = await openemail.forms.get('frm_8d2f6a1c9b3e47d0a5f1c2e9') console.log(form.status, form.url)console.log(form.document.fields.map((field) => field.key)) if (form.senderIssue) console.log(form.senderProblem)

Hinweise

A form in another workspace is a 404 form_not_found, never a 403. An app a member connected reaches only the forms that member made.
audienceIds and settings.audienceIds leave out an audience that was deleted after it was chosen, or that the caller cannot reach.

Auch verfügbar über

API: GET /forms/{id}
CLI: openemail forms get

`forms.update()`

Change a form's name, document or settings

forms:write

Signatur

update(id: string, patch: FormPatch, options?: RequestScope): Promise<FormDetailResource>

A partial update: a field you leave out keeps its stored value, and description: null clears the note. document replaces the draft whole, and a live form keeps showing its published copy until publish. settings is merged field by field, so { settings: { doubleOptIn: true, senderAddress: '[email protected]' } } changes those two and keeps the rest, and settings take effect at once, live form or not.

To avoid overwriting somebody else's change, read the form and send its updatedAt back as expectedUpdatedAt. A save made in between is then refused with 409 version_conflict rather than overwritten, and nothing is written.

Parameter

idstringErforderlich: Form id such as frm_8d2f6a1c9b3e47d0a5f1c2e9.
patch.namestring: New name, trimmed, 1 to 120 characters.
patch.descriptionstring | null: New note, at most 500 characters. Null clears it.
patch.documentFormDocument: The new draft, whole, in the shape get returns. Every field carries all 15 of its keys, and a document needs exactly one email field, keyed email and required, and its field keys and ids must be unique.
patch.settings.audienceIdsArray<string>: The new list of audiences every sign-up joins, replacing the old one, at most 20 ids such as aud_9f2c4b7e1a0d63d84c5f2e7b. Every contact is in the default audience as well, so an empty list adds people there only. A new id that is not an audience the caller can reach is a 404 audience_not_found.
patch.settings.doubleOptInboolean: Email each person a confirmation link and add them only once they open it. True needs senderAddress.
patch.settings.senderAddressstring | null: The workspace address confirmation emails come from, required for doubleOptIn. It has to be an address the caller may send as, or the call is refused with 422 form_sender_refused.
patch.settings.confirmSubjectstring: The subject of the confirmation email, 1 to 200 characters.
patch.settings.confirmMessagestring: The text of the confirmation email above its button, at most 2000 characters.
patch.settings.confirmButtonstring: The label of the confirmation button, 1 to 60 characters.
patch.settings.successActionFormSuccessAction: What a person sees after signing up: message, the thank-you copy in the document or redirect, which sends them to redirectUrl.
patch.settings.redirectUrlstring | null: The http or https page redirect sends people to, at most 2000 characters. Required while successAction is redirect.
patch.settings.notifyAddressesArray<string>: Up to 10 addresses of this workspace that get an email about each sign-up, replacing the old list. Each has to be one the caller can read, or the call is refused with 422 invalid_form.
patch.expectedUpdatedAtstring: The updatedAt you read, as it came. When the form was saved since, nothing is written and the answer is 409 version_conflict.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Rückgabe

FormDetailResource as it stands after the change, with a new updatedAt.

Beispiel

const form = await openemail.forms.get('frm_8d2f6a1c9b3e47d0a5f1c2e9') const updated = await openemail.forms.update(form.id, {    settings: { doubleOptIn: true, senderAddress: '[email protected]' },    expectedUpdatedAt: form.updatedAt}) console.log(updated.doubleOptIn, updated.hasUnpublishedChanges)

Hinweise

The checks create makes apply to what you send: 422 invalid_parameter, unknown_parameter, invalid_form, form_sender_refused or capability_unsupported, and 404 audience_not_found on settings.audienceIds, each with param naming the field.
Turning on doubleOptIn, naming a senderAddress or changing the confirmation email also needs emails:send, because the form then sends mail for you.
Retried automatically on network failure and retryable statuses, since the same patch sent twice leaves the same form. With expectedUpdatedAt, a retry after a lost response can come back 409 version_conflict because the first attempt went through, so read the form before trying again.

Auch verfügbar über

API: PATCH /forms/{id}
CLI: openemail forms update

`forms.delete()`

Delete a form and every submission it holds

forms:write

Signatur

delete(id: string, options?: RequestScope): Promise<DeletedFormResource>

Deletes the form and every submission stored on it. Its hosted page and embed stop working at once, and subscribe answers 404 form_not_found. The people it added stay in your contacts and audiences.

There is no undo. To stop sign-ups and keep the form, its submissions and its statistics, use pause.

Parameter

idstringErforderlich: Form id such as frm_8d2f6a1c9b3e47d0a5f1c2e9.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Rückgabe

DeletedFormResource, { object: 'form', id, deleted: true }.

Beispiel

const removed = await openemail.forms.delete('frm_8d2f6a1c9b3e47d0a5f1c2e9') console.log(removed.id, removed.deleted)

Hinweise

An OAuth access token needs a verification code for this call, and is refused with 403 step_up_required until the app has verified one in the last 60 minutes. isStepUpRequired on the error says so. An API key is never asked for a code.
The SDK does not retry a delete. A 404 on your own second attempt after a lost response means the first one worked.

Auch verfügbar über

API: DELETE /forms/{id}
CLI: openemail forms delete

`forms.publish()`

Put the draft of a form live

forms:write

Signatur

publish(id: string, options?: RequestScope): Promise<FormDetailResource>

Copies the draft document to publishedDocument and sets the form live, so the hosted page, the embed and subscribe show and take the new version from then on. Publishing a paused form opens it again. It takes no body.

The draft is checked first: the document and settings have to pass the rules create applies, and a double opt-in form needs a senderAddress that can send confirmations. An audience deleted since is skipped when people sign up. Submissions keep the answers, labels included, they were sent with, so publishing a change never rewrites them.

Parameter

idstringErforderlich: Form id such as frm_8d2f6a1c9b3e47d0a5f1c2e9.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Rückgabe

FormDetailResource with status live, a new publishedAt and hasUnpublishedChanges false.

Beispiel

const form = await openemail.forms.publish('frm_8d2f6a1c9b3e47d0a5f1c2e9') console.log(form.status, form.publishedAt, form.url)

Hinweise

A draft that breaks a rule is 422 invalid_form, and a double opt-in form that cannot send confirmations is 422 form_sender_refused, each with param naming the field. Publishing a double opt-in form also needs emails:send. A key or app limited to some addresses is refused with 422 capability_unsupported when the form's settings.senderAddress or settings.notifyAddresses falls outside them.
Retried automatically on network failure and retryable statuses, since publishing the same draft twice leaves the same live form.

Auch verfügbar über

API: POST /forms/{id}/publish
CLI: openemail forms publish

`forms.pause()`

Stop a published form taking sign-ups

forms:write

Signatur

pause(id: string, options?: RequestScope): Promise<FormDetailResource>

Closes a published form. Its hosted page and embed stay up and show the closed title and message from its copy, and subscribe answers 409 form_closed. Pausing a paused form changes nothing. It takes no body.

The form keeps its documents, settings, submissions and statistics, and resume opens it again with the version that was published last.

Parameter

idstringErforderlich: Form id such as frm_8d2f6a1c9b3e47d0a5f1c2e9.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Rückgabe

FormDetailResource with status paused.

Beispiel

const form = await openemail.forms.pause('frm_8d2f6a1c9b3e47d0a5f1c2e9') console.log(form.status)

Hinweise

A form that was never published cannot be paused, and is refused with 409 form_not_published.
Retried automatically on network failure and retryable statuses, since a second pause changes nothing.

Auch verfügbar über

API: POST /forms/{id}/pause
CLI: openemail forms pause

`forms.resume()`

Open a paused form again

forms:write

Signatur

resume(id: string, options?: RequestScope): Promise<FormDetailResource>

Opens a paused form again with the version that was published last, so it takes sign-ups once more. Changes made to the draft since stay in the draft: publish puts them live and opens the form in one call. Resuming a live form changes nothing. It takes no body.

Parameter

idstringErforderlich: Form id such as frm_8d2f6a1c9b3e47d0a5f1c2e9.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Rückgabe

FormDetailResource with status live.

Beispiel

const form = await openemail.forms.resume('frm_8d2f6a1c9b3e47d0a5f1c2e9') console.log(form.status, form.hasUnpublishedChanges)

Hinweise

A form that was never published is refused with 409 form_not_published. Publish it instead.
The published version is checked again first, so a double opt-in form whose senderAddress can no longer send confirmations is refused with 422 form_sender_refused, and one that breaks a rule with 422 invalid_form. Resuming a double opt-in form also needs emails:send. A key or app limited to some addresses is refused with 422 capability_unsupported when the form's settings.senderAddress or settings.notifyAddresses falls outside them.
Retried automatically on network failure and retryable statuses, since a second resume changes nothing.

Auch verfügbar über

API: POST /forms/{id}/resume
CLI: openemail forms resume

`forms.duplicate()`

Copy a form into a new draft

forms:write

Signatur

duplicate(id: string, options?: RequestScope): Promise<FormDetailResource>

Makes a new draft with the same document and settings, named after the original with copy added, such as Newsletter copy. Submissions and statistics are not copied, and the copy takes no sign-ups until you publish it. It takes no body.

An audience in the settings that the caller cannot reach is left out of the copy.

Parameter

idstringErforderlich: Form id such as frm_8d2f6a1c9b3e47d0a5f1c2e9.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Rückgabe

FormDetailResource for the new form, with its own id, status draft, publishedDocument null and empty stats.

Beispiel

const copy = await openemail.forms.duplicate('frm_8d2f6a1c9b3e47d0a5f1c2e9') await openemail.forms.update(copy.id, { name: 'Spring launch' })

Hinweise

It counts toward the workspace limit of 100 forms, as create does, and is refused with 422 workspace_limit_reached past it. A key or app limited to some addresses is refused with 422 capability_unsupported when the form's settings.senderAddress or settings.notifyAddresses falls outside them.
Not retried automatically, since a retry after a lost response would make a second copy. List the forms and delete the spare.

Auch verfügbar über

API: POST /forms/{id}/duplicate
CLI: openemail forms duplicate

`forms.analytics()`

Read views, sign-ups and people added over a window

forms:read

Signatur

analytics(id: string, options?: FormAnalyticsOptions): Promise<FormAnalyticsResource>

Returns the numbers behind a form's Analytics tab in one request: views, submissions and added over a window, cut into 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. A submission is counted when it is stored, waiting or added. added counts the sign-ups added to the audiences in the window, one per sign-up, dated when they joined, so a double opt-in sign-up can be submitted in one bucket and added in a later one.

series is sparse and oldest first: a bucket with nothing in it has no entry, so a chart must fill the gaps. grain sets the bucket width and the key shape, YYYY-MM-DD, YYYY-MM-DDTHH or YYYY-MM-DDTHH:MM, and offsetMinutes shifts the boundaries so days break where the reader's day does. The window starts at the beginning of its oldest bucket, reported as since, and ends now, reported as until.

Parameter

idstringErforderlich: Form id such as frm_8d2f6a1c9b3e47d0a5f1c2e9.
options.daysnumber: How far back to look, from 1 to 1095, defaulting to 30.
options.minutesnumber: The window in minutes, from 1 to 1576800, which wins over days when both are sent.
options.grainTrackingGrain: Bucket width: minute, hour or day, defaulting to day.
options.offsetMinutesnumber: Minutes east of UTC to cut the buckets in, from -840 to 840, defaulting to 0. Pass -new Date().getTimezoneOffset() for the local zone.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Rückgabe

FormAnalyticsResource, { object: 'form_analytics', formId, since, until, grain, offsetMinutes, totals, series }. totals has views, submissions, added, pending, lastSubmittedAt and conversion, and each entry of series is { bucket, views, submissions, added }.

Beispiel

const analytics = await openemail.forms.analytics('frm_8d2f6a1c9b3e47d0a5f1c2e9', {    days: 90,    grain: 'day',    offsetMinutes: -new Date().getTimezoneOffset()}) console.log(analytics.totals.views, analytics.totals.submissions, analytics.totals.conversion)

Hinweise

totals.conversion is submissions divided by views over the window, at most 1, and null when the window has no views. totals.pending counts the submissions made in the window that are still waiting, and totals.lastSubmittedAt is the latest sign-up ever, inside the window or not.
Views are counted by the hour, so with grain: 'minute' each hour's views fall in the bucket at the start of that hour.
Read only, so the SDK retries it after a network failure like any other read.

Auch verfügbar über

API: GET /forms/{id}/analytics
CLI: openemail forms analytics

`forms.listSubmissions()`

List one page of a form's submissions

forms:readBlättert durch die Ergebnisse

Signatur

listSubmissions(id: string, options?: FormSubmissionListOptions): Promise<Page<FormSubmissionResource>>

Returns one page of the sign-ups a form has stored, newest first. Each keeps the answers as they were sent, labels included, so it still reads right after the form changes. Paging is keyset: options.limit takes 1 to 100 and defaults to 25, and nextCursor, a submission id, goes back as options.cursor while hasMore is true. listAllSubmissions and iterateSubmissions do that walk for you.

status is added once the person is a contact in the audiences, and pending while a double opt-in form waits for them to confirm. expired is true on a pending submission whose newest confirmation link, sent at sign-up or by a resend, is more than 7 days old: approve it with approveSubmission, or send a fresh link with resendConfirmation.

Parameter

idstringErforderlich: Form id such as frm_8d2f6a1c9b3e47d0a5f1c2e9.
options.limitnumber: Rows per page, a whole number from 1 to 100. The server defaults to 25.
options.cursorstring: The nextCursor from the previous page, a submission id of this form. One that names no submission of this form is a 400 invalid_cursor.
options.qstring: Only submissions whose email address contains this text, ignoring case, at most 200 characters.
options.statusFormSubmissionStatus: Only pending or only added submissions.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Rückgabe

Page<FormSubmissionResource> with items, hasMore and nextCursor. Each item has id, formId, email, status, expired, answers, audienceIds, sourceUrl, confirmedAt and createdAt, and each answer is { fieldId, key, label, type, value, display }.

Beispiel

const page = await openemail.forms.listSubmissions('frm_8d2f6a1c9b3e47d0a5f1c2e9', { status: 'pending' }) for (const submission of page.items) {    console.log(submission.email, submission.expired ? 'link expired' : 'waiting')}

Hinweise

value on an answer is text for most fields, a list of option values for a multiple choice or audience field, and true or false for a checkbox or consent field. display is the same answer as a person reads it, option labels included.
sourceUrl is the page the form was filled in on, its origin and path only and at most 500 characters, when it was known.

Auch verfügbar über

API: GET /forms/{id}/submissions
CLI: openemail forms list-submissions

`forms.listAllSubmissions()`

Collect every submission of a form into one array

forms:readBlättert durch die Ergebnisse

Signatur

listAllSubmissions(id: string, options?: FormSubmissionListOptions): Promise<Array<FormSubmissionResource>>

Follows nextCursor from page to page and resolves with every submission of the form that matches q and status, newest first. limit sets the page size of each request, not the total.

Parameter

idstringErforderlich: Form id such as frm_8d2f6a1c9b3e47d0a5f1c2e9.
options.limitnumber: Page size per request, from 1 to 100, defaulting to 25 on the server.
options.cursorstring: A submission id to start after.
options.qstring: Only submissions whose email address contains this text, ignoring case, at most 200 characters.
options.statusFormSubmissionStatus: Only pending or only added submissions.
options.signalAbortSignal: Cancels the request in flight and rejects the whole walk.
options.apiKeystring: Overrides the client's API key for every page of this walk.

Rückgabe

Array<FormSubmissionResource> holding every matching submission across all pages.

Beispiel

const added = await openemail.forms.listAllSubmissions('frm_8d2f6a1c9b3e47d0a5f1c2e9', { status: 'added', limit: 100 }) console.log(added.map((submission) => submission.email).join('\n'))

Hinweise

A failure on any page rejects the whole call. For a large form, iterateSubmissions holds one page in memory at a time.

Auch verfügbar über

API: GET /forms/{id}/submissions

`forms.iterateSubmissions()`

Stream a form's submissions one at a time

forms:readBlättert durch die Ergebnisse

Signatur

iterateSubmissions(id: string, options?: FormSubmissionListOptions): AsyncGenerator<FormSubmissionResource, void, undefined>

Returns an async generator that yields submissions one by one, newest first, and requests the next page only once the current one is drained. Breaking out of the loop stops the requests.

Parameter

idstringErforderlich: Form id such as frm_8d2f6a1c9b3e47d0a5f1c2e9.
options.limitnumber: Page size per request, from 1 to 100, defaulting to 25 on the server.
options.cursorstring: A submission id to start after.
options.qstring: Only submissions whose email address contains this text, ignoring case, at most 200 characters.
options.statusFormSubmissionStatus: Only pending or only added submissions.
options.signalAbortSignal: Cancels the request in flight and rejects the whole walk.
options.apiKeystring: Overrides the client's API key for every page of this walk.

Rückgabe

AsyncGenerator<FormSubmissionResource, void, undefined> yielding one submission per step.

Beispiel

for await (const submission of openemail.forms.iterateSubmissions('frm_8d2f6a1c9b3e47d0a5f1c2e9', { q: 'acme.com' })) {    console.log(submission.email, submission.createdAt)}

Hinweise

The generator is lazy, so an abandoned loop costs only the pages you consumed.

Auch verfügbar über

API: GET /forms/{id}/submissions

`forms.getSubmission()`

Retrieve one submission with every answer

forms:read

Signatur

getSubmission(id: string, submissionId: string, options?: RequestScope): Promise<FormSubmissionResource>

Returns one submission of the form: the address the person signed up with, lower cased, its status, every answer as it was sent, the audiences it joins, the page it came from, and when it was made and confirmed.

Parameter

idstringErforderlich: Form id such as frm_8d2f6a1c9b3e47d0a5f1c2e9.
submissionIdstringErforderlich: Submission id such as fsb_3c7e1a9f0b2d4c6e8a1f3b5d, from listSubmissions or a form.submitted webhook.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Rückgabe

FormSubmissionResource with id, formId, email, status, expired, answers, audienceIds, sourceUrl, confirmedAt and createdAt.

Beispiel

const submission = await openemail.forms.getSubmission('frm_8d2f6a1c9b3e47d0a5f1c2e9', 'fsb_3c7e1a9f0b2d4c6e8a1f3b5d') for (const answer of submission.answers) console.log(`${answer.label}: ${answer.display}`)

Hinweise

A form you cannot reach is a 404 form_not_found, and a submission that is not on this form is a 404 form_submission_not_found.
confirmedAt is when the person joined the audiences, and null while the submission is pending.

Auch verfügbar über

API: GET /forms/{id}/submissions/{submissionId}
CLI: openemail forms get-submission

`forms.deleteSubmission()`

Delete one submission of a form

forms:write

Signatur

deleteSubmission(id: string, submissionId: string, options?: RequestScope): Promise<DeletedFormSubmissionResource>

Deletes the submission. The person it added stays in your contacts and audiences, and a pending one can no longer be confirmed, since its link stops working. There is no undo.

Parameter

idstringErforderlich: Form id such as frm_8d2f6a1c9b3e47d0a5f1c2e9.
submissionIdstringErforderlich: Submission id such as fsb_3c7e1a9f0b2d4c6e8a1f3b5d, from listSubmissions or a form.submitted webhook.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Rückgabe

DeletedFormSubmissionResource, { object: 'form_submission', id, formId, deleted: true }.

Beispiel

const removed = await openemail.forms.deleteSubmission('frm_8d2f6a1c9b3e47d0a5f1c2e9', 'fsb_3c7e1a9f0b2d4c6e8a1f3b5d') console.log(removed.id, removed.deleted)

Hinweise

To take the person off your lists as well, remove them from the audience with audiences.removeContact, or delete the contact with contacts.delete.
The SDK does not retry a delete. A 404 form_submission_not_found on your own second attempt after a lost response means the first one worked.

Auch verfügbar über

API: DELETE /forms/{id}/submissions/{submissionId}
CLI: openemail forms delete-submission

`forms.deleteSubmissions()`

Delete up to 200 submissions of a form in one call

forms:write

Signatur

deleteSubmissions(id: string, submissionIds: Array<string>, options?: RequestScope): Promise<FormSubmissionBatchDeleteResource>

Deletes many submissions of one form and answers with how many went. A repeated id counts once, and an id that names no submission of this form is skipped rather than refused. The people the submissions added stay in your contacts and audiences, and a pending one can no longer be confirmed.

Parameter

idstringErforderlich: Form id such as frm_8d2f6a1c9b3e47d0a5f1c2e9.
submissionIdsArray<string>Erforderlich: From 1 to 200 submission ids of this form, such as fsb_3c7e1a9f0b2d4c6e8a1f3b5d, sent as ids. An empty list or more than 200 is a 422 invalid_parameter on ids.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Rückgabe

FormSubmissionBatchDeleteResource, { object: 'form_submission_batch', formId, deleted }, where deleted counts the submissions this call removed.

Beispiel

const result = await openemail.forms.deleteSubmissions('frm_8d2f6a1c9b3e47d0a5f1c2e9', [    'fsb_3c7e1a9f0b2d4c6e8a1f3b5d',    'fsb_9a4c2e7f1b3d5a6c8e0f2b4d']) console.log(`${result.deleted} submissions deleted`)

Hinweise

Send a longer list in chunks of 200.
Not retried automatically. A retry after a lost response skips the submissions the first call removed, so its deleted can read 0.

Auch verfügbar über

API: POST /forms/{id}/submissions/batch-remove
CLI: openemail forms delete-submissions

`forms.approveSubmission()`

Add a waiting sign-up without its confirmation

forms:writecontacts:write

Signatur

approveSubmission(id: string, submissionId: string, options?: RequestScope): Promise<FormSubmissionResource>

Adds the person behind a pending submission to its audiences without waiting for them to open the confirmation email, for when you know them. The submission comes back added with confirmedAt set, and a form.confirmed webhook goes out with via set to approval. It takes no body.

It does not resubscribe someone who unsubscribed from one of the audiences, as their own confirmation would. A submission that is already added is returned as it is.

Parameter

idstringErforderlich: Form id such as frm_8d2f6a1c9b3e47d0a5f1c2e9.
submissionIdstringErforderlich: Submission id such as fsb_3c7e1a9f0b2d4c6e8a1f3b5d, from listSubmissions or a form.submitted webhook.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Rückgabe

FormSubmissionResource, now with status added and confirmedAt set.

Beispiel

const submission = await openemail.forms.approveSubmission('frm_8d2f6a1c9b3e47d0a5f1c2e9', 'fsb_3c7e1a9f0b2d4c6e8a1f3b5d') console.log(submission.status, submission.confirmedAt)

Hinweise

It needs contacts:write as well as forms:write, since it adds a contact. A key without both is refused with 403 insufficient_scope.
Retried automatically on network failure and retryable statuses, since approving an added submission changes nothing.

Auch verfügbar über

API: POST /forms/{id}/submissions/{submissionId}/approve
CLI: openemail forms approve-submission

`forms.resendConfirmation()`

Email a waiting sign-up a fresh confirmation link

forms:writeemails:send

Signatur

resendConfirmation(id: string, submissionId: string, options?: RequestScope): Promise<ResentFormConfirmationResource>

Emails the person behind a pending submission a new confirmation link from the form's senderAddress, with the form's current subject, message and button. The new link works for 7 days from now. It takes no body.

To protect the person, one address gets at most one confirmation from a form every ten minutes, and five a day across the workspace. A call within ten minutes of the last one, or past the fifth in a day, sends nothing and answers confirmationSent: false, and so does a call for a submission that is already added.

Parameter

idstringErforderlich: Form id such as frm_8d2f6a1c9b3e47d0a5f1c2e9.
submissionIdstringErforderlich: Submission id such as fsb_3c7e1a9f0b2d4c6e8a1f3b5d, from listSubmissions or a form.submitted webhook.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Overrides the client's API key for this call only.

Rückgabe

ResentFormConfirmationResource: the FormSubmissionResource fields plus confirmationSent, true when an email went out on this call.

Beispiel

const result = await openemail.forms.resendConfirmation('frm_8d2f6a1c9b3e47d0a5f1c2e9', 'fsb_3c7e1a9f0b2d4c6e8a1f3b5d') if (!result.confirmationSent) console.log('nothing sent, try again later')

Hinweise

Needs emails:send as well as forms:write, because the call sends an email.
When confirmations cannot go out from the form's address, or it has none, the call is refused with 422 form_sender_refused on settings.senderAddress.
expired follows the newest confirmation link, so a resend that went out turns it false again for the next 7 days.
Not retried automatically, since a retry could send a second email. Read confirmationSent rather than calling again at once.

Auch verfügbar über

API: POST /forms/{id}/submissions/{submissionId}/resend
CLI: openemail forms resend-confirmation

`forms.subscribe()`

Sign someone up through a published form

Keine Anmeldedaten

Signatur

subscribe(formId: string, values: FormSubscribeValues, options?: RequestScope): Promise<FormSubscriptionResource>

Posts a sign-up to a published form, as a visitor of its hosted page does, and answers with the outcome. It sends no credential, even from a client that holds one, so it works for any published form, in this workspace or another.

values holds the answers keyed by field key, and every form has the field keyed email. A text field takes a string, a number field a number or a numeric string, a checkbox or consent field true or false, a dropdown or single choice field one option value, and a multiple choice or audience field an array of option values. A key the form does not have is ignored, and a key starting oe_ is never stored as an answer.

On a double opt-in form outcome is pending: the person joins the audiences once they open a confirmation link, emailed after this answer unless this form emailed that address in the last ten minutes or the address has had five from this workspace today. Otherwise they join at once and outcome is added. Someone who unsubscribed from an audience stays unsubscribed unless they confirm through a double opt-in form.

Parameter

formIdstringErforderlich: The id of a published form, such as frm_8d2f6a1c9b3e47d0a5f1c2e9.
values.emailstringErforderlich: The address to sign up, the answer to the email field every form has.
values.oe_sourcestring: The page the form was filled in on, stored as its origin and path, at most 500 characters. A call from a server has no Referer to fall back on, so pass it to keep the source.
options.signalAbortSignal: Cancels the request.
options.apiKeystring: Ignored and never sent. Signing up needs no credential.

Rückgabe

FormSubscriptionResource, { object: 'form_subscription', formId, outcome, redirectUrl }. outcome is added or pending, and redirectUrl is where the form sends people after a sign-up when it is set to redirect, otherwise null.

Beispiel

const result = await openemail.forms.subscribe('frm_8d2f6a1c9b3e47d0a5f1c2e9', {    email: '[email protected]',    first_name: 'Ada',    topics: ['product', 'events'],    oe_source: 'https://acme.com/launch'}) console.log(result.outcome)

Hinweise

An answer that is missing or not valid is a 422 invalid_form_submission, and nothing is stored. The error's fields lists one { key, error } per problem, such as { key: 'email', error: 'email' }, and its body holds the whole response. A form that was never published is a 404 form_not_found, a paused one a 409 form_closed.
Every post to any of the workspace's forms counts toward a limit of 40 every 10 minutes from one network, whatever the outcome, counted by the address the request comes from, so a server that relays sign-ups for many people shares one allowance. Past it the call is refused with 429 form_rate_limited.
Leave out oe_started, and send oe_website empty or not at all: they catch bots. A sign-up that fills oe_website, or carries an oe_started token that is not valid or is under 1.5 seconds old, gets a normal answer and is dropped.
Not retried automatically, since a retry after a lost response would store a second submission on a single opt-in form. On a double opt-in form, signing up again before confirming updates the waiting submission instead, and form.submitted fires again only when the answers changed.

Auch verfügbar über

API: POST /subscribe/{formId}
CLI: openemail forms subscribe