> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fetchski-attract.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Submit a form for review

> Submits the draft for review by someone who may publish it.

```ts AdonisJS wrap theme={"dark"}
import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
const draftSubmission = await site.forms().submitForm({ id: 'clx8m2k4p0000a1b2c3d4e5f6' })
```

```json 200 wrap theme={"dark"}
{
  "by": "Example by",
  "byId": "clx8m2k4p0000a1b2c3d4e5f6",
  "at": "2026-10-24T09:30:00.000Z"
}
```

## In your app

A controller answers a route on your app: it calls `submitForm()` and returns the answer.

**1. Add the controller**

```ts app/controllers/submit_form_controller.ts theme={"dark"}
import { inject } from '@adonisjs/core'
import type { HttpContext } from '@adonisjs/core/http'
import { SiteClient } from '@fetchski/attract-cms-sdk'

@inject()
export default class SubmitFormController {
  constructor(protected site: SiteClient) {}

  async handle({ params }: HttpContext) {
    return this.site.forms().submitForm({ id: params.id })
  }
}
```

**2. Add the route**

```ts start/routes.ts theme={"dark"}
import router from '@adonisjs/core/services/router'

const SubmitFormController = () => import('#controllers/submit_form_controller')

router.post('/form/:id/submit', [SubmitFormController])
```

Put it behind your auth middleware (`.use(middleware.auth())`): it acts with your key’s access.

**3. Call it**

Your own page’s form or script sends `POST /form/clx8m2k4p0000a1b2c3d4e5f6/submit` and gets back its answer as JSON. Test it, below, calls it.

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

```ts AdonisJS wrap theme={"dark"}
import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
const row = (await site.forms().listFormsPick(['title', 'slug'])).find((each) => each.slug === 'getting-started') // { id, title, slug }, or undefined
```

Pass `row.id` as `id`. Drafts: list with `{ aposMode: 'draft' }` to get the draft’s id ([Find an id](https://docs.fetchski-attract.com/find-an-id.md)).

> [accordion] Required parameters
>
> One object, e.g. `submitForm({ id })`; leave out the optional fields.
>
> **id** `string` *required*
>
> **Required.** The document’s `_id`: a full id names its own locale and mode (the draft’s `…:en:draft`, the published one’s `…:en:published`; no `aposMode` needed), a bare `aposDocId` takes the request’s (`aposLocale`, `aposMode`).

> [accordion] Returns
>
> A `DraftSubmission`. Who submitted the draft for review, and when. Read its properties (`draftSubmission.byId`): each says whether the site always sends it.
>
> **byId** `string`
>
> **Always sent.** The submitter’s user `_id`.
>
> **at** `Date`
>
> **Always sent.** Format: an ISO 8601 date and time.
>
> **by** `string`
>
> **Sometimes sent:** `undefined` when the site leaves it out. The submitter’s name.

> [accordion] Errors
>
> Nothing to catch: the SDK retries what is safe, and throws the rest as the classes below. Your exception handler turns them into your app’s own answers, once for every call (see [Map SDK errors to responses](https://docs.fetchski-attract.com/adonisjs/calling-the-api.md#map-sdk-errors-to-responses)); catch only what you want to react to here.
>
> **ValidationFailed** `400`
>
> The site refused what was sent: `errors` lists each field’s problem, `siteMessage` the first.
>
> **Retried first:** No. **Read:** `errors` (field → messages), `siteMessage`.
>
> **AuthenticationFailed** `401`
>
> 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`.
>
> **Forbidden** `403`
>
> 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`.
>
> **NotFound** `404`
>
> Nothing matches, or the caller may not see it.
>
> **Retried first:** No. **Read:** `siteMessage`, `errorName`, `data`.
>
> **SiteError** `500`
>
> The site failed. Its logs say why.
>
> **Retried first:** No: a write may have landed. **Read:** `siteMessage`, `errorName`, `data`.
>
> **SiteUnreachable** `no answer`
>
> 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`.
>
> **RequestNotSent** `not sent`
>
> 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).
>
> **SiteRequestFailed** `any other`
>
> 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`.
>
> **UnknownSite** `setup`
>
> `sites.forSite('acme')` named a slug `config/attract.ts` doesn’t list (with the keys in the database: no row in `attract_api_keys`).
>
> **Retried first:** No: nothing was sent. **Read:** `message`, `slug`.
>
> **SiteConfigurationError** `setup`
>
> The site’s entry is wrong: a malformed `baseUrl` or key, a key filed under another slug, or no default site. `node ace attract:check` names the fix.
>
> **Retried first:** No: nothing was sent. **Read:** `message` (what to fix).

## 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 see `RateLimited` only 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) in `config/attract.ts` for longer.

## Test it

It calls the controller above with the SDK faked: `fakeAttract()` puts the fake in the container for this one test, and it answers every call with a valid example, so nothing leaves your machine and no key is read. Save it as `tests/unit/forms_submit_form.spec.ts`, then run your tests:

```ts tests/unit/forms_submit_form.spec.ts theme={"dark"}
import { test } from '@japa/runner'
import app from '@adonisjs/core/services/app'
import testUtils from '@adonisjs/core/services/test_utils'
import { fakeAttract } from '@fetchski/attract-cms-adonis/testing'
import SubmitFormController from '#controllers/submit_form_controller'

test('forms.submitForm', async () => {
  const site = fakeAttract()

  const ctx = await testUtils.createHttpContext()
  ctx.params = { id: 'clx8m2k4p0000a1b2c3d4e5f6' }
  const controller = await app.container.make(SubmitFormController)
  await controller.handle(ctx)

  site.assertCalled('forms.submitForm', (args) => args.id === 'clx8m2k4p0000a1b2c3d4e5f6')
})
```

```bash Terminal theme={"dark"}
node ace test
```

**Answer with your own values:** fake `forms.submitForm` with `factories.DraftSubmission({...})`, the fields you give over a valid example.

```ts tests/unit/forms_submit_form_answers.spec.ts theme={"dark"}
import { test } from '@japa/runner'
import { factories, fakeAttract } from '@fetchski/attract-cms-adonis/testing'

test('forms.submitForm answers your values', async ({ assert }) => {
  const site = fakeAttract({
    'forms.submitForm': factories.DraftSubmission({ byId: 'Your value' }),
  })

  const draftSubmission = await site.forms().submitForm({ id: 'clx8m2k4p0000a1b2c3d4e5f6' })
  assert.containSubset(draftSubmission, { byId: 'Your value' })
})
```

## Related

> [card] [List a form’s locales](https://docs.fetchski-attract.com/adonisjs/reference/forms/get-form-locales.md)
>
> `site.forms().getFormLocales()`

> [card] [List forms](https://docs.fetchski-attract.com/adonisjs/reference/forms/list-forms.md)
>
> `site.forms().listForms()`

> [card] [Create a form](https://docs.fetchski-attract.com/adonisjs/reference/forms/create-form.md)
>
> `site.forms().createForm()`

> [card] [Get a form](https://docs.fetchski-attract.com/adonisjs/reference/forms/get-form.md)
>
> `site.forms().getForm()`

> [card] [Replace a form](https://docs.fetchski-attract.com/adonisjs/reference/forms/replace-form.md)
>
> `site.forms().replaceForm()`

> [card] [Delete a form](https://docs.fetchski-attract.com/adonisjs/reference/forms/delete-form.md)
>
> `site.forms().deleteForm()`

> [card] [POST /@apostrophecms/form/\{\_id}/submit](https://docs.fetchski-attract.com/api-reference/forms/submit-a-form-for-review.md)
>
> The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.