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

# Create a service area

> Create a new service area.

```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 serviceArea = await site.serviceAreas().createServiceArea({ title: 'Example title' })
```

```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 `createServiceArea()` and returns the answer.

**1. Add the controller**

```ts app/controllers/create_service_area_controller.ts theme={"dark"}
import { inject } from '@adonisjs/core'
import { SiteClient } from '@fetchski/attract-cms-sdk'

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

  async handle() {
    return this.site.serviceAreas().createServiceArea({ title: 'Example title' })
  }
}
```

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

**2. Add the route**

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

const CreateServiceAreaController = () => import('#controllers/create_service_area_controller')

router.post('/service-area', [CreateServiceAreaController])
```

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 `POST /service-area` and gets back its answer as JSON. Test it, below, calls it.

> [accordion] Required parameters
>
> One object, e.g. `createServiceArea({ title })`; leave out the optional fields.
>
> **title** `string` *required*
>
> **Required.** Its title: the name it goes by in every list, and the heading of its page where it has one.

> [accordion] Optional parameters
>
> **aposMode** `AposMode | null | undefined`
>
> **Optional.** Leave it out and the site uses `"published"`. `published` (the default) or `draft`. Drafts need a credential that may see them: an API key with the type’s write scope (`content:<type>:write`), or a signed-in editor. The public and a key with only the read scope get 403. One of `draft`, `published`.
>
> **aposLocale** `string | null | undefined`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. The locale to read or write, e.g. `en` (default: the site’s default locale).
>
> **mode** `Mode | null | undefined`
>
> **Optional.** Leave it out and the site uses `"zips"`. How is this area defined? One of `zips`, `polygon`.
>
> **priority** `number | null | undefined`
>
> **Optional.** Leave it out and the site uses `0`. Sort position — and where areas overlap, the LOWEST number wins the click/search result.
>
> **active** `boolean | null | undefined`
>
> **Optional.** Leave it out and the site uses `true`. Turn off to keep the area saved but leave it off the map.
>
> **zipCodes** `string | null | undefined`
>
> **Optional.** Leave it out and the site uses `""`. 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** `readonly ServiceAreaShapesItem[] | null | undefined`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. 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**
>
> **id** `string`
>
> The shape’s id. Leave it out for a new shape (the site sets one).
>
> **path** `readonly ServiceAreaShapesItemPathItem[]`
>
> A list of `ServiceAreaShapesItemPathItem`. The ring’s points, in order (at least 3).
>
> **ServiceAreaShapesItemPathItem**
>
> **lat** `number`
>
> Latitude in degrees (kept to 6 decimals). -90 to 90.
>
> **lng** `number`
>
> Longitude in degrees (kept to 6 decimals). -180 to 180.
>
> **slug** `string | null | undefined`
>
> **Optional.** Leave it out and the site uses `""`. The URL name: lowercase words joined by hyphens (letters outside a–z, even emoji, are kept). Left out, it’s made from the title.
>
> **visibility** `Visibility | null | undefined`
>
> **Optional.** Leave it out and the site uses `"public"`. Select whether this content is public or private. One of `public`, `loginRequired`.
>
> **scheduledPublish** `string | null | undefined`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. An ISO 8601 date and time, e.g. `2026-10-21T14:30:00.000Z`.
>
> **scheduledUnpublish** `string | null | undefined`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. An ISO 8601 date and time, e.g. `2026-10-21T14:30:00.000Z`.
>
> **price** `number | null | undefined`
>
> **Optional.** Leave it out and the site uses `0`. The amount shown for this area (0 shows the map section’s “included” label). Use the label below for anything non-standard.
>
> **priceLabel** `string | null | undefined`
>
> **Optional.** Leave it out and the site uses `""`. Optional. Shown instead of the formatted price — e.g. “From \$40” or “Call for pricing”.
>
> **color** `string | null | undefined`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. Optional. Leave empty to assign a color from the site palette automatically.
>
> **description** `string | null | undefined`
>
> **Optional.** Leave it out and the site uses `""`. Optional short text shown when a visitor clicks this area (or finds it via search).
>
> **publicNames** `readonly ServiceAreaPublicNamesItem[] | null | undefined`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. 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**
>
> **name** `string` *required*
>
> **Required.** Place name.
>
> **id** `string`
>
> The row’s id, unique in its array.
>
> **placeType** `PlaceType | null`
>
> Pick the closest match — search engines read each entry as its own schema.org type. One of `City`, `AdministrativeArea`, `State`, `Place`.
>
> **fields** `Readonly\<Record\<string, unknown\>\>`
>
> Optional: any keys not listed above, by their wire names; they are sent with the rest.
>
> **archived** `boolean | null | undefined`
>
> **Optional.** Leave it out and the site uses `false`. In the archive: kept, but out of every list and off the site until it is restored. `false` (or null) for a live document.

