Copy a blog category to another locale

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

const site = await app.container.make(SiteClient)
const blogCategory = await site.blogCategories().localizeBlogCategory({ id: 'clx8m2k4p0000a1b2c3d4e5f6', toLocale: 'en' })

{
  "title": "Example title",
  "color": "Example color",
  "description": "Example description",
  "slug": "example-slug",
  "visibility": "public",
  "scheduledPublish": "Example scheduled publish",
  "scheduledUnpublish": "Example scheduled unpublish",
  "archived": false,
  "_id": "clx8m2k4p0000a1b2c3d4e5f6",
  "type": "Example type",
  "createdAt": "2026-10-24T09:30:00.000Z",
  "updatedAt": "2026-10-24T09:30:00.000Z",
  "aposShareKey": "k3v9x2m7q1z8w4p6"
}

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

const site = await app.container.make(SiteClient)
const blogCategory = await site.blogCategories().localizeBlogCategory({ id: 'clx8m2k4p0000a1b2c3d4e5f6', toLocale: 'en' })

{
  "title": "Example title",
  "color": "Example color",
  "description": "Example description",
  "slug": "example-slug",
  "visibility": "public",
  "scheduledPublish": "Example scheduled publish",
  "scheduledUnpublish": "Example scheduled unpublish",
  "archived": false,
  "_id": "clx8m2k4p0000a1b2c3d4e5f6",
  "type": "Example type",
  "createdAt": "2026-10-24T09:30:00.000Z",
  "updatedAt": "2026-10-24T09:30:00.000Z",
  "aposShareKey": "k3v9x2m7q1z8w4p6"
}

In your app

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

Add the controller

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

  async handle({ params }: HttpContext) {
    return this.site.blogCategories().localizeBlogCategory({ id: params.id, toLocale: 'en' })
  }
}

The other values are the example’s: take yours from the request, a form or your database.

Add the route

start/routes.ts

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

const LocalizeBlogCategoryController = () => import('#controllers/localize_blog_category_controller')

router.post('/blog-category/:id/localize', [LocalizeBlogCategoryController])

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 /blog-category/clx8m2k4p0000a1b2c3d4e5f6/localize and gets back its answer as JSON. Test it, below, calls it.

Answers that copy. 409 conflict when one exists and update is not true.

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.blogCategories().listBlogCategoriesPick(['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. localizeBlogCategory({ 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).

string

required

Required. The locale to copy it into: a configured locale, not the current one.

Optional parameters

boolean | null | undefined

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Overwrite the copy if one already exists there (default false: 409 conflict instead).

Returns

A BlogCategory. BlogCategory content type. Read its properties (blogCategory.title): 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. Its title: the name it goes by in every list, and the heading of its page where it has one.

string

Always sent. The URL name: lowercase words joined by hyphens (letters outside a–z, even emoji, are kept).

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.

string | null

Sometimes sent: undefined when the site leaves it out, and it can be null. Color of this category’s badge on blog cards. Leave empty to use the site accent color.

string | null

Sometimes sent: undefined when the site leaves it out, and it can be null. Optional. Internal note / future category-archive intro.

Visibility | null

Sometimes sent: undefined when the site leaves it out, and it can be null. Select whether this content is public or private. One of public, loginRequired; a newer site may send others, so keep a fallback.

string | null

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.

string | null

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.

boolean | null

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.

Date | null

Sometimes sent: undefined when the site leaves it out, and it can be null. When it was created (ISO 8601). Format: an ISO 8601 date and time.

Date | null

Sometimes sent: undefined when the site leaves it out, and it can be null. When it last changed (ISO 8601). Format: an ISO 8601 date and time.

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

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.

409

A copy already exists in that locale: send update: true to overwrite 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 content:blog-categories:write (or a master above it: content:blog-categories: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/blog_categories_localize_blog_category.spec.ts, then run your tests:

tests/unit/blog_categories_localize_blog_category.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 LocalizeBlogCategoryController from '#controllers/localize_blog_category_controller'

test('blogCategories.localizeBlogCategory', async () => {
  const site = fakeAttract()

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

  site.assertCalled('blogCategories.localizeBlogCategory', (args) => args.id === 'clx8m2k4p0000a1b2c3d4e5f6')
})

Terminal

node ace test

Answer with your own values: fake blogCategories.localizeBlogCategory with factories.BlogCategory({...}), the fields you give over a valid example.

tests/unit/blog_categories_localize_blog_category_answers.spec.ts

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

test('blogCategories.localizeBlogCategory answers your values', async ({ assert }) => {
  const site = fakeAttract({
    'blogCategories.localizeBlogCategory': factories.BlogCategory({ title: 'Your value' }),
  })

  const blogCategory = await site.blogCategories().localizeBlogCategory({ id: 'clx8m2k4p0000a1b2c3d4e5f6', toLocale: 'en' })
  assert.containSubset(blogCategory, { title: 'Your value' })
})

List a blog category’s locales

site.blogCategories().getBlogCategoryLocales()

List blog categories

site.blogCategories().listBlogCategories()

Create a blog category

site.blogCategories().createBlogCategory()

Get a blog category

site.blogCategories().getBlogCategory()

Replace a blog category

site.blogCategories().replaceBlogCategory()

Delete a blog category

site.blogCategories().deleteBlogCategory()

POST /blog-category/{_id}/localize

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 blogCategory = await site.blogCategories().localizeBlogCategory({ id: 'clx8m2k4p0000a1b2c3d4e5f6', toLocale: 'en' })

{
  "title": "Example title",
  "color": "Example color",
  "description": "Example description",
  "slug": "example-slug",
  "visibility": "public",
  "scheduledPublish": "Example scheduled publish",
  "scheduledUnpublish": "Example scheduled unpublish",
  "archived": false,
  "_id": "clx8m2k4p0000a1b2c3d4e5f6",
  "type": "Example type",
  "createdAt": "2026-10-24T09:30:00.000Z",
  "updatedAt": "2026-10-24T09:30:00.000Z",
  "aposShareKey": "k3v9x2m7q1z8w4p6"
}

Get started

Using the SDK

Going further

Pages & Site

Content

Media

Forms

Ads & Conversions

Analytics

Copy a blog category to another locale

In your app

Find the id

Behavior

Test it

List a blog category’s locales

List blog categories

Create a blog category

Get a blog category

Replace a blog category

Delete a blog category

POST /blog-category/{_id}/localize

In your app

Find the id

Behavior

Test it

Related

List a blog category’s locales

List blog categories

Create a blog category

Get a blog category

Replace a blog category

Delete a blog category

POST /blog-category/{_id}/localize