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
| Name | Type | Required | Description |
|---|---|---|---|
input | object | required | |
input.locationId | string | required | Unique identifier of the location to remove from the tag |
input.tag | string | required | Name 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 '""'const res = await fetch('https://api.synup.com/api/v4/locations/tags/remove', {
method: 'POST',
headers: {
Authorization: 'API YOUR_API_KEY',
'Content-Type': 'application/json',
},
body: JSON.stringify(""),
});
const data = await res.json();import requests
res = requests.post(
"https://api.synup.com/api/v4/locations/tags/remove",
headers={
"Authorization": "API YOUR_API_KEY",
"Content-Type": "application/json",
},
json="",
)
data = res.json()req, _ := http.NewRequest("POST", "https://api.synup.com/api/v4/locations/tags/remove", 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 | Operation result |
400 | Bad request - Invalid location ID or tag name |
401 | Unauthorized - Authentication required |
403 | Forbidden - Insufficient permissions |
404 | Location or tag not found |
Example response
{
"data": {
"removeTag": {
"clientMutationId": null,
"errors": [],
"success": true,
"tag": {
"id": "8e1ddaa4-6230-4b29-8107-6ad1b7b33fca",
"name": "Old"
}
}
}
}Response body
| Name | Type | Required | Description |
|---|---|---|---|
data | object | optional | |
data.removeTag | object | optional | |
data.removeTag.clientMutationId | object | optional | Optional client-provided mutation identifier |
data.removeTag.errors | array of object | optional | Array of errors if any occurred during the operation |
data.removeTag.errors[].code | string | optional | Error code |
data.removeTag.errors[].message | string | optional | Human-readable error message |
data.removeTag.success | boolean | optional | Indicates if the removal operation was successful |
data.removeTag.tag | object | optional | Details of the tag from which the location was removed |
data.removeTag.tag.id | string | optional | Unique identifier of the tag |
data.removeTag.tag.name | string | optional | Name of the tag |