> ## Documentation Index
> Fetch the complete documentation index at: https://promptwatch.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Delete Monitor

> Soft-delete a monitor



## OpenAPI

````yaml /v2/openapi.json delete /monitors/{id}
openapi: 3.0.0
info:
  title: Promptwatch API v2
  description: >-
    API v2 for customer integrations with Promptwatch monitoring platform. This
    version provides improved structure, additional endpoints, and enhanced
    functionality.
  version: 2.0.0
  contact:
    name: Promptwatch Support
    email: team@promptwatch.com
    url: https://promptwatch.com
  license:
    name: Commercial
    url: https://promptwatch.com/terms-and-conditions
servers:
  - url: https://server.promptwatch.com/api/v2
    description: Promptwatch API v2
security: []
tags:
  - name: Authentication
    description: API key validation and authentication
  - name: Content
    description: >-
      AI content generation and optimization. Create content asynchronously and
      poll for results.
  - name: Content Gap
    description: Content gap analysis and recommendations
  - name: Models
    description: Available LLM models
  - name: Monitors
    description: Monitor management and CRUD operations
  - name: Page Tracker
    description: Track URLs and inspect citation stats, responses, and prompts
  - name: Prompts
    description: Prompt management and operations
  - name: Query Fanouts
    description: ChatGPT query fanout keywords
  - name: Responses
    description: LLM response data and analytics
  - name: Tags
    description: Tag management for prompts
  - name: Topics
    description: Topic management for prompts
  - name: Actions
    description: Action items (GEO suggestions and tasks)
  - name: Personas
    description: Persona configuration for monitors
  - name: Brands
    description: Brand management for competitive analysis
  - name: Visibility
    description: Brand visibility time series and competitor heatmaps
  - name: Citations
    description: Citation analytics from AI responses
  - name: Analytics
    description: Visitor analytics, AI crawler logs, sentiment, and brand visibility trends
  - name: Projects
    description: Project management (organization-level keys only)
  - name: Sitemap
    description: Sitemap crawl progress and discovered URLs
  - name: Site Health
    description: >-
      Crawled pages with SEO issues (titles, meta descriptions, H1, thin
      content)
  - name: Socials
    description: >-
      Social media citations (Reddit posts and YouTube videos) found in LLM
      responses
paths:
  /monitors/{id}:
    delete:
      tags:
        - Monitors
      summary: Delete Monitor
      description: Soft-delete a monitor
      operationId: deleteMonitor
      parameters:
        - schema:
            type: string
            format: uuid
          in: path
          name: id
          required: true
          description: Monitor ID
      responses:
        '204':
          description: Default Response
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                example:
                  error: Unauthorized
                  message: Missing or invalid X-API-Key header.
                properties:
                  error:
                    type: string
                    description: Error category (often aligned with HTTP semantics)
                  code:
                    type: string
                    description: Optional machine-readable code
                  message:
                    type: string
                    description: Human-readable explanation
                  details:
                    type: object
                    description: Optional structured detail (e.g. validation)
                    additionalProperties: true
                required:
                  - error
                  - message
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                example:
                  code: MONITOR_NOT_FOUND
                  message: Monitor not found
                properties:
                  code:
                    type: string
                    description: Error code indicating the type of error
                    enum:
                      - MONITOR_NOT_FOUND
                      - MONITOR_FORBIDDEN
                      - MONITOR_INVALID_PERSONA
                      - PROMPT_BATCH_LIMIT_REACHED
                      - INTERNAL_ERROR
                    example: MONITOR_NOT_FOUND
                  message:
                    type: string
                    description: Human-readable error message
                    example: Monitor not found
                required:
                  - code
                  - message
                additionalProperties: false
              examples:
                example1:
                  value:
                    code: MONITOR_NOT_FOUND
                    message: Monitor not found
                example2:
                  value:
                    code: MONITOR_FORBIDDEN
                    message: Not authorized to access this monitor
                example3:
                  value:
                    code: MONITOR_INVALID_PERSONA
                    message: Invalid persona or persona does not belong to this project
                example4:
                  value:
                    code: PROMPT_BATCH_LIMIT_REACHED
                    message: generatePrompts total amount cannot exceed 50 per request
                example5:
                  value:
                    code: INTERNAL_ERROR
                    message: An unexpected error occurred
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                example:
                  code: MONITOR_NOT_FOUND
                  message: Monitor not found
                properties:
                  code:
                    type: string
                    description: Error code indicating the type of error
                    enum:
                      - MONITOR_NOT_FOUND
                      - MONITOR_FORBIDDEN
                      - MONITOR_INVALID_PERSONA
                      - PROMPT_BATCH_LIMIT_REACHED
                      - INTERNAL_ERROR
                    example: MONITOR_NOT_FOUND
                  message:
                    type: string
                    description: Human-readable error message
                    example: Monitor not found
                required:
                  - code
                  - message
                additionalProperties: false
              examples:
                example1:
                  value:
                    code: MONITOR_NOT_FOUND
                    message: Monitor not found
                example2:
                  value:
                    code: MONITOR_FORBIDDEN
                    message: Not authorized to access this monitor
                example3:
                  value:
                    code: MONITOR_INVALID_PERSONA
                    message: Invalid persona or persona does not belong to this project
                example4:
                  value:
                    code: PROMPT_BATCH_LIMIT_REACHED
                    message: generatePrompts total amount cannot exceed 50 per request
                example5:
                  value:
                    code: INTERNAL_ERROR
                    message: An unexpected error occurred
      security:
        - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        API key for authentication. Get yours from the Promptwatch dashboard
        under Settings > API Keys.

````