Update a language list

import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
const siteLanguages = await site.languages().updateSiteLanguages({ id: 'clx8m2k4p0000a1b2c3d4e5f6' })

{
  "mainLanguageName": "English",
  "languages": [],
  "_id": "clx8m2k4p0000a1b2c3d4e5f6",
  "type": "Example type",
  "createdAt": "2026-10-24T09:30:00.000Z",
  "updatedAt": "2026-10-24T09:30:00.000Z"
}

import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
const siteLanguages = await site.languages().updateSiteLanguages({ id: 'clx8m2k4p0000a1b2c3d4e5f6' })

{
  "mainLanguageName": "English",
  "languages": [],
  "_id": "clx8m2k4p0000a1b2c3d4e5f6",
  "type": "Example type",
  "createdAt": "2026-10-24T09:30:00.000Z",
  "updatedAt": "2026-10-24T09:30:00.000Z"
}

In your app

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

Add the controller

app/controllers/update_site_languages_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 UpdateSiteLanguagesController {
  constructor(protected site: SiteClient) {}

  async handle({ params }: HttpContext) {
    return this.site.languages().updateSiteLanguages({ id: params.id })
  }
}

Add the route

start/routes.ts

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

const UpdateSiteLanguagesController = () => import('#controllers/update_site_languages_controller')

router.patch('/site-languages/:id', [UpdateSiteLanguagesController])

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 PATCH /site-languages/clx8m2k4p0000a1b2c3d4e5f6 and gets back its answer as JSON. Test it, below, calls it.

Live at once, with the same checks as the Languages screen: a new language gets its home page and its own addresses (/fr/…), a removed one keeps its translations for when its code comes back. A code that isn’t a language code, that is en, that a page’s address already starts with, or that is one of the site’s own addresses is refused with 400, naming the problem.

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.languages().listSiteLanguagesPick(['id']))[0] // { id }, or undefined

Pass row.id as id. See Find an id.

Required parameters

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

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

Optional parameters

string | null | undefined

Optional. Leave it out and the site uses "English". The language the site is written in first, named as its speakers write it. Its pages keep their addresses as they are (/about).

readonly SiteLanguagesLanguagesItem[] | null | undefined

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Each language gets its own addresses (/fr/about) and its own copy of every page, translated with Localize. A language you remove keeps its translations: add the same code again and they come back.

Show SiteLanguagesLanguagesItem

string

required

Required. As its speakers write it, for example “Français”. Shown in the language switcher.

string

required

Required. A lowercase language code, for example “fr”; add a region (“pt-br”, “es-419”), a script (“zh-hant”) or both (“zh-hant-tw”). It starts every address in this language (/fr/…) and can’t be “en”.

string

The row’s id, unique in its array.

boolean

No: only people signed in to the CMS see this language, so it can be translated first. Yes: visitors see it and the language switcher lists it.

Readonly<Record<string, unknown>>

Optional: any keys not listed above, by their wire names; they are sent with the rest.

Returns

A SiteLanguages. SiteLanguages content type. Read its properties (siteLanguages.id): each says whether the site always sends it. The example answer is the site’s wire JSON: one key differs from the property names (_id → id).

string

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.

string

Always sent. The document type’s name: always this type’s.

Date

Always sent. When it was created (ISO 8601). Format: an ISO 8601 date and time.

Date

Always sent. When it last changed (ISO 8601). Format: an ISO 8601 date and time.

string | null

Sometimes sent: undefined when the site leaves it out, and it can be null. The language the site is written in first, named as its speakers write it. Its pages keep their addresses as they are (/about).

readonly SiteLanguagesLanguagesItem[] | null

Sometimes sent: undefined when the site leaves it out, and it can be null. A list of SiteLanguagesLanguagesItem. Each language gets its own addresses (/fr/about) and its own copy of every page, translated with Localize. A language you remove keeps its translations: add the same code again and they come back.

Show SiteLanguagesLanguagesItem

string

Always sent. As its speakers write it, for example “Français”. Shown in the language switcher.

string

Always sent. A lowercase language code, for example “fr”; add a region (“pt-br”, “es-419”), a script (“zh-hant”) or both (“zh-hant-tw”). It starts every address in this language (/fr/…) and can’t be “en”.

string

Sometimes sent: undefined when the site leaves it out. The row’s id, unique in its array.

boolean

Sometimes sent: undefined when the site leaves it out. No: only people signed in to the CMS see this language, so it can be translated first. Yes: visitors see it and the language switcher lists it.

Readonly<Record<string, unknown>>

Always there: {} when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

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

tests/unit/languages_update_site_languages.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 UpdateSiteLanguagesController from '#controllers/update_site_languages_controller'

test('languages.updateSiteLanguages', async () => {
  const site = fakeAttract()

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

  site.assertCalled('languages.updateSiteLanguages', (args) => args.id === 'clx8m2k4p0000a1b2c3d4e5f6')
})

Terminal

node ace test

Answer with your own values: fake languages.updateSiteLanguages with factories.SiteLanguages({...}), the fields you give over a valid example.

tests/unit/languages_update_site_languages_answers.spec.ts

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

test('languages.updateSiteLanguages answers your values', async ({ assert }) => {
  const site = fakeAttract({
    'languages.updateSiteLanguages': factories.SiteLanguages({ id: 'Your value' }),
  })

  const siteLanguages = await site.languages().updateSiteLanguages({ id: 'clx8m2k4p0000a1b2c3d4e5f6' })
  assert.containSubset(siteLanguages, { id: 'Your value' })
})

List the Global fields each language translates

site.languages().getGlobalTranslatedFields()

List language lists

site.languages().listSiteLanguages()

Get a language list

site.languages().getSiteLanguages()

Replace a language list

site.languages().replaceSiteLanguages()

PATCH /site-languages/{_id}

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

import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
const siteLanguages = await site.languages().updateSiteLanguages({ id: 'clx8m2k4p0000a1b2c3d4e5f6' })

{
  "mainLanguageName": "English",
  "languages": [],
  "_id": "clx8m2k4p0000a1b2c3d4e5f6",
  "type": "Example type",
  "createdAt": "2026-10-24T09:30:00.000Z",
  "updatedAt": "2026-10-24T09:30:00.000Z"
}

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 the Global fields each language translates

List language lists

Get a language list

Replace a language list

PATCH /site-languages/{_id}

In your app

Find the id

Behavior

Test it

Related

List the Global fields each language translates

List language lists

Get a language list

Replace a language list

PATCH /site-languages/{_id}