AdonisJSIn your app
A function makes the call on the client it is given, so your code passes the real one and a test passes a fake.Add the function
src/attract/share-form.ts
Call it
A script makes the client once and calls the function:A route handler, a job or a queue worker calls it the same way.
scripts/share-form.ts
Terminal
_id (…:en:draft). Answers the draft, with its aposShareKey while the link is on: the link is the draft’s _url with aposShareKey and aposShareId (the draft’s _id) in its query.
Find the id
id is the document’s _id, from a list. Ask the list for only the fields you need: each row is a document’s id and those fields.
TypeScript
row.id as id. Drafts: list with { aposMode: 'draft' } to get the draft’s id (Find an id).
Required parameters
Required parameters
Optional parameters
Optional parameters
Optional. Leave it out (or pass
null) and it isn’t sent: the site’s default applies. true adds a share key (aposShareKey) to the draft; false (the default) removes it.Returns
Returns
A
Form. Form content type. Read its properties (form.title): each says whether the site always sends it. The example answer is the site’s wire JSON: some keys differ from the property names (_id → id, _form → form, _destination → destination).Always sent. Its title: the name it goes by in every list, and the heading of its page where it has one.
Always sent. The URL name: lowercase words joined by hyphens (letters outside a–z, even emoji, are kept).
Always sent. Select whether this content is public or private. One of
public, loginRequired; a newer site may send others, so keep a fallback.Always sent. The “from” address on this form’s emails. A new form starts with the Email in Site settings → Brand; change it here for this form.
Always sent. The document’s id. On a type with drafts it ends in its locale and mode (
…:en:published, …:en:draft): the part before the first colon is its aposDocId, shared by both copies. The {_id} the type’s routes take.Sometimes sent:
undefined when the site leaves it out. A FormSectionArea. Widgets, top to bottom: send { "items": [ … ] }, one object per widget with its type. Writing it replaces the whole area. A new document starts with form-section.Sometimes sent:
undefined when the site leaves it out, and it can be null. An ISO 8601 date and time, e.g. 2026-10-21T14:30:00.000Z.Sometimes sent:
undefined when the site leaves it out, and it can be null. An ISO 8601 date and time, e.g. 2026-10-21T14:30:00.000Z.Sometimes sent:
undefined when the site leaves it out, and it can be null. Thank you message title.Sometimes sent:
undefined when the site leaves it out. A RichTextArea. Widgets, top to bottom: send { "items": [ … ] }, one object per widget with its type. Writing it replaces the whole area.Sometimes sent:
undefined when the site leaves it out, and it can be null. Enable this to send a message to the person who submits this form.Sometimes sent:
undefined when the site leaves it out, and it can be null. Enter the “name” value of the field where people with enter their email address. For best results, make sure this field only accepts email addresses.Sometimes sent:
undefined when the site leaves it out, and it can be null. A list of FormEmailsItem. Email Address(es) for Results.Sometimes sent:
undefined when the site leaves it out, and it can be null. Submit to Google Spreadsheets.Sometimes sent:
undefined when the site leaves it out, and it can be null. Google Spreadsheet ID.Sometimes sent:
undefined when the site leaves it out, and it can be null. The name of the sheet tab in your Google spreadsheet where you want the submission appended. If not provided, the first sheet of the spreadsheet will be used.Sometimes sent:
undefined when the site leaves it out, and it can be null. Submit button label.Sometimes sent:
undefined when the site leaves it out, and it can be null. To use, reCAPTCHA a site ID and secret key must be configured in website code or the website global settings.Sometimes sent:
undefined when the site leaves it out, and it can be null. Enable query parameter capture.Sometimes sent:
undefined when the site leaves it out, and it can be null. A list of FormQueryParamListItem. Create an array item for each query parameter value you wish to capture.Sometimes sent:
undefined when the site leaves it out, and it can be null. A list of FormFormActionsItem. What happens to each submission, beyond being stored in the CMS. Add one row per destination; several can run for one form. Storage always happens regardless.Sometimes sent:
undefined when the site leaves it out, and it can be null. In the archive: kept, but out of every list and off the site until it is restored. false (or null) for a live document.Sometimes sent:
undefined when the site leaves it out, and it can be null. The draft’s preview share key, while its share link is on: the link is the draft’s _url with aposShareKey and aposShareId (the draft’s _id) in its query. Absent otherwise, and on published documents.Errors
Errors
Nothing to catch: the SDK retries what is safe, and throws the rest as the classes below; catch only what you want to react to (see Errors and testing).
The site refused what was sent:
errors lists each field’s problem, siteMessage the first.Retried first: No. Read: errors (field → messages), siteMessage.The API key is missing or refused (malformed, revoked, expired), or a signature its signing mode needs is missing or stale.Retried first: No. Read:
siteMessage, errorName, data.The key may not do this: a scope it lacks, or an address outside its allowlist.
siteMessage names it.Retried first: No. Read: siteMessage, errorName, data.Nothing matches, or the caller may not see it.Retried first: No. Read:
siteMessage, errorName, data.The site failed. Its logs say why.Retried first: No: a write may have landed. Read:
siteMessage, errorName, data.No answer: DNS, a refused connection, TLS, or the timeout (15 s per attempt by default).Retried first: Only when nothing reached the site (
neverConnected()); never after a timeout, when it may have landed. Read: reason, neverConnected.The client refused to send it (e.g. a path segment of
..); the site never saw it.Retried first: No. Read: reason (what to change).Any other status, or a success whose JSON doesn’t match this SDK version’s types (update the SDK).Retried first: No. Read:
reason, status.sites.forSite('acme') named a slug your sites (createSiteClients()) don’t have.Retried first: No: nothing was sent. Read: message, slug.Behavior
- Access: an API key with
content:forms:write(or a master above it:content:forms:all,content:all,admin:all). A signed-in person may call it as far as their own permissions allow; anyone else gets 403. - Rate limit: the key’s own writes-per-minute limit, set when the key is created (default 120); over it, 429 with
Retry-After. The client waits and retries for you; you seeRateLimitedonly if that runs out. - Retries: a write is sent again only after a 429 (refused before it acted) or when it never reached the site. After a timeout or a 5xx it may have landed: check before you send it again.
- Timeout: 15 s per attempt by default; raise
timeout(milliseconds) on the client for longer.
Test it
It calls the function above with a fake client: the fake answers every call with a valid example, so nothing leaves your machine and no settings or key are needed. Run it withnode --test.
tests/forms-shareForm.test.ts
forms.shareForm with factories.Form({...}), the fields you give over a valid example.
tests/forms-shareForm-answer.test.ts
Related
List a form’s locales
site.forms().getFormLocales()List forms
site.forms().listForms()Create a form
site.forms().createForm()Get a form
site.forms().getForm()Replace a form
site.forms().replaceForm()Delete a form
site.forms().deleteForm()POST /@apostrophecms/form/{_id}/share
The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.