POSTapi.synup.com/api/v4/locations/keywords
Add keywords
This API allows you to add keywords that you want to track, for a specific location.
Requires an API key. Send it as
Authorization: API <your-key> — see Getting started.Parameters
Headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type | string | required |
Body
| Name | Type | Required | Description |
|---|---|---|---|
locationId | string | required | |
inputKeywords | array of string | required |
Request
Request
curl -X POST 'https://api.synup.com/api/v4/locations/keywords' \
-H 'Authorization: API YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"locationId": "TG9jYXRpb246MTM5OTg=",
"inputKeywords": [
"road paving",
"road building"
]
}'const res = await fetch('https://api.synup.com/api/v4/locations/keywords', {
method: 'POST',
headers: {
Authorization: 'API YOUR_API_KEY',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"locationId": "TG9jYXRpb246MTM5OTg=",
"inputKeywords": [
"road paving",
"road building"
]
}),
});
const data = await res.json();import requests
res = requests.post(
"https://api.synup.com/api/v4/locations/keywords",
headers={
"Authorization": "API YOUR_API_KEY",
"Content-Type": "application/json",
},
json={
"locationId": "TG9jYXRpb246MTM5OTg=",
"inputKeywords": [
"road paving",
"road building"
]
},
)
data = res.json()req, _ := http.NewRequest("POST", "https://api.synup.com/api/v4/locations/keywords", 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 |
Example response (generated from the schema)
{
"data": {
"addKeywords": {
"keywords": [
{
"id": "string",
"primary": null,
"archived": true,
"archiveReasonId": null,
"databaseId": 0,
"name": "string"
}
],
"errors": null
}
}
}Response body
| Name | Type | Required | Description |
|---|---|---|---|
data | object | required | |
data.addKeywords | object | required | |
data.addKeywords.keywords | array of object | required | |
data.addKeywords.keywords[].id | string | required | |
data.addKeywords.keywords[].primary | null | required | |
data.addKeywords.keywords[].archived | boolean | required | |
data.addKeywords.keywords[].archiveReasonId | null | required | |
data.addKeywords.keywords[].databaseId | integer | required | |
data.addKeywords.keywords[].name | string | required | |
data.addKeywords.errors | null | required |