Skip to content
SynupAPI
Get an API key
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

NameTypeRequiredDescription
inputobjectoptional
input.locationIdsarray of stringrequiredArray 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=="
    ]
  }
}'

Responses

StatusDescription
200Locations archived successfully
400Bad request - invalid input
401Unauthorized - invalid or missing API key
403Forbidden - 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

NameTypeRequiredDescription
dataobjectoptional
data.archiveLocationsobjectoptional
data.archiveLocations.bulkEditTaskIdstringoptional
data.archiveLocations.clientMutationIdstringoptional
data.archiveLocations.errorsarray of stringoptional
data.archiveLocations.resultarray of objectoptional
data.archiveLocations.result[].errorsarray of stringoptional
data.archiveLocations.result[].locationIdstringoptionalNode ID of the location
data.archiveLocations.result[].statusstringoptionalFinal status of the archive operation
ARCHIVEDARCHIVE_SCHEDULED
data.archiveLocations.result[].successbooleanoptionalWhether the operation was successful
data.archiveLocations.successbooleanoptional