SCscrunchai

Update Prompt Status

Changed on

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.

patch/{brand_id}/prompts/{prompt_id}

Request

  • Base URL
    https://api.scrunchai.com/v1
  • Auth
    HTTP bearer

Path parameters

brand_idinteger required

The unique identifier for the brand

prompt_idinteger required

The unique identifier for the prompt to update

Request body

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

Successful Response

idinteger required

Unique identifier for the prompt

textstring required

The prompt text being tracked

stagestring required

The customer journey stage this prompt represents — one of the brand's stages (custom stage names included)

persona_idinteger nullable required

ID of the associated persona, if any

platformsstring[] required

AI platforms this prompt is tracked on

tagsstring[] required

Custom tags assigned to this prompt

topicsstring[] required

Auto-detected or assigned topics for this prompt

brandedboolean required

Whether this prompt explicitly mentions the brand

favoriteboolean required

Whether this prompt is marked as a favorite

status'active' | 'paused' | 'archived' required

Lifecycle status of the prompt (active, paused, or archived)

created_atstring date-time required

Timestamp when the prompt was created

Changes