POSTapi.synup.com/api/v4/locations/archive
Archive multiple locations
This API allows you to archive One or More Business Locations.
Requires an API key. Send it as
Authorization: API <your-key> — see Getting started.Parameters
Body
| Name | Type | Required | Description |
|---|---|---|---|
input | object | optional | |
input.locationIds | array of string | required | Array of location Node IDs to archive |
Request
Request
curl -X POST 'https://api.synup.com/api/v4/locations/archive' \
-H 'Authorization: API YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"input": {
"locationIds": [
"TG9jYXRpb246MTE4MzMzMA==",
"TG9jYXRpb246MTE3MTM4OQ=="
]
}
}'const res = await fetch('https://api.synup.com/api/v4/locations/archive', {
method: 'POST',
headers: {
Authorization: 'API YOUR_API_KEY',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"input": {
"locationIds": [
"TG9jYXRpb246MTE4MzMzMA==",
"TG9jYXRpb246MTE3MTM4OQ=="
]
}
}),
});
const data = await res.json();import requests
res = requests.post(
"https://api.synup.com/api/v4/locations/archive",
headers={
"Authorization": "API YOUR_API_KEY",
"Content-Type": "application/json",
},
json={
"input": {
"locationIds": [
"TG9jYXRpb246MTE4MzMzMA==",
"TG9jYXRpb246MTE3MTM4OQ=="
]
}
},
)
data = res.json()req, _ := http.NewRequest("POST", "https://api.synup.com/api/v4/locations/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 | Locations archived successfully |
400 | Bad request - invalid input |
401 | Unauthorized - invalid or missing API key |
403 | Forbidden - insufficient permissions |
Example response
{
"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
}
}
}Response body
| Name | Type | Required | Description |
|---|---|---|---|
data | object | optional | |
data.archiveLocations | object | optional | |
data.archiveLocations.bulkEditTaskId | string | optional | |
data.archiveLocations.clientMutationId | string | optional | |
data.archiveLocations.errors | array of string | optional | |
data.archiveLocations.result | array of object | optional | |
data.archiveLocations.result[].errors | array of string | optional | |
data.archiveLocations.result[].locationId | string | optional | Node ID of the location |
data.archiveLocations.result[].status | string | optional | Final status of the archive operationARCHIVEDARCHIVE_SCHEDULED |
data.archiveLocations.result[].success | boolean | optional | Whether the operation was successful |
data.archiveLocations.success | boolean | optional |