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

# Deactivate or reactivate prompts in bulk

> Pauses or resumes scheduled runs for up to 2000 prompts, named by id or exact message, optionally on some answer engines only. Unlike archiving, the prompts keep their history in share-of-voice and citation charts. Returns how many conversation queries changed and which inputs matched no prompt.



## OpenAPI

````yaml /api-reference/openapi.json post /api/v1/prompts/bulk-polling
openapi: 3.1.0
info:
  title: The Prompting Company API
  version: 0.1.0
  description: >-
    Machine-readable contract for The Prompting Company organization-scoped API
    routes.
  contact:
    name: The Prompting Company
    url: https://promptingcompany.com/support
    email: support@promptingcompany.com
  license:
    name: Proprietary
    url: https://promptingcompany.com/terms
  termsOfService: https://promptingcompany.com/terms
servers:
  - url: https://app.promptingco.com
    description: Production
  - url: http://localhost:3000
    description: Local development
security: []
tags:
  - name: Visibility & Mentions
  - name: Knowledge
  - name: Content
  - name: Simulations
  - name: Apps & Publishing
  - name: Products
  - name: Service Status
  - name: Account
paths:
  /api/v1/prompts/bulk-polling:
    post:
      tags:
        - Prompts
      summary: Deactivate or reactivate prompts in bulk
      description: >-
        Pauses or resumes scheduled runs for up to 2000 prompts, named by id or
        exact message, optionally on some answer engines only. Unlike archiving,
        the prompts keep their history in share-of-voice and citation charts.
        Returns how many conversation queries changed and which inputs matched
        no prompt.
      operationId: postPromptsBulkPolling
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                productId:
                  type: string
                  minLength: 1
                promptIds:
                  type: array
                  items:
                    type: string
                    minLength: 1
                  maxItems: 2000
                  description: Prompt ids to change.
                messages:
                  type: array
                  items:
                    type: string
                    minLength: 1
                    maxLength: 10000
                  maxItems: 2000
                  description: >-
                    Exact prompt messages to change. Surrounding whitespace is
                    trimmed, then the match is exact and case-sensitive.
                answerEngines:
                  type: array
                  items:
                    type: string
                    enum:
                      - chatgpt
                      - sonar
                      - gemini
                      - claude
                      - claude-code
                      - deepseek
                      - google-ai-mode
                      - openai-codex
                      - grok-bot
                      - muse
                      - dots
                      - instinct
                  minItems: 1
                  description: >-
                    Only change the prompts' conversation queries on these
                    answer engines. Defaults to every engine.
                pollingPaused:
                  type: boolean
                  description: >-
                    true deactivates the prompts (stops scheduled runs, keeps
                    history); false reactivates them.
              required:
                - productId
                - pollingPaused
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                    enum:
                      - true
                  data:
                    type: object
                    properties:
                      updated:
                        type: integer
                        description: Conversation queries whose active state changed.
                      matchedPromptIds:
                        type: array
                        items:
                          type: string
                        description: >-
                          Prompts the request matched, whether or not they
                          changed.
                      unmatched:
                        type: object
                        properties:
                          promptIds:
                            type: array
                            items:
                              type: string
                          messages:
                            type: array
                            items:
                              type: string
                        required:
                          - promptIds
                          - messages
                    required:
                      - updated
                      - matchedPromptIds
                      - unmatched
                required:
                  - ok
                  - data
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                    enum:
                      - false
                  code:
                    type: string
                  message:
                    type: string
                  details: {}
                required:
                  - ok
                  - code
                  - message
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                    enum:
                      - false
                  code:
                    type: string
                  message:
                    type: string
                  details: {}
                required:
                  - ok
                  - code
                  - message
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                    enum:
                      - false
                  code:
                    type: string
                  message:
                    type: string
                  details: {}
                required:
                  - ok
                  - code
                  - message
        '404':
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                    enum:
                      - false
                  code:
                    type: string
                  message:
                    type: string
                  details: {}
                required:
                  - ok
                  - code
                  - message
        '422':
          description: Validation failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                    enum:
                      - false
                  code:
                    type: string
                  message:
                    type: string
                  details: {}
                required:
                  - ok
                  - code
                  - message
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                    enum:
                      - false
                  code:
                    type: string
                  message:
                    type: string
                  details: {}
                required:
                  - ok
                  - code
                  - message
      security:
        - apiKeyAuth: []
        - bearerAuth: []
        - cookieAuth: []
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Organization-scoped API key. Available scopes:

        - content:read: Read site pages, markdown content, and llms.txt files

        - content:write: Create, update, and delete site pages and content

        - prompts:read: Read prompts, topics, Radar topics, prompt suggestions,
        and prompt analysis results

        - prompts:write: Create, update, archive prompts and generate, edit, or
        review prompt suggestions

        - simulations:read: Read agent-simulation tasks, runs, environments, and
        analytics

        - simulations:write: Create and trigger simulation runs

        - logs:read: Read AI-traffic logs and request-level audit events

        - analytics:read: Read analytics aggregates (rankings, mentions,
        sources, SOV)

        - analytics:write: Write events to analytics

        - products:read: Read product metadata and competitor data

        - products:write: Update product settings and competitor lists
      x-scopes:
        content:read: Read site pages, markdown content, and llms.txt files
        content:write: Create, update, and delete site pages and content
        prompts:read: >-
          Read prompts, topics, Radar topics, prompt suggestions, and prompt
          analysis results
        prompts:write: >-
          Create, update, archive prompts and generate, edit, or review prompt
          suggestions
        simulations:read: Read agent-simulation tasks, runs, environments, and analytics
        simulations:write: Create and trigger simulation runs
        logs:read: Read AI-traffic logs and request-level audit events
        analytics:read: Read analytics aggregates (rankings, mentions, sources, SOV)
        analytics:write: Write events to analytics
        products:read: Read product metadata and competitor data
        products:write: Update product settings and competitor lists
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Bearer session or OAuth access token. Available OAuth scopes:

        - content:read: Read site pages, markdown content, and llms.txt files

        - content:write: Create, update, and delete site pages and content

        - prompts:read: Read prompts, topics, Radar topics, prompt suggestions,
        and prompt analysis results

        - prompts:write: Create, update, archive prompts and generate, edit, or
        review prompt suggestions

        - simulations:read: Read agent-simulation tasks, runs, environments, and
        analytics

        - simulations:write: Create and trigger simulation runs

        - logs:read: Read AI-traffic logs and request-level audit events

        - analytics:read: Read analytics aggregates (rankings, mentions,
        sources, SOV)

        - analytics:write: Write events to analytics

        - products:read: Read product metadata and competitor data

        - products:write: Update product settings and competitor lists
      x-scopes:
        content:read: Read site pages, markdown content, and llms.txt files
        content:write: Create, update, and delete site pages and content
        prompts:read: >-
          Read prompts, topics, Radar topics, prompt suggestions, and prompt
          analysis results
        prompts:write: >-
          Create, update, archive prompts and generate, edit, or review prompt
          suggestions
        simulations:read: Read agent-simulation tasks, runs, environments, and analytics
        simulations:write: Create and trigger simulation runs
        logs:read: Read AI-traffic logs and request-level audit events
        analytics:read: Read analytics aggregates (rankings, mentions, sources, SOV)
        analytics:write: Write events to analytics
        products:read: Read product metadata and competitor data
        products:write: Update product settings and competitor lists
    cookieAuth:
      type: apiKey
      in: cookie
      name: better-auth.session_token
      description: First-party browser session cookie.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.