> ## 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.

# Pin the competitor list

> Pin and lock the competitor list on the active profile. Requires a paid plan.



## OpenAPI

````yaml https://api.spreadjam.com/openapi.json put /v1/brand/competitors
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/brand/competitors:
    put:
      tags:
        - Brand
      summary: Pin the competitor list
      description: >-
        Pin and lock the competitor list on the active profile. Requires a paid
        plan.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PinCompetitors'
      responses:
        '200':
          description: The pinned competitor count.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompetitorsResult'
      security:
        - bearerAuth: []
components:
  schemas:
    PinCompetitors:
      type: object
      properties:
        competitors:
          type: array
          items:
            type: string
          minItems: 1
          maxItems: 64
          description: The competitor list to pin (1 to 64 names).
      required:
        - competitors
    CompetitorsResult:
      type: object
      properties:
        count:
          type: integer
          example: 5
      required:
        - count
  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.