Skip to main content
PUT
Update a keyword

Authorizations

Authorization
string
header
required

API key starting with sk_. Generate one in Settings > API Keys.

Path Parameters

id
string
required

Keyword ID.

Body

application/json
focusPromptId
string
required

ID of a GEO prompt linked to this keyword — becomes the focus prompt. Removing an existing focus prompt is not supported.

Response

200 - application/json

Default Response

analysisStatus
enum<string> | null
required

Status of the SEO analysis.

Available options:
queued,
pending,
success,
failed
analyzed
boolean
required

Whether the keyword has been analyzed.

clicks
number | null
required

Search clicks.

createdAt
string
required

ISO 8601 creation date.

ctr
number | null
required

Click-through rate.

focusPrompt
object | null
required

Focus GEO prompt linked to this keyword.

id
string
required

Unique identifier of the keyword.

impressions
number | null
required

Search impressions.

isCannibalized
boolean | null
required

Whether the keyword is cannibalized.

keyword
string
required

The keyword text.

keywordDifficulty
number | null
required

SEO difficulty score (0-100).

position
number | null
required

Current SERP position.

searchVolume
number | null
required

Monthly search volume.

source
string | null
required

Source of the keyword.