prompts

Update a prompt

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.

patch/api/v1/prompts/{prompt}

Request

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

Path parameters

promptinteger required
Example:901

The numeric ID of the prompt.

Headers

Pineprompt-Project-Idinteger required

The active project's numeric ID.

Request body

promptstring

The new text of the question. May be up to <strong>2000</strong> characters.

is_activeboolean

When set to true, the prompt will run on the next daily run; when set to false, it will be skipped.

monitor_idinteger

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.

tagsinteger[]

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.

Example request

{
  "prompt": "Which AI visibility tools support Google AI Overviews?",
  "is_active": true,
  "monitor_id": 271,
  "tags": [
    12,
    19
  ]
}

Response

OK

idinteger

The unique ID of the prompt.

monitor_idinteger

The ID of the monitor that owns this prompt.

promptstring

The question text the monitor asks each platform on every run.

is_activeboolean

Whether the prompt will run on each daily run of its monitor.

created_atstring date-time

When the prompt was created.

updated_atstring date-time

When the prompt was last updated.

Example response

{
  "id": 901,
  "monitor_id": 271,
  "prompt": "What are the best AI visibility monitoring tools?",
  "is_active": true,
  "monitor": {
    "id": 271,
    "project_id": 42,
    "name": "Brand visibility (US)",
    "platforms": [
      "chatgpt",
      "perplexity",
      "claude"
    ],
    "country": "US",
    "language": "en",
    "is_active": true,
    "project": {
      "id": 42,
      "organization_id": 7,
      "name": "Acme Marketing",
      "brand_id": 555,
      "organization": {
        "id": 7,
        "name": "Acme Inc.",
        "created_at": "2026-05-15T09:11:42+00:00",
        "updated_at": "2026-05-15T09:11:42+00:00"
      },
      "created_at": "2026-05-15T09:11:42+00:00",
      "updated_at": "2026-05-15T09:11:42+00:00"
    },
    "created_at": "2026-05-15T09:11:42+00:00",
    "updated_at": "2026-05-15T09:11:42+00:00"
  },
  "created_at": "2026-05-15T09:11:42+00:00",
  "updated_at": "2026-05-15T09:11:42+00:00"
}

Changes

No recorded changes to this operation across all 1 revision of this API.