---
title: "Add or drop service areas"
method: POST
path: "/v1/business/area"
tags: ["Run"]
---

# Add or drop service areas

`POST /v1/business/area`

## Request

- Base URL: `https://api.nogpets.com`
- URL: `https://api.nogpets.com/v1/business/area`
- Auth: one of:
  - OAuth 2 (authorization code, authorization URL `https://api.nogpets.com/oauth/authorize`, token URL `https://api.nogpets.com/oauth/token`, scopes: `business:manage`)
  - HTTP bearer

Adds areas (suburbs with postal codes, postal codes, or a radius around a place), which NogPets reviews before they take bookings, and/or drops areas (removeAreaIds, at once; bookings already made stay). Needs confirm after the summary. Needs business:manage; the signed-in person must be an owner, manager or staff member of an approved NogPets business (bizId only if they run more than one).

## Request body

- AreaChangeRequest
  - `bizId` string
  - `suburbs` object[]
    - `name` string, required
    - `postalCode` string
  - `postalCodes` string[]
  - `center` object
    - `lat` number, required
    - `lng` number, required
  - `radiusKm` number
  - `centerAddress` string: Instead of center: a town, suburb or street in the business's country.
  - `centerName` string
  - `removeAreaIds` Id[]: Areas to stop working in (business_overview's areas).
  - `resourceIds` Id[]: Add the new areas to these only; left out, all.
  - `confirm` boolean: true only after the person saw the summary from the first call and said yes.

## Response `200`

OK

- AreaChangeResult
  - `business` BizRef
    - `bizId` string
    - `name` string
    - `role` string: owner, manager or crew (staff).
    - `country` string
    - `countryName` string
    - `currency` string
    - `timezone` string
    - `canTakeBookings` boolean: False outside South Africa for now: bookings there aren't taken through NogPets.
  - `added` object[]
    - `id` string
    - `name` string
    - `status` string
  - `removed` string[]
  - `overlaps` object[]
  - `summary` string
  - `next` string

## Other responses

- `400`: The input is wrong (`INVALID_ARGUMENT`, or a pricing code such as `ONE_PRIMARY`, `PET_TYPE`, `UNKNOWN_SERVICE`).
- `401`: No token, or it's expired or revoked. The `WWW-Authenticate` header points at the resource metadata.
- `403`: The token lacks a scope (`INSUFFICIENT_SCOPE`, with `details.scope`).
- `404`: Not found, or not the person's.
- `409`: A rule said no: `NO_COVERAGE`, `NO_AVAILABILITY`, `SLOT_TAKEN`, `TOO_LATE`, `CONFIRM_REQUIRED` (with `details.summary`), `NOTHING_TO_PAY`, `SHOP_OFF`, `STOCK`, `SHIPPING`, `DISCOUNT`, `CASH`, `FAILED_PRECONDITION`; business sign-up: `UNDER_REVIEW`, `APPROVED`, `NOT_READY`, `TOO_MANY`, `LISTING_TAKEN`, `PAYFAST_ZA_ONLY`. `NO_COVERAGE` carries `details.leadId`, `details.message` (tell the person) and `details.next`.

---

[API](https://skmtc.dev/nogpets/apis/nogpets-api.md) · [All operations](https://skmtc.dev/nogpets/apis/nogpets-api/llms.txt) · [OpenAPI document](https://skmtc.dev/nogpets/apis/nogpets-api/revisions/a202c1012173?raw)