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

# Update Prompt

> Partially updates a prompt. Only the fields present are applied. `status` toggles between `active` and `inactive`; activating a prompt is subject to the project's prompt limit and the team's available credits. Pass `topic: null` to clear the topic. Keyword and search volume are pipeline-generated and cannot be set.



## OpenAPI

````yaml /openapi.json patch /api/v1/projects/{project}/prompts/{prompt}
openapi: 3.1.0
info:
  title: Surfacd Public API
  version: 1.0.0
  description: >-
    Public API for Surfacd. Team-scoped operations live under
    `/api/v1/team/...`; project collections live under `/api/v1/projects`;
    project-scoped operations live under `/api/v1/projects/{project}/...`. All
    endpoints require a Bearer team API key created in Team Settings. The API
    key selects the team for team-level and collection endpoints.
servers:
  - url: https://app.surfacd.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Projects
    description: Project management endpoints. Reads only in this version.
  - name: Prompts
    description: Prompt management endpoints. Reads only in this version.
  - name: Team
    description: Team settings and plan details for the current team.
  - name: Reporting
    description: >-
      Read-only reporting endpoints for projects (brand rankings, mentions,
      visibility, matrix analysis, source data).
  - name: Reference
    description: Reference data used by create, update, and reporting filters.
  - name: Tags
    description: Project tag management endpoints.
paths:
  /api/v1/projects/{project}/prompts/{prompt}:
    parameters:
      - $ref: '#/components/parameters/ProjectUuid'
      - name: prompt
        in: path
        required: true
        description: Prompt UUID.
        schema:
          type: string
          format: uuid
    patch:
      tags:
        - Prompts
      summary: Update Prompt
      description: >-
        Partially updates a prompt. Only the fields present are applied.
        `status` toggles between `active` and `inactive`; activating a prompt is
        subject to the project's prompt limit and the team's available credits.
        Pass `topic: null` to clear the topic. Keyword and search volume are
        pipeline-generated and cannot be set.
      operationId: v1PromptsUpdate
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePromptRequest'
      responses:
        '200':
          description: The updated prompt.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Prompt'
        '404':
          description: Prompt not found in the current team.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                required:
                  - message
        '422':
          $ref: '#/components/responses/ValidationError'
components:
  parameters:
    ProjectUuid:
      name: project
      in: path
      required: true
      description: Project UUID.
      schema:
        type: string
        format: uuid
  schemas:
    UpdatePromptRequest:
      type: object
      description: Partial update. Only the fields present are applied.
      properties:
        text:
          type: string
          maxLength: 700
        country_code:
          type: string
          description: ISO 3166-1 alpha-2 code of an active country.
        topic:
          type:
            - string
            - 'null'
          maxLength: 255
          description: >-
            Topic name (created if it doesn't exist), or null to clear the
            topic.
        status:
          type: string
          enum:
            - active
            - inactive
          description: >-
            Activating is subject to the project's prompt limit and the team's
            credits.
    Prompt:
      type: object
      properties:
        uuid:
          type: string
          format: uuid
        text:
          type: string
          description: The prompt text.
        keyword:
          type:
            - string
            - 'null'
        status:
          $ref: '#/components/schemas/PromptStatus'
        search_volume:
          type:
            - integer
            - 'null'
          description: Most recent search volume for the prompt's keyword, when known.
        topic:
          oneOf:
            - $ref: '#/components/schemas/PromptTopic'
            - type: 'null'
        country:
          $ref: '#/components/schemas/ProjectCountry'
        tags:
          type: array
          items:
            $ref: '#/components/schemas/PromptTag'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
        - uuid
        - text
        - keyword
        - status
        - search_volume
        - topic
        - country
        - tags
        - created_at
        - updated_at
    PromptStatus:
      type: string
      enum:
        - suggestion
        - declined
        - inactive
        - active
    PromptTopic:
      type: object
      properties:
        uuid:
          type: string
          format: uuid
        name:
          type: string
      required:
        - uuid
        - name
    ProjectCountry:
      type: object
      properties:
        code:
          type: string
          description: ISO 3166-1 alpha-2 country code (lowercase).
        name:
          type: string
      required:
        - code
        - name
    PromptTag:
      type: object
      properties:
        uuid:
          type: string
          format: uuid
        name:
          type: string
        color:
          type:
            - string
            - 'null'
      required:
        - uuid
        - name
        - color
    ValidationError:
      type: object
      description: Returned when one or more request parameters fail validation.
      properties:
        message:
          type: string
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
      required:
        - message
        - errors
  responses:
    ValidationError:
      description: Validation failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ValidationError'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: token
      description: >-
        Team API key created in Team Settings. Use it with URLs for the same
        team.

````