---
title: "Archive multiple locations"
method: POST
path: "/locations/archive"
tags: ["Locations"]
---

# Archive multiple locations

`POST /locations/archive`

## Request

- Base URL: `https://api.synup.com/api/v4`
- URL: `https://api.synup.com/api/v4/locations/archive`
- Auth: none required
- TypeScript: <https://skmtc.dev/synup/apis/synup-api/docs/locations/archive/post.ts> (a function with typed inputs; its response is checked against the schema)

This API allows you to archive One or More Business Locations.

:::info[]
- Archiving a location does not delete it from your account.
- Archived locations cannot be updated until reactivated.
- The location will be scheduled for archival until the end of the billing cycle.
- Once the invoice for the next month is generated, the location will be archived.
- Payments for archived locations stop after the current billing cycle is completed.

:::

## Headers

- `Authorization` string, required

## Request body

- object
  - `input` object
    - `locationIds` string[], required: Array of location Node IDs to archive

## Response `200`

Locations archived successfully

- object
  - `data` object
    - `archiveLocations` object
      - `bulkEditTaskId` string, nullable
      - `clientMutationId` string, nullable
      - `errors` string[], nullable
      - `result` object[]
        - `errors` string[], nullable
        - `locationId` string: Node ID of the location
        - `status` 'ARCHIVED' | 'ARCHIVE_SCHEDULED': Final status of the archive operation
        - `success` boolean: Whether the operation was successful
      - `success` boolean, nullable

## Other responses

- `400`: Bad request - invalid input
- `401`: Unauthorized - invalid or missing API key
- `403`: Forbidden - insufficient permissions

---

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