Skip to main content
PATCH
Update Prompt

Authorizations

Authorization
string
header
required

Team API key created in Team Settings. Use it with URLs for the same team.

Path Parameters

project
string<uuid>
required

Project UUID.

prompt
string<uuid>
required

Prompt UUID.

Body

application/json

Partial update. Only the fields present are applied.

text
string
Maximum string length: 700
country_code
string

ISO 3166-1 alpha-2 code of an active country.

topic
string | null

Topic name (created if it doesn't exist), or null to clear the topic.

Maximum string length: 255
status
enum<string>

Activating is subject to the project's prompt limit and the team's credits.

Available options:
active,
inactive

Response

The updated prompt.

uuid
string<uuid>
required
text
string
required

The prompt text.

keyword
string | null
required
status
enum<string>
required
Available options:
suggestion,
declined,
inactive,
active
search_volume
integer | null
required

Most recent search volume for the prompt's keyword, when known.

topic
object | null
required
country
object
required
tags
object[]
required
created_at
string<date-time>
required
updated_at
string<date-time>
required