---
title: "Archive locations."
method: POST
path: "/api/v4/locations/archive"
tags: ["Locations"]
---

# Archive locations.

`POST /api/v4/locations/archive`

Schedules one or more locations for archival at the end of the current billing cycle.

## Request body

- object
  - `input` ArchiveLocationsInput, required
    - `clientMutationId` string
    - `locationIds` string[], required

## Response `200`

Successful response

- ArchiveLocationsPayload
  - `clientMutationId` string
  - `archivedCount` integer, required
  - `locations` LocationSummaryType[]
    - `id` string, required
    - `databaseId` integer
    - `storeId` string
    - `name` string, required
    - `street` string
    - `city` string
    - `stateIso` string
    - `countryIso` string
    - `postalCode` string
    - `latitude` number, float
    - `longitude` number, float
    - `phone` string
    - `website` string
    - `status` 'ACTIVE' | 'ARCHIVED' | 'PENDING' | 'TEMPORARILY_CLOSED' | 'SCHEDULED_FOR_ARCHIVE' — Lifecycle states of a location.
    - `primaryGbpSiteCategoryId` string
    - `additionalGbpSiteCategoryIds` string[]
    - `serviceArea` ServiceAreaType[]
      - `businessType` string
      - `regionCode` string
      - `placeInfos` PlaceInfoType[]
        - `placeId` string, required
        - `placeName` string
    - `tags` TagType[]
      - `id` string, required
      - `name` string, required
    - `folders` FolderType[]
      - `id` string, required
      - `databaseId` integer
      - `name` string, required
      - `parentId` string
      - `root` boolean
      - `path` string
      - `depth` integer
      - `locationCount` integer
    - `placeActionLinks` PlaceActionLinkType[]
      - `placeActionType` string, required
      - `uri` string, required
      - `isPreferred` boolean
      - `name` string
      - `providerType` string
      - `isEditable` boolean
      - `submissionStatus` string
      - `submissionMessage` string
      - `submissionCode` string
      - `lastSubmittedAt` string
    - `discoveredPlaceActionLinks` PlaceActionLinkType[]
      - `placeActionType` string, required
      - `uri` string, required
      - `isPreferred` boolean
      - `name` string
      - `providerType` string
      - `isEditable` boolean
      - `submissionStatus` string
      - `submissionMessage` string
      - `submissionCode` string
      - `lastSubmittedAt` string
  - `errors` MutationErrorType[]
    - `code` string
    - `message` string, required
    - `path` string[]

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `500` — Server error

---

[API](https://skmtc.net/listingsapi/apis/listings-api.md) · [All operations](https://skmtc.net/listingsapi/apis/listings-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/listingsapi/listings-api/revisions/9274a1eac380/schema)