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

# Remove a competitor

> Remove one competitor from the tracked list by name (case-insensitive, URL-encoded) and pin the list. Acts on the active project. Requires a paid plan.



## OpenAPI

````yaml https://api.spreadjam.com/openapi.json delete /v1/brand/competitors/{name}
openapi: 3.0.0
info:
  title: SpreadJam API
  version: 1.0.0
servers:
  - url: https://api.spreadjam.com
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.
  - name: Visibility runs
    description: Run the AI-visibility scan now.
  - name: Credits
    description: The workspace's credit balance and recent charges.
  - name: Actions
    description: Recommended visibility actions and reporting them done.
  - name: Agent connect
    description: >-
      Sign a human up from an agent with one link, then receive an API key once
      they approve. No API key needed.
  - name: Pricing
    description: >-
      The plans an agent can choose for a human and their monthly prices. No API
      key needed.
  - name: Site changes
    description: >-
      Code changes Jam prepares for page edits and technical fixes: preview,
      open the pull request, discard.
  - name: Research
    description: >-
      The research that writes the Plan: its state, its latest report, and
      running it again.
  - name: Answers
    description: >-
      What each AI platform answered to the tracked prompts, with the sources it
      cited.
  - name: Projects
    description: The workspace's projects and the status of each one.
  - name: Billing
    description: The workspace's plan and the links where a person manages billing.
  - name: Webhooks
    description: >-
      HTTP destinations the workspace notifications are POSTed to, signed with a
      per-webhook secret.
  - name: Notifications
    description: >-
      Which notifications reach which channels (including webhooks), per event
      category.
  - name: Opportunities
    description: >-
      Article opportunities: the article pipeline behind the Plan's `new_page`
      actions, and requests to create content from them.
  - name: Planning
    description: Run automatic content planning now.
  - name: Content
    description: Content items, their drafts, and requests to rewrite them.
  - name: Revisions
    description: A content item's revisions.
  - name: Publishing
    description: Publishing content to destinations, now or on a schedule.
  - name: Deliveries
    description: A content item's delivery history.
  - name: Publications
    description: Where a content item is live.
  - name: Destinations
    description: Where content is published, its publishing policy, and its connection.
paths:
  /v1/brand/competitors/{name}:
    delete:
      tags:
        - Brand
      summary: Remove a competitor
      description: >-
        Remove one competitor from the tracked list by name (case-insensitive,
        URL-encoded) and pin the list. Acts on the active project. Requires a
        paid plan.
      operationId: remove_brand_competitor
      parameters:
        - schema:
            type: string
            minLength: 1
            maxLength: 200
            example: Profound
          required: true
          name: name
          in: path
      responses:
        '200':
          description: The list after the removal.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompetitorEdit'
        '400':
          description: >-
            Invalid request: a parameter or body field is wrong. `details` lists
            each problem with what is allowed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: >-
            Missing, malformed or revoked API key (`Authorization: Bearer
            sk_…`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '402':
          description: >-
            The plan has lapsed or credits are short; `resolveUrl` is where a
            person fixes it.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: >-
            The resource, or the project the key or `X-Jam-Project` selects,
            does not exist in this workspace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '429':
          description: >-
            `rate_limited` (per-key rate) or `too_many_concurrent` (expensive
            reads in flight); retry after `Retry-After` seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      security:
        - bearerAuth: []
components:
  schemas:
    CompetitorEdit:
      type: object
      properties:
        changed:
          type: array
          items:
            type: string
          description: >-
            The names this request added, removed or updated; empty when nothing
            changed.
        competitors:
          type: array
          items:
            type: string
          description: The competitor list after the request.
        pinned:
          type: boolean
          description: >-
            True when the request changed and pinned the list, so automated
            discovery keeps it.
        roster:
          type: array
          items:
            $ref: '#/components/schemas/CompetitorRosterEntry'
          description: >-
            How the next scan matches each competitor. Stored answers are not
            rewritten.
      required:
        - changed
        - competitors
        - pinned
        - roster
    ApiError:
      type: object
      required:
        - error
        - code
      properties:
        error:
          type: string
          description: What went wrong and how to fix the request.
        code:
          type: string
          description: >-
            Stable machine-readable code, e.g. invalid_request, unauthorized,
            rate_limited.
        requestId:
          type: string
          description: Echoes the X-Request-Id header; quote it to support.
        docs:
          type: string
          description: Where the error is explained.
        resolveUrl:
          type: string
          description: '402/403 plan errors: the dashboard page that resolves it.'
        details:
          type: array
          description: >-
            One entry per problem: path, message, and when known allowed,
            minimum, maximum, expected, received.
          items:
            type: object
            additionalProperties: true
    CompetitorRosterEntry:
      type: object
      properties:
        name:
          type: string
        domain:
          type: string
          nullable: true
          description: The domain answers and citations are matched to; null when unknown.
        aliases:
          type: array
          items:
            type: string
          description: >-
            Other names answers are matched to. The name's own spellings
            (Otterly AI for Otterly.AI) and the name the domain spells out
            (AthenaHQ for Athena at athenahq.ai) also match without being
            listed.
      required:
        - name
        - domain
        - aliases
  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.