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

# Copy a service area to another locale

> Copies the draft into another locale as a draft there.

```php Laravel wrap theme={"dark"}
use Fetchski\AttractCmsLaravel\Facades\Attract;

$serviceArea = Attract::serviceAreas()->localizeServiceArea(id: 'clx8m2k4p0000a1b2c3d4e5f6', toLocale: 'en');
```

```json 200 wrap theme={"dark"}
{
  "title": "Example title",
  "mode": "zips",
  "priority": 0,
  "active": true,
  "zipCodes": "Example zip codes",
  "shapes": [
    {
      "id": "clx8m2k4p0000a1b2c3d4e5f6",
      "path": [
        {
          "lat": 1.5,
          "lng": 1.5
        }
      ]
    }
  ],
  "slug": "example-slug",
  "visibility": "public",
  "scheduledPublish": "Example scheduled publish",
  "scheduledUnpublish": "Example scheduled unpublish",
  "price": 0,
  "priceLabel": "Example price label",
  "color": "Example color",
  "description": "Example description",
  "publicNames": [],
  "source": "manual",
  "sourceId": "clx8m2k4p0000a1b2c3d4e5f6",
  "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 `localizeServiceArea()` and returns the answer.

**1. Add the controller**

```php app/Http/Controllers/LocalizeServiceAreaController.php theme={"dark"}
<?php

declare(strict_types=1);

namespace App\Http\Controllers;

use Fetchski\AttractCmsLaravel\Data\ServiceArea;
use Fetchski\AttractCmsLaravel\Facades\Attract;

final class LocalizeServiceAreaController
{
    public function __invoke(string $id): ServiceArea
    {
        return Attract::serviceAreas()->localizeServiceArea(id: $id, toLocale: 'en');
    }
}
```

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

**2. Add the route**

```php routes/web.php theme={"dark"}
use App\Http\Controllers\LocalizeServiceAreaController;
use Illuminate\Support\Facades\Route;

Route::post('/service-area/{id}/localize', LocalizeServiceAreaController::class)->middleware('auth');
```

It acts with your key’s access, so `auth` lets only your signed-in users reach it.

**3. Call it**

Your own page’s form or script sends `POST /service-area/clx8m2k4p0000a1b2c3d4e5f6/localize` (a form adds `@csrf`, as every web route checks it), and gets back its answer as JSON. Test it, below, calls it.

> [!TIP]
>
> To keep the call in an Action instead, this writes `app/Actions/Attract/LocalizeServiceArea.php` (an invokable Action that calls `localizeServiceArea()`) and its test under `tests/Feature/Actions/Attract/` (Pest when your app has it):
>
> ```bash Terminal theme={"dark"}
> php artisan make:attract-action serviceAreas.localizeServiceArea
> ```

## Call it from the terminal

```bash Terminal theme={"dark"}
php artisan attract:call serviceAreas.localizeServiceArea id=clx8m2k4p0000a1b2c3d4e5f6 toLocale=en
```

It calls `localizeServiceArea()` on your default site and prints its answer as JSON. It writes, so it asks first: add `--force` to skip the question in a script. See [Call any method from the terminal](https://docs.fetchski-attract.com/call-command.md) for every argument type.

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.

```php Laravel wrap theme={"dark"}
use Fetchski\AttractCmsLaravel\Facades\Attract;

$row = Attract::serviceAreas()->listServiceAreasPick(fields: ['title', 'slug'])->firstWhere('slug', 'getting-started'); // ['id' => …, 'title' => …, 'slug' => …], or null
```

```bash Terminal theme={"dark"}
php artisan attract:call serviceAreas.listServiceAreasPick fields=title,slug
```

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
>
> Named arguments, e.g. `localizeServiceArea(id: …)`; leave out the optional ones.
>
> **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`).
>
> **toLocale** `string` *required*
>
> **Required.** The locale to copy it into: a configured locale, not the current one.

> [accordion] Optional parameters
>
> **update** `?bool`
>
> **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).

