curl --request PATCH \
--url https://api.athenahq.ai/api/v1/prompts/{prompt_id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"website_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prompt": "<string>",
"volume": "<string>",
"topic_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"countries": [
"<string>"
],
"primary_country": "<string>",
"location_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
'import requests
url = "https://api.athenahq.ai/api/v1/prompts/{prompt_id}"
payload = {
"website_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prompt": "<string>",
"volume": "<string>",
"topic_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"countries": ["<string>"],
"primary_country": "<string>",
"location_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
website_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
prompt: '<string>',
volume: '<string>',
topic_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
countries: ['<string>'],
primary_country: '<string>',
location_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
})
};
fetch('https://api.athenahq.ai/api/v1/prompts/{prompt_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.athenahq.ai/api/v1/prompts/{prompt_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'website_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'prompt' => '<string>',
'volume' => '<string>',
'topic_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'countries' => [
'<string>'
],
'primary_country' => '<string>',
'location_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.athenahq.ai/api/v1/prompts/{prompt_id}"
payload := strings.NewReader("{\n \"website_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"prompt\": \"<string>\",\n \"volume\": \"<string>\",\n \"topic_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"countries\": [\n \"<string>\"\n ],\n \"primary_country\": \"<string>\",\n \"location_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.athenahq.ai/api/v1/prompts/{prompt_id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"website_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"prompt\": \"<string>\",\n \"volume\": \"<string>\",\n \"topic_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"countries\": [\n \"<string>\"\n ],\n \"primary_country\": \"<string>\",\n \"location_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.athenahq.ai/api/v1/prompts/{prompt_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"website_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"prompt\": \"<string>\",\n \"volume\": \"<string>\",\n \"topic_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"countries\": [\n \"<string>\"\n ],\n \"primary_country\": \"<string>\",\n \"location_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"text": "<string>",
"type": "<string>",
"volume": "<string>",
"topic_id": "<string>",
"locations": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
],
"countries": [
"<string>"
],
"before": {
"text": "<string>",
"type": "<string>",
"volume": "<string>",
"topic_id": "<string>",
"countries": [
"<string>"
],
"location_ids": [
"<string>"
]
}
}{
"error": "Prompt text cannot be edited once the prompt has responses. Delete the prompt and create a new one with the updated text."
}{
"error": "Unauthorized"
}{
"error": "Unauthorized access to this website"
}{
"error": "Prompt not found"
}{
"error": "Unauthorized"
}Update Prompt
Updates a prompt’s metadata (text, type, volume, topic, geography, locations). Only the supplied fields change. Returns a before/after snapshot.
A prompt’s text (prompt) can only be changed while the prompt has not streamed any responses yet. Once it has responses, sending a changed prompt returns 400 — delete the prompt and create a new one instead. All other fields (type, volume, topic, geography, locations) remain editable at any time, and re-sending the existing text unchanged is always allowed.
curl --request PATCH \
--url https://api.athenahq.ai/api/v1/prompts/{prompt_id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"website_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prompt": "<string>",
"volume": "<string>",
"topic_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"countries": [
"<string>"
],
"primary_country": "<string>",
"location_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
'import requests
url = "https://api.athenahq.ai/api/v1/prompts/{prompt_id}"
payload = {
"website_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prompt": "<string>",
"volume": "<string>",
"topic_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"countries": ["<string>"],
"primary_country": "<string>",
"location_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
website_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
prompt: '<string>',
volume: '<string>',
topic_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
countries: ['<string>'],
primary_country: '<string>',
location_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
})
};
fetch('https://api.athenahq.ai/api/v1/prompts/{prompt_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.athenahq.ai/api/v1/prompts/{prompt_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'website_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'prompt' => '<string>',
'volume' => '<string>',
'topic_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'countries' => [
'<string>'
],
'primary_country' => '<string>',
'location_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.athenahq.ai/api/v1/prompts/{prompt_id}"
payload := strings.NewReader("{\n \"website_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"prompt\": \"<string>\",\n \"volume\": \"<string>\",\n \"topic_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"countries\": [\n \"<string>\"\n ],\n \"primary_country\": \"<string>\",\n \"location_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.athenahq.ai/api/v1/prompts/{prompt_id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"website_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"prompt\": \"<string>\",\n \"volume\": \"<string>\",\n \"topic_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"countries\": [\n \"<string>\"\n ],\n \"primary_country\": \"<string>\",\n \"location_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.athenahq.ai/api/v1/prompts/{prompt_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"website_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"prompt\": \"<string>\",\n \"volume\": \"<string>\",\n \"topic_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"countries\": [\n \"<string>\"\n ],\n \"primary_country\": \"<string>\",\n \"location_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"text": "<string>",
"type": "<string>",
"volume": "<string>",
"topic_id": "<string>",
"locations": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
],
"countries": [
"<string>"
],
"before": {
"text": "<string>",
"type": "<string>",
"volume": "<string>",
"topic_id": "<string>",
"countries": [
"<string>"
],
"location_ids": [
"<string>"
]
}
}{
"error": "Prompt text cannot be edited once the prompt has responses. Delete the prompt and create a new one with the updated text."
}{
"error": "Unauthorized"
}{
"error": "Unauthorized access to this website"
}{
"error": "Prompt not found"
}{
"error": "Unauthorized"
}Path Parameters
The prompt to update.
Body
Website that owns the prompt.
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.
discovery, high_intent 1000When countries is non-empty it must be one of them.
1000Was this page helpful?