Skip to main content
PATCH
Update Prompt

Authorizations

x-api-key
string
header
required

API key for authentication. You can create one here.

Path Parameters

prompt_id
string<uuid>
required

The prompt to update.

Body

application/json
website_id
string<uuid>
required

Website that owns the prompt.

prompt
string

New prompt text. Trimmed; blank is rejected. Editable only while the prompt has no responses yet — changing it after responses have streamed returns 400. Re-sending the current text unchanged (e.g. in a full-object PATCH) is always allowed, as are metadata-only edits.

type
enum<string> | null
Available options:
discovery,
high_intent
volume
string | null
topic_id
string<uuid> | null
countries
string[]
Maximum array length: 1000
primary_country
string | null

When countries is non-empty it must be one of them.

location_ids
string<uuid>[]
Maximum array length: 1000

Response

Prompt updated

id
string<uuid>
text
string
type
string | null
volume
string | null
topic_id
string | null
locations
object[]
countries
string[]
before
object

Pre-update snapshot.