Add keywords

POST

https://api.synup.com/api/v4/locations/keywords

This API allows you to add keywords that you want to track, for a specific location.

Limitations: The number of keywords that can be added for a location is subject to your subscription plan. Please consult the support team to determine the exact number applicable to your account.

Request

Header Params

Body Params application/json

Example

{
  "locationId": "TG9jYXRpb246MTM5OTg=",
  "inputKeywords": ["road paving", "road building"]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.synup.com/api/v4/locations/keywords' \
--header 'Authorization: API T9V35W3xxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
  "locationId": "TG9jYXRpb246MTM5OTg=",
  "inputKeywords": ["road paving", "road building"]
}'

Responses

🟢200Success

application/json

Body

Examples

SuccessIf keyword already exists

{
    "data": {
        "addKeywords": {
            "keywords": [
                {
                    "id": "S2V5d29yZDoxOTM2Nzk1",
                    "primary": null,
                    "archived": false,
                    "archiveReasonId": null,
                    "databaseId": 1936795,
                    "name": "road paving"
                },
                {
                    "id": "S2V5d29yZDoxOTM2Nzk2",
                    "primary": null,
                    "archived": false,
                    "archiveReasonId": null,
                    "databaseId": 1936796,
                    "name": "road building"
                }
            ],
            "errors": null
        }
    }
}

Modified at 2025-07-16 11:37:23

Rankings Analytics Attributes

List Keywords