> ## 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 local keyword

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



## OpenAPI

````yaml https://api.surnex.io/openapi.json patch /v1/projects/{project_id}/local/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}/local/keywords/{keyword_id}:
    patch:
      tags:
        - Local SEO
      summary: Update local keyword
      description: >-
        Update a local keyword's properties. Currently supports toggling the
        is_active flag to pause or resume tracking.
      operationId: >-
        update_local_keyword_v1_projects__project_id__local_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/UpdateLocalKeywordRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIResponse_LocalKeywordResponse_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    UpdateLocalKeywordRequest:
      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: UpdateLocalKeywordRequest
      description: Request body for updating a local keyword (e.g. toggle active).
    APIResponse_LocalKeywordResponse_:
      properties:
        success:
          type: boolean
          title: Success
          default: true
        data:
          anyOf:
            - $ref: '#/components/schemas/LocalKeywordResponse'
            - type: 'null'
      type: object
      title: APIResponse[LocalKeywordResponse]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    LocalKeywordResponse:
      properties:
        id:
          type: string
          title: Id
        project_id:
          type: string
          title: Project Id
        keyword:
          type: string
          title: Keyword
        location_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Location Name
        location_code:
          type: integer
          title: Location Code
        language_code:
          type: string
          title: Language Code
        is_active:
          type: boolean
          title: Is Active
          default: true
        created_at:
          type: string
          format: date-time
          title: Created At
      type: object
      required:
        - id
        - project_id
        - keyword
        - location_code
        - language_code
        - created_at
      title: LocalKeywordResponse
      description: A single tracked local keyword.
    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
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````