> [accordion] Returns
>
> A `ServiceArea` (`Fetchski\AttractCmsLaravel\Data\ServiceArea`). ServiceArea content type. Read its properties (`$serviceArea->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`).
>
> **title** `string`
>
> **Always sent.** Its title: the name it goes by in every list, and the heading of its page where it has one.
>
> **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.
>
> **mode** `Enums\\Mode|string|null`
>
> **Sometimes sent:** `null` when the site leaves it out. How is this area defined? One of `zips`, `polygon`; a newer site may send others, so keep a fallback.
>
> **priority** `?int`
>
> **Sometimes sent:** `null` when the site leaves it out. Sort position — and where areas overlap, the LOWEST number wins the click/search result.
>
> **active** `?bool`
>
> **Sometimes sent:** `null` when the site leaves it out. Turn off to keep the area saved but leave it off the map.
>
> **zipCodes** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. One or more 5-digit zip codes, separated by commas, spaces or new lines. The map shape is generated automatically from public zip-boundary data.
>
> **shapes** `Collection\<int, ServiceAreaShapesItem\>|null`
>
> **Sometimes sent:** `null` when the site leaves it out. A list of `ServiceAreaShapesItem`. One or more shapes for this area. Paste coordinates (or draw on the map once a Google Maps key is configured); each shape needs at least 3 points.
>
> **ServiceAreaShapesItem (Fetchski\AttractCmsLaravel\Data\ServiceAreaShapesItem)**
>
> **id** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. The shape’s id. Leave it out for a new shape (the site sets one).
>
> **path** `Collection\<int, ServiceAreaShapesItemPathItem\>|null`
>
> **Sometimes sent:** `null` when the site leaves it out. A list of `ServiceAreaShapesItemPathItem`. The ring’s points, in order (at least 3).
>
> **ServiceAreaShapesItemPathItem (Fetchski\AttractCmsLaravel\Data\ServiceAreaShapesItemPathItem)**
>
> **lat** `?float`
>
> **Sometimes sent:** `null` when the site leaves it out. Latitude in degrees (kept to 6 decimals). -90 to 90.
>
> **lng** `?float`
>
> **Sometimes sent:** `null` when the site leaves it out. Longitude in degrees (kept to 6 decimals). -180 to 180.
>
> **slug** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. The URL name: lowercase words joined by hyphens (letters outside a–z, even emoji, are kept).
>
> **visibility** `Enums\\Visibility|string|null`
>
> **Sometimes sent:** `null` when the site leaves it out. Select whether this content is public or private. One of `public`, `loginRequired`; a newer site may send others, so keep a fallback.
>
> **scheduledPublish** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. An ISO 8601 date and time, e.g. `2026-10-21T14:30:00.000Z`.
>
> **scheduledUnpublish** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. An ISO 8601 date and time, e.g. `2026-10-21T14:30:00.000Z`.
>
> **price** `?float`
>
> **Sometimes sent:** `null` when the site leaves it out. The amount shown for this area (0 shows the map section’s “included” label). Use the label below for anything non-standard.
>
> **priceLabel** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. Optional. Shown instead of the formatted price — e.g. “From \$40” or “Call for pricing”.
>
> **color** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. Optional. Leave empty to assign a color from the site palette automatically.
>
> **description** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. Optional short text shown when a visitor clicks this area (or finds it via search).
>
> **publicNames** `Collection\<int, ServiceAreaPublicNamesItem\>|null`
>
> **Sometimes sent:** `null` when the site leaves it out. A list of `ServiceAreaPublicNamesItem`. Optional. The real-world places this area covers — e.g. “Brooklyn” or “Albany County”. Zone names like “Zone A” mean nothing to search engines; these names are what gets published as structured data (with structured data enabled in Site settings → SEO).
>
> **ServiceAreaPublicNamesItem (Fetchski\AttractCmsLaravel\Data\ServiceAreaPublicNamesItem)**
>
> **name** `string`
>
> **Always sent.** Place name.
>
> **id** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. The row’s id, unique in its array.
>
> **placeType** `Enums\\PlaceType|string|null`
>
> **Sometimes sent:** `null` when the site leaves it out. Pick the closest match — search engines read each entry as its own schema.org type. One of `City`, `AdministrativeArea`, `State`, `Place`; a newer site may send others, so keep a fallback.
>
> **fields** `array\<string, mixed\>`
>
> **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. An object in it that a PHP array would read as a list (`{}`, `{"0": …}`) is a `stdClass`, so it is sent back as an object.
>
> **source** `Enums\\ServiceAreaSource|string|null`
>
> **Sometimes sent:** `null` when the site leaves it out. Set automatically. “Demo placeholder” rows are removed the moment a real service area is published. “Zip feed import” rows were created by Import Zones from Zip Feed and get their zips/price refreshed on re-import. One of `manual`, `demo`, `zipFeed`; a newer site may send others, so keep a fallback.
>
> **sourceId** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. Internal id of the seed/import that created this row. Empty for manually created areas.
>
> **archived** `?bool`
>
> **Sometimes sent:** `null` when the site leaves it out. In the archive: kept, but out of every list and off the site until it is restored. `false` (or null) for a live document.
>
> **createdAt** `?CarbonImmutable`
>
> **Sometimes sent:** `null` when the site leaves it out. When it was created (ISO 8601). Format: an ISO 8601 date and time.
>
> **updatedAt** `?CarbonImmutable`
>
> **Sometimes sent:** `null` when the site leaves it out. When it last changed (ISO 8601). Format: an ISO 8601 date and time.
>
> **aposShareKey** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. 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.

