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

# Cancel Keyword List

> Stop a running keyword list. Keywords not yet estimated are marked `canceled` and their weekly lookups are given back; finished keywords keep their results. Canceling a list that has already ended changes nothing.



## OpenAPI

````yaml /api-reference/openapi.json post /{brand_id}/keyword-volume/lists/{list_id}/cancel
openapi: 3.1.0
info:
  title: Scrunch Data API
  version: 0.1.0
servers:
  - url: https://api.scrunchai.com/v1
security: []
paths:
  /{brand_id}/keyword-volume/lists/{list_id}/cancel:
    post:
      tags:
        - keyword-volume
      summary: Cancel Keyword List
      description: >-
        Stop a running keyword list. Keywords not yet estimated are marked
        `canceled` and their weekly lookups are given back; finished keywords
        keep their results. Canceling a list that has already ended changes
        nothing.
      operationId: cancelKeywordList
      parameters:
        - name: brand_id
          in: path
          required: true
          schema:
            type: integer
            title: Brand Id
        - name: list_id
          in: path
          required: true
          schema:
            type: integer
            description: The keyword list's id, from Start Keyword List
            title: List Id
          description: The keyword list's id, from Start Keyword List
      responses:
        '202':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeywordBulkJob'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer:
            - query
components:
  schemas:
    KeywordBulkJob:
      properties:
        id:
          type: integer
          title: Id
          description: The list's id.
        status:
          type: string
          enum:
            - queued
            - running
            - finished
            - failed
            - canceled
          title: Status
          description: >-
            `queued` (waiting to start), `running`, `finished`, `failed`
            (stopped early; unused lookups were given back) or `canceled`.
        country:
          type: string
          title: Country
          description: The country the estimates are for. Always `US` today.
        item_count:
          type: integer
          title: Item Count
          description: >-
            How many keywords are on the list, after repeats and blanks are
            dropped.
        counts:
          $ref: '#/components/schemas/KeywordBulkCounts'
        created_at:
          type: string
          format: date-time
          title: Created At
          description: When the list was started.
        started_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Started At
          description: When it began running. Null while it's queued.
        finished_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Finished At
          description: When it ended. Null while it's queued or running.
      type: object
      required:
        - id
        - status
        - country
        - item_count
        - counts
        - created_at
        - started_at
        - finished_at
      title: KeywordBulkJob
      description: >-
        A keyword list: its status and progress, without the per-keyword
        results.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    KeywordBulkCounts:
      properties:
        pending:
          type: integer
          title: Pending
          description: Waiting to run.
          default: 0
        running:
          type: integer
          title: Running
          description: Being estimated now.
          default: 0
        done:
          type: integer
          title: Done
          description: Finished, with results.
          default: 0
        failed:
          type: integer
          title: Failed
          description: Couldn't be estimated. Their weekly lookups were given back.
          default: 0
        skipped_weekly_limit:
          type: integer
          title: Skipped Weekly Limit
          description: 'Not run: the brand''s weekly lookups ran out.'
          default: 0
        canceled:
          type: integer
          title: Canceled
          description: 'Not run: the list was canceled or stopped first.'
          default: 0
      type: object
      title: KeywordBulkCounts
      description: How many of the list's keywords are in each status.
    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

````

## Related topics

- [Scrunch MCP Feature Reference and Example Prompts](https://developers.scrunch.com/mcp/tools.md)
- [Keyword Volume API: Estimate a keyword list](https://developers.scrunch.com/api-reference/keyword-volume/overview.md)
- [Start Keyword List](https://developers.scrunch.com/api-reference/keyword-volume/start-keyword-list.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.