POSTapi.synup.com/api/v4/locations/keywords/archive
Archive a keyword
This API removes a keyword from the list of tracked keywords for a specific location by archiving it.
Requires an API key. Send it as
Authorization: API <your-key> — see Getting started.Parameters
Body
| Name | Type | Required | Description |
|---|---|---|---|
id | string | required | Keyword ID to archive |
Request
Request
curl -X POST 'https://api.synup.com/api/v4/locations/keywords/archive' \
-H 'Authorization: API YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '""'const res = await fetch('https://api.synup.com/api/v4/locations/keywords/archive', {
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/keywords/archive",
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/keywords/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 | Successful response |
400 | Bad Request |
401 | Unauthorized |
Example response (generated from the schema)
{
"data": {
"archiveKeyword": {
"keyword": {
"id": "S2V5d29yZDo3NjQzMTE=",
"archived": true,
"name": "road building"
}
}
}
}Response body
| Name | Type | Required | Description |
|---|---|---|---|
data | object | optional | |
data.archiveKeyword | object | optional | |
data.archiveKeyword.keyword | object | optional | |
data.archiveKeyword.keyword.id | string | optional | The unique ID attached to the keyword |
data.archiveKeyword.keyword.archived | boolean | optional | Indicates if the keyword has been archived |
data.archiveKeyword.keyword.name | string | optional | The text value of the keyword |