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

# Pause or resume a prompt

> Toggle whether a tracked prompt is measured. Requires a paid plan.



## OpenAPI

````yaml https://api.spreadjam.com/openapi.json post /v1/prompts/{promptId}/pause
openapi: 3.0.0
info:
  title: SpreadJam API
  version: 1.0.0
servers: []
security: []
tags:
  - name: Meta
    description: Identity and metadata about the authenticated key.
  - name: Keywords
    description: Keyword and topic visibility rankings.
  - name: API keys
    description: Manage the workspace's API keys.
  - name: Analytics
    description: AI-visibility analytics for the workspace.
  - name: Brand
    description: The workspace's brand profile and competitors.
  - name: Prompts
    description: Tracked GEO prompts and their cap state.
paths:
  /v1/prompts/{promptId}/pause:
    post:
      tags:
        - Prompts
      summary: Pause or resume a prompt
      description: Toggle whether a tracked prompt is measured. Requires a paid plan.
      parameters:
        - schema:
            type: string
            minLength: 1
            example: prompt-123
          required: true
          name: promptId
          in: path
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PausePrompt'
      responses:
        '200':
          description: The prompt with its new status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PausePromptResult'
      security:
        - bearerAuth: []
components:
  schemas:
    PausePrompt:
      type: object
      properties:
        paused:
          type: boolean
          description: true to pause tracking, false to resume.
        reason:
          type: string
          nullable: true
          description: Optional note on why the prompt was paused.
      required:
        - paused
    PausePromptResult:
      type: object
      properties:
        promptId:
          type: string
        status:
          type: string
      required:
        - promptId
        - status
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        A workspace API key issued in Settings → Developer, sent as `Bearer
        sk_…`.

````

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