---
title: "Cancel scheduled location archival"
method: POST
path: "/locations/cancel_archive"
tags: ["Locations"]
---

# Cancel scheduled location archival

`POST /locations/cancel_archive`

## Request

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

Use this API to cancel the archival of locations that are scheduled for archival but have not yet been processed.

:::info[]

**Important Notes:**
- This endpoint can only cancel archival for locations that are in **ARCHIVE_SCHEDULED** status
- Once canceled, the location will return to **ACTIVE** status and can be updated as usual.
- Billing for the location will continue as per the standard cycle.

:::

## Headers

- `Authorization` string, required
- `Content-Type` string, required

## Request body

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

## Response `200`

Location archival cancellation successful

- object
  - `data` object
    - `cancelLocationsArchive` object
      - `bulkEditTaskId` string, nullable: ID of bulk edit task if multiple locations are involved
      - `clientMutationId` string, nullable
      - `errors` string[], nullable
      - `result` object[]
        - `errors` string[], nullable
        - `locationId` string: Node ID of the location
        - `status` 'ACTIVE': Status after cancellation
        - `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
- `404`: Location not found or not in ARCHIVE_SCHEDULED status

---

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