Write

Update the note and/or starred flag on a tracked keyword

id is the tracked-keyword UUID (the id field from GET /apps/{id}/keywords, not keyword_id). At least one of note/starred must be present. Requires an Indie or Agency plan and a write-scope API key.

patch/api/v1/tracked-keywords/{id}

Request

  • Base URL: https://api.trysonar.app
  • URL: https://api.trysonar.app/api/v1/tracked-keywords/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Tracked-keyword UUID

Request body

notestring nullable

Note text; null or empty clears it

starredboolean

true marks the keyword as a favorite/target (sets starred_at), false unstars it

Response

Updated tracked keyword

dataobject required

Result payload — full field reference at https://trysonar.app/docs/api

Changes

No recorded changes to this operation across all 2 revisions of this API.