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
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type | string | required |
Body
| Name | Type | Required | Description |
|---|---|---|---|
input | object | optional | |
input.locationIds | array of string | required | Array 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=="
]
}
}'const res = await fetch('https://api.synup.com/api/v4/locations/cancel_archive', {
method: 'POST',
headers: {
Authorization: 'API YOUR_API_KEY',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"input": {
"locationIds": [
"TG9jYXRpb246MTE4MzMzMA=="
]
}
}),
});
const data = await res.json();import requests
res = requests.post(
"https://api.synup.com/api/v4/locations/cancel_archive",
headers={
"Authorization": "API YOUR_API_KEY",
"Content-Type": "application/json",
},
json={
"input": {
"locationIds": [
"TG9jYXRpb246MTE4MzMzMA=="
]
}
},
)
data = res.json()req, _ := http.NewRequest("POST", "https://api.synup.com/api/v4/locations/cancel_archive", bytes.NewBufferString(payload))
req.Header.Set("Authorization", "API YOUR_API_KEY")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)Responses
| Status | Description |
|---|---|
200 | Location archival cancellation successful |
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 |
Example response
{
"data": {
"cancelLocationsArchive": {
"bulkEditTaskId": null,
"clientMutationId": null,
"errors": null,
"result": [
{
"errors": null,
"locationId": "TG9jYXRpb246MTE4MzMzMA==",
"status": "ACTIVE",
"success": true
}
],
"success": null
}
}
}Response body
| Name | Type | Required | Description |
|---|---|---|---|
data | object | optional | |
data.cancelLocationsArchive | object | optional | |
data.cancelLocationsArchive.bulkEditTaskId | string | optional | ID of bulk edit task if multiple locations are involved |
data.cancelLocationsArchive.clientMutationId | string | optional | |
data.cancelLocationsArchive.errors | array of string | optional | |
data.cancelLocationsArchive.result | array of object | optional | |
data.cancelLocationsArchive.result[].errors | array of string | optional | |
data.cancelLocationsArchive.result[].locationId | string | optional | Node ID of the location |
data.cancelLocationsArchive.result[].status | string | optional | Status after cancellationACTIVE |
data.cancelLocationsArchive.result[].success | boolean | optional | Whether the operation was successful |
data.cancelLocationsArchive.success | boolean | optional |