Archive multiple locations

POST

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

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

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.

Request

Header Params

Body Params application/json

Example

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

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/archive' \
--header 'Authorization: API T9V35W3xxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
    "input": {
        "locationIds": [
            "TG9jYXRpb246MTE4MzMzMA==",
            "TG9jYXRpb246MTE3MTM4OQ=="
        ]
    }
}'

Responses

🟢200OK

application/json

Locations archived successfully

Body

Example

{
    "data": {
        "archiveLocations": {
            "bulkEditTaskId": null,
            "clientMutationId": null,
            "errors": null,
            "result": [
                {
                    "errors": null,
                    "locationId": "TG9jYXRpb246MTE3MTM4OQ==",
                    "status": "ARCHIVE_SCHEDULED",
                    "success": true
                },
                {
                    "errors": null,
                    "locationId": "TG9jYXRpb246MTE4MzMzMA==",
                    "status": "ARCHIVE_SCHEDULED",
                    "success": true
                }
            ],
            "success": null
        }
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

Modified at 2025-02-24 11:41:44

Delete Location Photos

Cancel scheduled location archival