Change a tracked keyword's depth, cadence or tags.

PATCHhttps://api.appgoat.ai/v1/tracked-keywords/{id}

FreeoperationId updateTrackedKeyword

Request

curl -X PATCH "https://api.appgoat.ai/v1/tracked-keywords/123" \
  -H "x-api-key: $APPGOAT_API_KEY" \
  -H "content-type: application/json" \
  -d '{"depth":1,"cadenceMinutes":1,"tags":["string"]}'

const res = await fetch("https://api.appgoat.ai/v1/tracked-keywords/123", {
  method: 'PATCH',
  headers: {
    "x-api-key": process.env.APPGOAT_API_KEY,
    "content-type": "application/json",
  },
  body: JSON.stringify({"depth":1,"cadenceMinutes":1,"tags":["string"]}),
});
const { data, meta } = await res.json();

import os, requests

res = requests.patch(
    "https://api.appgoat.ai/v1/tracked-keywords/123",
    headers={"x-api-key": os.environ["APPGOAT_API_KEY"]},
    json={"depth":1,"cadenceMinutes":1,"tags":["string"]}
)
body = res.json()

Path parameters

idintegerrequired

Request body

JSON, required.

depthinteger

cadenceMinutesinteger

tagsstring[] | null

Response

200 with data: TrackedKeyword. See the envelope for meta.

idinteger

termstring

storeStore

countrystring

depthinteger

cadence_minutesinteger

tagsstring[] | null

popularityinteger | null

last_run_atstring | null

top10string[] | null

ranked_atstring | null

Example

{
  "data": {
    "id": 1,
    "term": "photo editor",
    "store": "apple",
    "country": "us",
    "depth": 1,
    "cadence_minutes": 1,
    "tags": [
      "string"
    ],
    "popularity": 1,
    "last_run_at": "2026-10-22T10:00:00Z",
    "top10": [
      "string"
    ],
    "ranked_at": "2026-10-22T10:00:00Z"
  },
  "meta": {
    "credits_used": 0,
    "credits_remaining": 9981,
    "request_id": "req_123"
  }
}

Status codes

200

The updated tracked keyword.

401invalid_api_key

Missing or invalid API key.

404not_found

Not found.

429rate_limited

Too many requests per second for your plan.