Skip to main content
POST
Flag keywords as saved.

Authorizations

X-API-Key
string
header
required

Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.

Body

application/json

Keywords to save

Flag keywords as saved. Operates on existing keyword rows; a keyword with no metrics yet is reported as missing rather than created blank.

companyId
string
required

Company ID

keywords
string[]
required

Keywords to save. Lowercased and deduped automatically.

saved
boolean

Set false to unsave instead. Defaults to true.

tags
string[]

Labels to apply to all of these keywords

notes
string

Note to attach to all of these keywords

country
string

Country code. Defaults to "us".

language
string

Language code. Defaults to "en".

Response

How many were updated

How many keywords were updated

saved
integer

Keywords whose saved flag was set

missing
integer

Keywords with no metrics row yet, so nothing to flag