Submit a global document for review

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.globalContent().submitGlobal({ id: 'ckitdo5oq004pu69kr6oxo6fr:en:published' })

{
  "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 submitGlobal() and returns the answer.

Add the controller

app/controllers/submit_global_controller.ts

import { inject } from '@adonisjs/core'
import type { HttpContext } from '@adonisjs/core/http'
import { SiteClient } from '@fetchski/attract-cms-sdk'

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

  async handle({ params }: HttpContext) {
    return this.site.globalContent().submitGlobal({ id: params.id })
  }
}

Add the route

start/routes.ts

import router from '@adonisjs/core/services/router'

const SubmitGlobalController = () => import('#controllers/submit_global_controller')

router.post('/global/:id/submit', [SubmitGlobalController])

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

Call it

Your own page’s form or script sends POST /global/ckitdo5oq004pu69kr6oxo6fr:en:published/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.

AdonisJS

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.globalContent().listGlobalContentPick(['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).

Required parameters

One object, e.g. submitGlobal({ id }); leave out the optional fields.

string

required

Required. Computed document ID (can optionally include mode and locale, e.g., id:en:published) Matches ^\S+$.

Returns

A DraftSubmission. Who submitted the draft for review, and when. Read its properties (draftSubmission.byId): each says whether the site always sends it.

string

Always sent. The submitter’s user _id.

Date

Always sent. Format: an ISO 8601 date and time.

string

Sometimes sent: undefined when the site leaves it out. The submitter’s name.

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); catch only what you want to react to here.

400

The site refused what was sent: errors lists each field’s problem, siteMessage the first.Retried first: No. Read: errors (field → messages), siteMessage.

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.

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.

404

Nothing matches, or the caller may not see it.Retried first: No. Read: siteMessage, errorName, data.

500

The site failed. Its logs say why.Retried first: No: a write may have landed. Read: siteMessage, errorName, data.

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.

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

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.

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.

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 global:write (or a master above it: global: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/global_content_submit_global.spec.ts, then run your tests:

tests/unit/global_content_submit_global.spec.ts

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 SubmitGlobalController from '#controllers/submit_global_controller'

test('globalContent.submitGlobal', async () => {
  const site = fakeAttract()

  const ctx = await testUtils.createHttpContext()
  ctx.params = { id: 'ckitdo5oq004pu69kr6oxo6fr:en:published' }
  const controller = await app.container.make(SubmitGlobalController)
  await controller.handle(ctx)

  site.assertCalled('globalContent.submitGlobal', (args) => args.id === 'ckitdo5oq004pu69kr6oxo6fr:en:published')
})

Terminal

node ace test

Answer with your own values: fake globalContent.submitGlobal with factories.DraftSubmission({...}), the fields you give over a valid example.

tests/unit/global_content_submit_global_answers.spec.ts

import { test } from '@japa/runner'
import { factories, fakeAttract } from '@fetchski/attract-cms-adonis/testing'

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

  const draftSubmission = await site.globalContent().submitGlobal({ id: 'ckitdo5oq004pu69kr6oxo6fr:en:published' })
  assert.containSubset(draftSubmission, { byId: 'Your value' })
})

List global documents

site.globalContent().listGlobalContent()

Create a global document

site.globalContent().createGlobal()

Archive global documents

site.globalContent().archiveGlobals()

Copy global documents to another locale

site.globalContent().localizeGlobals()

Publish global documents

site.globalContent().publishGlobals()

Restore global documents

site.globalContent().restoreGlobals()

POST /@apostrophecms/global/{_id}/submit

The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.

Get started

Using the SDK

Going further

Pages & Site

Content

Media

Forms

Ads & Conversions

Analytics

In your app

Find the id

Behavior

Test it

List global documents

Create a global document

Archive global documents

Copy global documents to another locale

Publish global documents

Restore global documents

POST /@apostrophecms/global/{_id}/submit

In your app

Find the id

Behavior

Test it

Related

List global documents

Create a global document

Archive global documents

Copy global documents to another locale

Publish global documents

Restore global documents

POST /@apostrophecms/global/{_id}/submit