monitors

Update a monitor

Updates a monitor. 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. Platforms sent without a country are validated against the monitor's stored country, and a country sent without platforms must be supported by every platform the monitor already runs on.

patch/api/v1/monitors/{monitor}

Request

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

Path parameters

monitorinteger required
Example:271

The numeric ID of the monitor.

Headers

Pineprompt-Project-Idinteger required

The active project's numeric ID.

Request body

namestring

A human-readable name for the monitor. May be up to <strong>120</strong> characters.

platformsstring[]

The AI platforms you would like the monitor to run against. Each platform must support the chosen country.

countrystring

A two-letter <a href='https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2' class='underline'>ISO 3166-1 alpha-2</a> country code. Pineprompt stores the value uppercased.

languagestring

A two-letter language code, such as en or nl. The field allows up to 10 characters so that regional variants may be expressed when needed.

is_activeboolean

When set to true, the monitor will run on its next daily run. When set to false, the monitor is paused.

Example request

{
  "name": "Brand visibility, US",
  "platforms": [
    "chatgpt",
    "perplexity",
    "claude"
  ],
  "country": "US",
  "language": "en",
  "is_active": true
}

Response

OK

idinteger

The unique ID of the monitor.

project_idinteger

The ID of the project this monitor runs under.

namestring

The display name of the monitor.

platformsstring[]

The AI platforms the monitor runs against.

countrystring

The ISO 3166-1 alpha-2 country code.

languagestring

The language the monitor runs in.

is_activeboolean

Whether the monitor will run on its next daily run.

created_atstring date-time

When the monitor was created.

updated_atstring date-time

When the monitor was last updated.

Example response

{
  "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"
}

Changes

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