---
title: "Update a prompt"
method: PATCH
path: "/api/v1/prompts/{prompt}"
tags: ["prompts"]
---

# Update a prompt

`PATCH /api/v1/prompts/{prompt}`

## Request

- Base URL: `https://pineprompt.com`
- URL: `https://pineprompt.com/api/v1/prompts/{prompt}`
- Auth: HTTP bearer

Updates a prompt. Every field is optional, so you may send only the fields you would like to change; a field that is omitted keeps its current value. You may pass `monitor_id` to move the prompt to another monitor in the same project, or `tags` to replace the prompt's tag set.

## Path parameters

- `prompt` integer, required

## Headers

- `Pineprompt-Project-Id` integer, required

## Request body

- UpdatePrompt
  - `prompt` string: The new text of the question. May be up to <strong>2000</strong> characters.
  - `is_active` boolean: When set to `true`, the prompt will run on the next daily run; when set to `false`, it will be skipped.
  - `monitor_id` integer: The id of the monitor the prompt should run under. The monitor must belong to the active project. When omitted, the prompt keeps its current monitor. Responses collected so far move with the prompt.
  - `tags` integer[]: Tag ids that replace the prompt's full tag set. Each tag must belong to the active project. When omitted, the prompt's tags are left unchanged.

## Response `200`

OK

- Prompt: A prompt is a single question Pineprompt asks the AI platforms on your behalf. An active prompt runs with its monitor once per day; an inactive prompt keeps its history but no longer runs.
  - `id` integer: The unique ID of the prompt.
  - `monitor_id` integer: The ID of the monitor that owns this prompt.
  - `prompt` string: The question text the monitor asks each platform on every run.
  - `is_active` boolean: Whether the prompt will run on each daily run of its monitor.
  - `monitor` Monitor: A monitor is a configured daily run: a set of prompts bound to one or more AI platforms in a chosen country and language. While a monitor is active, Pineprompt runs it once per day on your behalf.
    - `id` integer: The unique ID of the monitor.
    - `project_id` integer: The ID of the project this monitor runs under.
    - `name` string: The display name of the monitor.
    - `platforms` string[]: The AI platforms the monitor runs against.
    - `country` string: The ISO 3166-1 alpha-2 country code.
    - `language` string: The language the monitor runs in.
    - `is_active` boolean: Whether the monitor will run on its next daily run.
    - `project` Project: A project represents a single brand or site you monitor. Its `brand_id` names the own brand, the brand every core metric is computed for.
      - `id` integer: The unique ID of the project.
      - `organization_id` integer: The ID of the organization that owns the project.
      - `name` string: The display name of the project.
      - `brand_id` integer, nullable: The ID of the project's own brand, or null while none has been designated.
      - `organization` Organization: An organization is the top-level billing entity and tenant boundary in Pineprompt. Every project, member, and API key belongs to exactly one organization.
        - `id` integer: The unique ID of the organization.
        - `name` string: The display name of the organization.
        - `created_at` string, date-time: When the organization was created.
        - `updated_at` string, date-time: When the organization was last updated.
      - `created_at` string, date-time: When the project was created.
      - `updated_at` string, date-time: When the project was last updated.
    - `created_at` string, date-time: When the monitor was created.
    - `updated_at` string, date-time: When the monitor was last updated.
  - `created_at` string, date-time: When the prompt was created.
  - `updated_at` string, date-time: When the prompt was last updated.

## Other responses

- `400`: Missing project header
- `401`: Unauthorized
- `403`: Missing ability
- `404`: Not found
- `422`: Validation failed

---

[API](https://skmtc.dev/pineprompt/apis/pineprompt-api.md) · [All operations](https://skmtc.dev/pineprompt/apis/pineprompt-api/llms.txt) · [OpenAPI document](https://skmtc.dev/pineprompt/apis/pineprompt-api/revisions/05dbb5241a27?raw)