Skip to main content
PATCH
/
api
/
v1
/
prompts
/
status
Pause or Unpause Prompts
curl --request PATCH \
  --url https://api.athenahq.ai/api/v1/prompts/status \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "website_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "prompt_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'
{
  "success": true,
  "message": "Paused 1 prompt",
  "changed_count": 1,
  "unchanged_count": 0
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. You can create one here.

Body

application/json
​
website_id
string<uuid>
required
​
prompt_ids
string<uuid>[]
required
Required array length: 1 - 1000 elements
​
status
enum<string>
required

paused to pause, active to unpause.

Available options:
active,
paused

Response

Status updated

​
success
boolean
required
Example:

true

​
message
string
required
Example:

"Paused 1 prompt"

​
changed_count
integer
required
Example:

1

​
unchanged_count
integer
required
Example:

0