Skip to main content
PATCH
Update a prompt
Updates only the supplied fields. Read the prompt with view=configuration first, including when restoring an archived prompt. Archiving preserves its stored answers and history. Requires an active Business, Agency Business or Enterprise plan. Use an API token with write access enabled. See Writing data for idempotency, conditional requests and error handling.
string
required
Bearer token for your team.
string
required
Copy the complete ETag from the latest GET, including its quotes.
string
required
Workspace identifier. The workspace must belong to the token’s team.
string
required
Prompt UUID within the workspace.
string
Replacement text, 1 to 500 characters after trimming, as in the dashboard. When the text changes in a workspace created from v1.21, Qwairy sets the Branded or Non-branded system tag again from the new text.
string
ACTIVE or ARCHIVED. Archiving retains answers and history; setting ACTIVE restores the prompt.
string | null
NONE, DAILY, WEEKLY, MONTHLY, or null to inherit the workspace schedule.
boolean
Whether the prompt participates in scheduled monitoring.
string | null
Topic UUID in this workspace, or null to detach its current topic.
string[]
Complete replacement list of up to 50 tag UUIDs from this workspace. An empty array removes all tags except the Branded or Non-branded system tag the prompt carries, if any. In a workspace created from v1.21, Qwairy sets that tag from the prompt text. The id of either system tag in this list is ignored, and the tag the prompt carries is kept.
string[]
Complete replacement list of up to 50 uppercase two-letter country codes from the workspace country catalog. An empty array restores the workspace default country.
string[]
Complete replacement list of up to 30 model identifiers for this prompt only. An empty array restores the workspace models.
Supply at least one editable field.

Response

Returns 200, an updated ETag and a prompt object with the fields shown below, including countryCodes and modelIds (empty arrays mean the workspace defaults). There is no top-level success field. Dates use ISO 8601. The version is an opaque concurrency value.

Synthetic request and response

Errors

See Error codes for authentication, plan, idempotency and server errors. On 429, honor Retry-After; writes can return 503 SERVICE_UNAVAILABLE if the write limiter is unavailable.