---
title: "Update Prompt Status"
method: PATCH
path: "/{brand_id}/prompts/{prompt_id}"
---

# Update Prompt Status

`PATCH /{brand_id}/prompts/{prompt_id}`

## Request

- Base URL: `https://api.scrunchai.com/v1`
- URL: `https://api.scrunchai.com/v1/{brand_id}/prompts/{prompt_id}`
- Auth: HTTP bearer

Pauses or resumes a prompt. Requires the `configure` scope.

**Pausing** (`status: paused`) stops collection for the prompt and releases its variants from the organization's prompt pool. The prompt keeps its configuration and all of its collected history, and stays readable through `GET /{brand_id}/prompts?status=paused`.

**Resuming** (`status: active`) restores the exact deployment the prompt had when it was paused and re-checks the prompt pool, so it can return `429 quota_exceeded` when the organization no longer has room for the prompt's variants.

Both transitions are idempotent: a prompt already in the requested status returns `200` with the prompt, unchanged.

A transition the prompt's status does not allow (resuming an archived prompt, resuming one whose persona is archived) returns `409` with a `type` naming the reason. To archive a prompt, use `DELETE /{brand_id}/prompts/{prompt_id}` instead.

## Path parameters

- `brand_id` integer, required: The unique identifier for the brand
- `prompt_id` integer, required: The unique identifier for the prompt to update

## Request body

- APIPromptPatchInput: Body of the public prompt PATCH. `status` is the only mutable field — a prompt's text, platforms and labels are fixed at create time.
  - `status` 'active' | 'paused', required: The lifecycle status to move the prompt to. - `paused` - stop collecting for this prompt and release its variants from the organization's prompt pool; its configuration and history are kept - `active` - resume collecting with the exact deployment the prompt had when it was paused `archived` is not accepted here - archive a prompt with `DELETE /{brand_id}/prompts/{prompt_id}`.

## Response `200`

Successful Response

- PromptListing: Represents a prompt being tracked for AI visibility, including its configuration and metadata.
  - `id` integer, required: Unique identifier for the prompt
  - `text` string, required: The prompt text being tracked
  - `stage` string, required: The customer journey stage this prompt represents — one of the brand's stages (custom stage names included)
  - `persona_id` integer, nullable, required: ID of the associated persona, if any
  - `platforms` string[], required: AI platforms this prompt is tracked on
  - `tags` string[], required: Custom tags assigned to this prompt
  - `topics` string[], required: Auto-detected or assigned topics for this prompt
  - `branded` boolean, required: Whether this prompt explicitly mentions the brand
  - `favorite` boolean, required: Whether this prompt is marked as a favorite
  - `status` 'active' | 'paused' | 'archived', required: Lifecycle status of the prompt (`active`, `paused`, or `archived`)
  - `created_at` string, date-time, required: Timestamp when the prompt was created

## Other responses

- `422`: Validation Error

## Changes

- **2026-10-29** `fa6217fdd4e1`: 1 warning
  - added the new `deepseek` enum value to the `platforms/items/` response property for the response status `200`
- **2026-09-15** `63f48f457eef`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/scrunchai/apis/scrunch-data-api/changes/:brand_id/prompts/:prompt_id/patch.md)

---

[API](https://skmtc.dev/scrunchai/apis/scrunch-data-api.md) - [All operations](https://skmtc.dev/scrunchai/apis/scrunch-data-api/llms.txt) - [OpenAPI document](https://skmtc.dev/scrunchai/apis/scrunch-data-api/revisions/de4fc679600a?raw)