Skip to main content
PUT
/
prompts
/
{id}
Update Prompt
curl --request PUT \
  --url https://server.promptwatch.com/api/v2/prompts/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "type": "ORGANIC",
  "intent": "BRANDED"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "prompt": "<string>",
  "type": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "intent": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

API key for authentication. Get yours from the Promptwatch dashboard under Settings > API Keys.

Path Parameters

​
id
string<uuid>
required

Prompt ID

Body

application/json
​
type
enum<string>
required

Type of prompt

Available options:
ORGANIC,
BRAND_SPECIFIC,
COMPETITOR_COMPARISON
​
intent
enum<string>
required

Intent of the prompt

Available options:
BRANDED,
INFORMATIONAL,
NAVIGATIONAL,
COMMERCIAL,
TRANSACTIONAL

Response

Default Response

​
id
string<uuid>
required
​
prompt
string
required
​
type
string
required
​
updatedAt
string<date-time>
required
​
intent
string | null