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

Remove location from a tag

Removes the association between a location and a specified tag. This operation:

  • Only removes the association, it does not delete the tag itself
  • Does not affect other locations that may be associated with the same tag
  • Returns success even if the location was not previously associated with the tag
Requires an API key. Send it as Authorization: API <your-key> — see Getting started.

Parameters

Body

NameTypeRequiredDescription
inputobjectrequired
input.locationIdstringrequiredUnique identifier of the location to remove from the tag
input.tagstringrequiredName of the tag to remove the location from

Request

Request
curl -X POST 'https://api.synup.com/api/v4/locations/tags/remove' \
  -H 'Authorization: API YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '""'

Responses

StatusDescription
200Operation result
400Bad request - Invalid location ID or tag name
401Unauthorized - Authentication required
403Forbidden - Insufficient permissions
404Location or tag not found
Example response
{
  "data": {
    "removeTag": {
      "clientMutationId": null,
      "errors": [],
      "success": true,
      "tag": {
        "id": "8e1ddaa4-6230-4b29-8107-6ad1b7b33fca",
        "name": "Old"
      }
    }
  }
}

Response body

NameTypeRequiredDescription
dataobjectoptional
data.removeTagobjectoptional
data.removeTag.clientMutationIdobjectoptionalOptional client-provided mutation identifier
data.removeTag.errorsarray of objectoptionalArray of errors if any occurred during the operation
data.removeTag.errors[].codestringoptionalError code
data.removeTag.errors[].messagestringoptionalHuman-readable error message
data.removeTag.successbooleanoptionalIndicates if the removal operation was successful
data.removeTag.tagobjectoptionalDetails of the tag from which the location was removed
data.removeTag.tag.idstringoptionalUnique identifier of the tag
data.removeTag.tag.namestringoptionalName of the tag