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

Activate archived locations

Use this API to reactivate one or more previously archived locations, allowing them to be updated and managed again.

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 activate

Request

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

Responses

StatusDescription
200Locations activated successfully
400Bad request - invalid input
401Unauthorized - invalid or missing API key
403Forbidden - insufficient permissions
Example response
{
  "data": {
    "activateLocations": {
      "bulkEditTaskId": null,
      "clientMutationId": null,
      "errors": null,
      "result": [
        {
          "errors": null,
          "locationId": "TG9jYXRpb246MTE3MTM4OQ==",
          "status": "ACTIVE",
          "success": true
        }
      ],
      "success": null
    }
  }
}

Response body

NameTypeRequiredDescription
dataobjectoptional
data.activateLocationsobjectoptional
data.activateLocations.bulkEditTaskIdstringoptionalID of bulk edit task if multiple locations are being activated
data.activateLocations.clientMutationIdstringoptional
data.activateLocations.errorsarray of stringoptional
data.activateLocations.resultarray of objectoptional
data.activateLocations.result[].errorsarray of stringoptional
data.activateLocations.result[].locationIdstringoptionalNode ID of the location
data.activateLocations.result[].statusstringoptionalFinal status of the activation operation
ACTIVE
data.activateLocations.result[].successbooleanoptionalWhether the operation was successful
data.activateLocations.successbooleanoptional