Share a service area’s draft

import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const serviceArea = await site.serviceAreas().shareServiceArea({ id: 'clx8m2k4p0000a1b2c3d4e5f6' });

{
  "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"
}

import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const serviceArea = await site.serviceAreas().shareServiceArea({ id: 'clx8m2k4p0000a1b2c3d4e5f6' });

{
  "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 function makes the call on the client it is given, so your code passes the real one and a test passes a fake.

Add the function

src/attract/share-service-area.ts

import type { SiteClient } from '@fetchski/attract-cms-sdk';

export async function shareServiceArea(site: SiteClient, id: string) {
  return site.serviceAreas().shareServiceArea({ id });
}

Call it

A script makes the client once and calls the function:

scripts/share-service-area.ts

import { createSiteClient } from '@fetchski/attract-cms-sdk';
import { shareServiceArea } from '../src/attract/share-service-area.ts';

const site = createSiteClient();
console.log(await shareServiceArea(site, 'clx8m2k4p0000a1b2c3d4e5f6'));

Terminal

node --env-file=.env scripts/share-service-area.ts

A route handler, a job or a queue worker calls it the same way.

Takes the draft’s exact _id (…:en:draft). Answers the draft, with its aposShareKey while the link is on: the link is the draft’s _url with aposShareKey and aposShareId (the draft’s _id) in its query.

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.

TypeScript

import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const row = (await site.serviceAreas().listServiceAreasPick(['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. shareServiceArea({ id }); leave out the optional fields.

string

required

Required. The draft’s exact _id (…:en:draft).

Optional parameters

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. true adds a share key (aposShareKey) to the draft; false (the default) removes it.

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

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

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.

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.

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.

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.

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.

Show ServiceAreaShapesItem

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

readonly ServiceAreaShapesItemPathItem[]

Sometimes sent: undefined when the site leaves it out. A list of ServiceAreaShapesItemPathItem. The ring’s points, in order (at least 3).

Show ServiceAreaShapesItemPathItem

number

Sometimes sent: undefined when the site leaves it out. Latitude in degrees (kept to 6 decimals). -90 to 90.

number

Sometimes sent: undefined when the site leaves it out. Longitude in degrees (kept to 6 decimals). -180 to 180.

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

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.

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

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.

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

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

Show ServiceAreaPublicNamesItem

string

Always sent. Place name.

string

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

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.

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.

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.

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.

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; catch only what you want to react to (see Errors and testing).

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 your sites (createSiteClients()) don’t have.Retried first: No: nothing was sent. Read: message, slug.

setup

The client’s settings are wrong: no FETCHSKI_ATTRACT_URL (or baseUrl), or a malformed API key.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). 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) on the client for longer.

Test it

It calls the function above with a fake client: the fake answers every call with a valid example, so nothing leaves your machine and no settings or key are needed. Run it with node --test.

tests/serviceAreas-shareServiceArea.test.ts

import { test } from 'node:test';
import { fakeSite } from '@fetchski/attract-cms-sdk/testing';
import { shareServiceArea } from '../src/attract/share-service-area.ts';

test('serviceAreas.shareServiceArea', async () => {
  const site = fakeSite();
  await shareServiceArea(site, 'clx8m2k4p0000a1b2c3d4e5f6');
  site.assertCalled('serviceAreas.shareServiceArea', (args) => args.id === 'clx8m2k4p0000a1b2c3d4e5f6');
});

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

tests/serviceAreas-shareServiceArea-answer.test.ts

import assert from 'node:assert/strict';
import { test } from 'node:test';
import { factories, fakeSite } from '@fetchski/attract-cms-sdk/testing';

test('serviceAreas.shareServiceArea answers your values', async () => {
  const site = fakeSite({
    'serviceAreas.shareServiceArea': factories.ServiceArea({ title: 'Your value' })
  });
  const serviceArea = await site.serviceAreas().shareServiceArea({ id: 'clx8m2k4p0000a1b2c3d4e5f6' });
  assert.equal(serviceArea.title, 'Your value');
});

List a service area’s locales

site.serviceAreas().getServiceAreaLocales()

List service areas

site.serviceAreas().listServiceAreas()

Create a service area

site.serviceAreas().createServiceArea()

Get a service area

site.serviceAreas().getServiceArea()

Replace a service area

site.serviceAreas().replaceServiceArea()

Delete a service area

site.serviceAreas().deleteServiceArea()

POST /service-area/{_id}/share

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

import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const serviceArea = await site.serviceAreas().shareServiceArea({ id: 'clx8m2k4p0000a1b2c3d4e5f6' });

{
  "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"
}

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 a service area’s locales

List service areas

Create a service area

Get a service area

Replace a service area

Delete a service area

POST /service-area/{_id}/share

In your app

Find the id

Behavior

Test it

Related

List a service area’s locales

List service areas

Create a service area

Get a service area

Replace a service area

Delete a service area

POST /service-area/{_id}/share