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

# Replace a language list

> Replaces the whole document: every field left out is reset to its default.

```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 siteLanguages = await site.languages().replaceSiteLanguages({ id: 'clx8m2k4p0000a1b2c3d4e5f6' })
```

```json 200 wrap theme={"dark"}
{
  "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 `replaceSiteLanguages()` and returns the answer.

**1. Add the controller**

```ts app/controllers/replace_site_languages_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 ReplaceSiteLanguagesController {
  constructor(protected site: SiteClient) {}

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

**2. Add the route**

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

const ReplaceSiteLanguagesController = () => import('#controllers/replace_site_languages_controller')

router.put('/site-languages/:id', [ReplaceSiteLanguagesController])
```

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

PATCH changes only the fields sent. Live at once, with the same checks as the Languages screen.

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

Pass `row.id` as `id`. See [Find an id](https://docs.fetchski-attract.com/find-an-id.md).

> [accordion] Required parameters
>
> One object, e.g. `replaceSiteLanguages({ 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] Optional parameters
>
> **mainLanguageName** `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).
>
> **languages** `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.
>
> **SiteLanguagesLanguagesItem**
>
> **name** `string` *required*
>
> **Required.** As its speakers write it, for example “Français”. Shown in the language switcher.
>
> **code** `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”.
>
> **id** `string`
>
> The row’s id, unique in its array.
>
> **public** `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.
>
> **fields** `Readonly\<Record\<string, unknown\>\>`
>
> Optional: any keys not listed above, by their wire names; they are sent with the rest.

> [accordion] 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`).
>
> **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.
>
> **type** `string`
>
> **Always sent.** The document type’s name: always this type’s.
>
> **createdAt** `Date`
>
> **Always sent.** When it was created (ISO 8601). Format: an ISO 8601 date and time.
>
> **updatedAt** `Date`
>
> **Always sent.** When it last changed (ISO 8601). Format: an ISO 8601 date and time.
>
> **mainLanguageName** `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).
>
> **languages** `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.
>
> **SiteLanguagesLanguagesItem**
>
> **name** `string`
>
> **Always sent.** As its speakers write it, for example “Français”. Shown in the language switcher.
>
> **code** `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”.
>
> **id** `string`
>
> **Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.
>
> **public** `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.
>
> **fields** `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.

> [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 `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_replace_site_languages.spec.ts`, then run your tests:

```ts tests/unit/languages_replace_site_languages.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 ReplaceSiteLanguagesController from '#controllers/replace_site_languages_controller'

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

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

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

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

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

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

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

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

## Related

> [card] [List the Global fields each language translates](https://docs.fetchski-attract.com/adonisjs/reference/languages/get-global-translated-fields.md)
>
> `site.languages().getGlobalTranslatedFields()`

> [card] [List language lists](https://docs.fetchski-attract.com/adonisjs/reference/languages/list-site-languages.md)
>
> `site.languages().listSiteLanguages()`

> [card] [Get a language list](https://docs.fetchski-attract.com/adonisjs/reference/languages/get-site-languages.md)
>
> `site.languages().getSiteLanguages()`

> [card] [Update a language list](https://docs.fetchski-attract.com/adonisjs/reference/languages/update-site-languages.md)
>
> `site.languages().updateSiteLanguages()`

> [card] [PUT /site-languages/\{\_id}](https://docs.fetchski-attract.com/api-reference/languages/replace-a-language-list.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.