Skip to content
SynupAPI
Get an API key
POSTapi.synup.com/api/v4/locations/cancel_archive

Cancel scheduled location archival

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

Requires an API key. Send it as Authorization: API <your-key> — see Getting started.

Parameters

Headers

NameTypeRequiredDescription
Content-Typestringrequired

Body

NameTypeRequiredDescription
inputobjectoptional
input.locationIdsarray of stringrequiredArray of location Node IDs to cancel archival for

Request

Request
curl -X POST 'https://api.synup.com/api/v4/locations/cancel_archive' \
  -H 'Authorization: API YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "input": {
    "locationIds": [
      "TG9jYXRpb246MTE4MzMzMA=="
    ]
  }
}'

Responses

StatusDescription
200Location archival cancellation successful
400Bad request - invalid input
401Unauthorized - invalid or missing API key
403Forbidden - insufficient permissions
404Location not found or not in ARCHIVE_SCHEDULED status
Example response
{
  "data": {
    "cancelLocationsArchive": {
      "bulkEditTaskId": null,
      "clientMutationId": null,
      "errors": null,
      "result": [
        {
          "errors": null,
          "locationId": "TG9jYXRpb246MTE4MzMzMA==",
          "status": "ACTIVE",
          "success": true
        }
      ],
      "success": null
    }
  }
}

Response body

NameTypeRequiredDescription
dataobjectoptional
data.cancelLocationsArchiveobjectoptional
data.cancelLocationsArchive.bulkEditTaskIdstringoptionalID of bulk edit task if multiple locations are involved
data.cancelLocationsArchive.clientMutationIdstringoptional
data.cancelLocationsArchive.errorsarray of stringoptional
data.cancelLocationsArchive.resultarray of objectoptional
data.cancelLocationsArchive.result[].errorsarray of stringoptional
data.cancelLocationsArchive.result[].locationIdstringoptionalNode ID of the location
data.cancelLocationsArchive.result[].statusstringoptionalStatus after cancellation
ACTIVE
data.cancelLocationsArchive.result[].successbooleanoptionalWhether the operation was successful
data.cancelLocationsArchive.successbooleanoptional