Cancel scheduled location archival

POST

https://api.synup.com/api/v4/locations/cancel_archive

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

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.

Request

Header Params

Body Params application/json

Example

{
    "input": {
        "locationIds": [
            "TG9jYXRpb246MTE4MzMzMA=="
        ]
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.synup.com/api/v4/locations/cancel_archive' \
--header 'Authorization: API T9V35W3xxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
    "input": {
        "locationIds": [
            "TG9jYXRpb246MTE4MzMzMA=="
        ]
    }
}'

Responses

🟢200OK

application/json

Location archival cancellation successful

Body

Example

{
    "data": {
        "cancelLocationsArchive": {
            "bulkEditTaskId": null,
            "clientMutationId": null,
            "errors": null,
            "result": [
                {
                    "errors": null,
                    "locationId": "TG9jYXRpb246MTE4MzMzMA==",
                    "status": "ACTIVE",
                    "success": true
                }
            ],
            "success": null
        }
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

Modified at 2025-07-15 14:18:51

Archive multiple locations

Activate archived locations