> [accordion] Returns
>
> A `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** `Mode | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. How is this area defined? One of `zips`, `polygon`; a newer site may send others, so keep a fallback.
>
> **priority** `number | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Sort position — and where areas overlap, the LOWEST number wins the click/search result.
>
> **active** `boolean | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Turn off to keep the area saved but leave it off the map.
>
> **zipCodes** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. 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** `readonly ServiceAreaShapesItem[] | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. 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**
>
> **id** `string`
>
> **Sometimes sent:** `undefined` when the site leaves it out. The shape’s id. Leave it out for a new shape (the site sets one).
>
> **path** `readonly ServiceAreaShapesItemPathItem[]`
>
> **Sometimes sent:** `undefined` when the site leaves it out. A list of `ServiceAreaShapesItemPathItem`. The ring’s points, in order (at least 3).
>
> **ServiceAreaShapesItemPathItem**
>
> **lat** `number`
>
> **Sometimes sent:** `undefined` when the site leaves it out. Latitude in degrees (kept to 6 decimals). -90 to 90.
>
> **lng** `number`
>
> **Sometimes sent:** `undefined` when the site leaves it out. Longitude in degrees (kept to 6 decimals). -180 to 180.
>
> **slug** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The URL name: lowercase words joined by hyphens (letters outside a–z, even emoji, are kept).
>
> **visibility** `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.
>
> **scheduledPublish** `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`.
>
> **scheduledUnpublish** `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`.
>
> **price** `number | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The amount shown for this area (0 shows the map section’s “included” label). Use the label below for anything non-standard.
>
> **priceLabel** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Shown instead of the formatted price — e.g. “From \$40” or “Call for pricing”.
>
> **color** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional. Leave empty to assign a color from the site palette automatically.
>
> **description** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Optional short text shown when a visitor clicks this area (or finds it via search).
>
> **publicNames** `readonly ServiceAreaPublicNamesItem[] | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. 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**
>
> **name** `string`
>
> **Always sent.** Place name.
>
> **id** `string`
>
> **Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.
>
> **placeType** `PlaceType | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. 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** `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.
>
> **source** `ServiceAreaSource | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. 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 | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Internal id of the seed/import that created this row. Empty for manually created areas.
>
> **archived** `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.
>
> **createdAt** `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.
>
> **updatedAt** `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.
>
> **aposShareKey** `string | null`
>
> **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.

> [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 `content:service-areas:write` (or a master above it: `content:service-areas:all`, `content:all`, `admin:all`). In published mode (the default) it goes live too, so the key also needs `content:service-areas:publish` (or a master above it); send `aposMode=draft` to change only the draft. 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/service_areas_create_service_area.spec.ts`, then run your tests:

```ts tests/unit/service_areas_create_service_area.spec.ts theme={"dark"}
import { test } from '@japa/runner'
import app from '@adonisjs/core/services/app'
import { fakeAttract } from '@fetchski/attract-cms-adonis/testing'
import CreateServiceAreaController from '#controllers/create_service_area_controller'

test('serviceAreas.createServiceArea', async () => {
  const site = fakeAttract()

  const controller = await app.container.make(CreateServiceAreaController)
  await controller.handle()

  site.assertCalled('serviceAreas.createServiceArea')
})
```

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

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

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

test('serviceAreas.createServiceArea answers your values', async ({ assert }) => {
  const site = fakeAttract({
    'serviceAreas.createServiceArea': factories.ServiceArea({ title: 'Your value' }),
  })

  const serviceArea = await site.serviceAreas().createServiceArea({ title: 'Example title' })
  assert.containSubset(serviceArea, { title: 'Your value' })
})
```

## Related

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

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

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

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

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

> [card] [Update a service area](https://docs.fetchski-attract.com/adonisjs/reference/service-areas/update-service-area.md)
>
> `site.serviceAreas().updateServiceArea()`

> [card] [POST /service-area](https://docs.fetchski-attract.com/api-reference/service-areas/create-a-service-area.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.