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

# Update tracked keyword

> Update a tracked keyword's properties. Currently supports toggling the is_active flag to pause or resume tracking for a keyword.



## OpenAPI

````yaml https://api.surnex.io/openapi.json patch /v1/projects/{project_id}/tracking/keywords/{keyword_id}
openapi: 3.1.0
info:
  title: Surnex API
  description: |-
    Surnex SEO Platform API — api.surnex.io

    Provides the complete backend for the Surnex SEO dashboard including:
    - Multi-tenant organization management
    - Project tracking (domains)
    - Keyword rank tracking (Phase 1+)
    - Backlink analysis (Phase 3+)
    - Site auditing (Phase 4+)
    - Stripe billing integration
    - MCP endpoint for AI agents at /mcp
  version: 0.1.0
servers: []
security: []
paths:
  /v1/projects/{project_id}/tracking/keywords/{keyword_id}:
    patch:
      tags:
        - Rank Tracking
      summary: Update tracked keyword
      description: >-
        Update a tracked keyword's properties. Currently supports toggling the
        is_active flag to pause or resume tracking for a keyword.
      operationId: >-
        update_tracked_keyword_v1_projects__project_id__tracking_keywords__keyword_id__patch
      parameters:
        - name: project_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Project Id
        - name: keyword_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Keyword Id
        - name: X-API-Key
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Api-Key
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateTrackedKeywordRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIResponse_TrackedKeywordResponse_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    UpdateTrackedKeywordRequest:
      properties:
        is_active:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Active
        location_code:
          anyOf:
            - type: integer
            - type: 'null'
          title: Location Code
        language_code:
          anyOf:
            - type: string
              maxLength: 10
            - type: 'null'
          title: Language Code
      type: object
      title: UpdateTrackedKeywordRequest
      description: >-
        Request body for updating a tracked keyword (e.g. toggling
        active/inactive).
    APIResponse_TrackedKeywordResponse_:
      properties:
        success:
          type: boolean
          title: Success
          default: true
        data:
          anyOf:
            - $ref: '#/components/schemas/TrackedKeywordResponse'
            - type: 'null'
      type: object
      title: APIResponse[TrackedKeywordResponse]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    TrackedKeywordResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        project_id:
          type: string
          format: uuid
          title: Project Id
        keyword:
          type: string
          title: Keyword
        location_code:
          type: integer
          title: Location Code
        language_code:
          type: string
          title: Language Code
        search_engine:
          type: string
          title: Search Engine
        current_position:
          anyOf:
            - type: integer
            - type: 'null'
          title: Current Position
          description: Current SERP position. NULL means not in top 100.
        previous_position:
          anyOf:
            - type: integer
            - type: 'null'
          title: Previous Position
          description: Position from the prior daily rank check.
        best_position:
          anyOf:
            - type: integer
            - type: 'null'
          title: Best Position
          description: All-time best recorded position.
        position_change:
          anyOf:
            - type: integer
            - type: 'null'
          title: Position Change
          description: >-
            Change from previous to current position. Positive = improved (moved
            up), negative = dropped (moved down).
        url_found:
          anyOf:
            - type: string
            - type: 'null'
          title: Url Found
          description: The URL currently ranking for this keyword.
        search_volume:
          anyOf:
            - type: integer
            - type: 'null'
          title: Search Volume
        is_active:
          type: boolean
          title: Is Active
        last_checked_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Last Checked At
        ai_overview_triggered_count:
          type: integer
          title: Ai Overview Triggered Count
          description: Number of times an AI Overview was triggered for this keyword.
          default: 0
        ai_overview_last_cited_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Ai Overview Last Cited At
          description: >-
            Last time this project's domain was cited in an AI Overview for this
            keyword.
        tags:
          items:
            $ref: '#/components/schemas/TagResponse'
          type: array
          title: Tags
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
      type: object
      required:
        - id
        - project_id
        - keyword
        - location_code
        - language_code
        - search_engine
        - is_active
        - created_at
        - updated_at
      title: TrackedKeywordResponse
      description: A tracked keyword with its latest position data and tags.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    TagResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        project_id:
          type: string
          format: uuid
          title: Project Id
        name:
          type: string
          title: Name
        color:
          type: string
          title: Color
        keyword_count:
          type: integer
          title: Keyword Count
          description: Number of tracked keywords currently assigned this tag.
          default: 0
        created_at:
          type: string
          format: date-time
          title: Created At
      type: object
      required:
        - id
        - project_id
        - name
        - color
        - created_at
      title: TagResponse
      description: A keyword tag record.
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````