> [accordion] Errors
>
> Nothing to catch: the SDK retries what is safe, and Laravel logs and renders the rest (see [Errors and testing](https://docs.fetchski-attract.com/laravel/errors.md)).
>
> **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()`.
>
> **Conflict** `409`
>
> A copy already exists in that locale: send `update: true` to overwrite 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`
>
> `Attract::site('acme')` named a slug that isn’t under `sites` in `config/fetchski-attract.php`.
>
> **Retried first:** No: nothing was sent. **Read:** `getMessage()`, `$e->slug`.
>
> **SiteConfigurationError** `setup`
>
> The site’s config entry is wrong: no `url`, a malformed `api_key`, a key filed under another slug, or no default site.
>
> **Retried first:** No: nothing was sent. **Read:** `getMessage()` (what to fix).

## Behavior

* **Access:** an API key with `content:service-areas:write` (or a master above it: `content:service-areas: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` in `config/fetchski-attract.php` for longer.

## Test it

It calls the route above with the SDK faked: the fake answers every call with a valid example, so nothing leaves your machine and no config or key is needed. Save it as `tests/Feature/LocalizeServiceAreaTest.php`, then run your tests:

```php tests/Feature/LocalizeServiceAreaTest.php theme={"dark"}
<?php

declare(strict_types=1);

namespace Tests\Feature;

use App\Models\User;
use Fetchski\AttractCmsLaravel\Facades\Attract;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Tests\TestCase;

final class LocalizeServiceAreaTest extends TestCase
{
    use RefreshDatabase;

    public function test_localize_service_area(): void
    {
        Attract::fake();

        $this->actingAs(User::factory()->create())
            ->postJson('/service-area/clx8m2k4p0000a1b2c3d4e5f6/localize')
            ->assertOk();

        Attract::assertCalled('serviceAreas.localizeServiceArea', fn (array $args): bool => $args['id'] === 'clx8m2k4p0000a1b2c3d4e5f6');
    }
}
```

```bash Terminal theme={"dark"}
php artisan test
```

**Answer with your own values:** fake `serviceAreas.localizeServiceArea` with `ServiceArea::factory()->make([...])`, the fields you give over a valid example.

```php tests/Feature/LocalizeServiceAreaAnswerTest.php theme={"dark"}
<?php

declare(strict_types=1);

namespace Tests\Feature;

use Fetchski\AttractCmsLaravel\Data\ServiceArea;
use Fetchski\AttractCmsLaravel\Facades\Attract;
use Tests\TestCase;

final class LocalizeServiceAreaAnswerTest extends TestCase
{
    public function test_localize_service_area_answers_your_values(): void
    {
        Attract::fake([
            'serviceAreas.localizeServiceArea' => ServiceArea::factory()->make(['title' => 'Your value']),
        ]);

        $serviceArea = Attract::serviceAreas()->localizeServiceArea(id: 'clx8m2k4p0000a1b2c3d4e5f6', toLocale: 'en');

        $this->assertSame('Your value', $serviceArea->title);
    }
}
```

## Related

> [card] [List a service area’s locales](https://docs.fetchski-attract.com/laravel/reference/service-areas/get-service-area-locales.md)
>
> `Attract::serviceAreas()->getServiceAreaLocales()`

> [card] [List service areas](https://docs.fetchski-attract.com/laravel/reference/service-areas/list-service-areas.md)
>
> `Attract::serviceAreas()->listServiceAreas()`

> [card] [Create a service area](https://docs.fetchski-attract.com/laravel/reference/service-areas/create-service-area.md)
>
> `Attract::serviceAreas()->createServiceArea()`

> [card] [Get a service area](https://docs.fetchski-attract.com/laravel/reference/service-areas/get-service-area.md)
>
> `Attract::serviceAreas()->getServiceArea()`

> [card] [Replace a service area](https://docs.fetchski-attract.com/laravel/reference/service-areas/replace-service-area.md)
>
> `Attract::serviceAreas()->replaceServiceArea()`

> [card] [Delete a service area](https://docs.fetchski-attract.com/laravel/reference/service-areas/delete-service-area.md)
>
> `Attract::serviceAreas()->deleteServiceArea()`

> [card] [POST /service-area/\{\_id}/localize](https://docs.fetchski-attract.com/api-reference/service-areas/copy-a-service-area-to-another-locale.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.