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

# Cancel a TAM Preview

> Request cancellation. Cancellation does not undo completed work.



## OpenAPI

````yaml https://api.monaco.com/openapi.json post /v1/tam/preview/{preview_id}/cancel
openapi: 3.1.0
info:
  title: Monaco Public API
  description: Public API for Monaco
  version: 1.0.0
servers:
  - url: https://api.monaco.com
security: []
paths:
  /v1/tam/preview/{preview_id}/cancel:
    post:
      tags:
        - TAM
      summary: Cancel a TAM Preview
      description: Request cancellation. Cancellation does not undo completed work.
      operationId: cancel_tam_import_preview
      parameters:
        - name: preview_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Preview Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicItemResponse_TamPreviewResponse_'
        4XX:
          description: Client error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorResponse'
components:
  schemas:
    PublicItemResponse_TamPreviewResponse_:
      properties:
        data:
          $ref: '#/components/schemas/TamPreviewResponse'
        meta:
          $ref: '#/components/schemas/ResponseMeta'
      type: object
      required:
        - data
      title: PublicItemResponse[TamPreviewResponse]
    PublicErrorResponse:
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetail'
      type: object
      required:
        - error
      title: PublicErrorResponse
    TamPreviewResponse:
      properties:
        tam_import_balance:
          anyOf:
            - $ref: '#/components/schemas/TamImportMonthlyBalance'
            - type: 'null'
          description: >-
            Deprecated; call get_tam_import_balance with preview_id for the
            forecast.
          deprecated: true
        preview_id:
          type: string
          format: uuid
          title: Preview Id
        request_id:
          type: string
          format: uuid
          title: Request Id
        status:
          type: string
          enum:
            - PREPARING
            - READY
            - FAILED
            - CANCELLED
          title: Status
        request:
          $ref: '#/components/schemas/TamPreviewRequest-Output'
        result:
          anyOf:
            - $ref: '#/components/schemas/TamPreviewResult'
            - type: 'null'
        members:
          items:
            $ref: '#/components/schemas/TamPreviewMember'
          type: array
          title: Members
        pagination_meta:
          $ref: '#/components/schemas/PaginationMeta'
        failure_reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Failure Reason
        operation_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Operation Id
        totals:
          anyOf:
            - $ref: '#/components/schemas/TamPreviewTotals'
            - type: 'null'
          description: Whole-Preview counts once READY; null before.
        contacts_by_account:
          anyOf:
            - $ref: '#/components/schemas/TamPreviewContactsByAccount'
            - type: 'null'
          description: >-
            Whole-Preview selected Contact counts grouped by the retained
            employer Account's new/existing classification at Preview time,
            independent of member pagination. Null before READY or when an older
            server does not supply the breakdown. Unresolved employers are
            excluded by the existing selection rules.
        research:
          anyOf:
            - $ref: '#/components/schemas/TamPreviewResearch'
            - type: 'null'
      type: object
      required:
        - preview_id
        - request_id
        - status
        - request
        - pagination_meta
      title: TamPreviewResponse
    ResponseMeta:
      properties:
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: Server timestamp of the response
      type: object
      title: ResponseMeta
    ErrorDetail:
      properties:
        code:
          type: string
          title: Code
          description: Machine-readable error code
          examples:
            - not_found
        message:
          type: string
          title: Message
          description: Human-readable error message
          examples:
            - Resource not found
      type: object
      required:
        - code
        - message
      title: ErrorDetail
    TamImportMonthlyBalance:
      properties:
        billing_mode:
          type: string
          enum:
            - platform
            - usage_based
          title: Billing Mode
        limited:
          type: boolean
          title: Limited
        period:
          $ref: '#/components/schemas/TamImportMonth'
        accounts:
          $ref: '#/components/schemas/TamImportBalance'
        contacts:
          $ref: '#/components/schemas/TamImportBalance'
        exceeded:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Exceeded
      type: object
      required:
        - billing_mode
        - limited
        - period
        - accounts
        - contacts
      title: TamImportMonthlyBalance
    TamPreviewRequest-Output:
      properties:
        request_id:
          type: string
          format: uuid
          title: Request Id
          description: Keep this ID when repeating the same Preview request.
        contact_filters:
          $ref: '#/components/schemas/TamContactFilters'
        exclude_companies_without_titles:
          type: boolean
          title: Exclude Companies Without Titles
          default: false
        tag_ids:
          items:
            type: string
            format: uuid
          type: array
          title: Tag Ids
        contact_tag_ids:
          items:
            type: string
            format: uuid
          type: array
          title: Contact Tag Ids
        tag_existing_accounts:
          type: boolean
          title: Tag Existing Accounts
          description: >-
            Add tag_ids to existing Accounts reused by this Import too. False
            tags only Accounts this Import creates; existing tags are always
            kept.
          default: true
        tag_existing_contacts:
          type: boolean
          title: Tag Existing Contacts
          description: >-
            Add contact_tag_ids to existing Contacts reused by this Import too.
            False tags only Contacts this Import creates; existing tags are
            always kept.
          default: true
        qualifier_signal_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Qualifier Signal Id
          description: >-
            The Account AI field whose researched answer decides which companies
            pass. Any AI-filled Account field of this organization can be this
            run's Qualifier. Leave it empty to run no Qualifier.
        qualifier_rule:
          anyOf:
            - $ref: '#/components/schemas/TamQualifierRule'
            - type: 'null'
          description: >-
            The passing answer for qualifier_signal_id, as {"operator":
            "equals", "value": …}. Rule operators: equals | contains (contains
            ignores case; use it for text and multi-select). A researched answer
            that does not pass the rule excludes the company and its people, the
            same as a failed or unanswered one; passing rows remain importable
            and Import writes each passing answer into the field. Required with
            qualifier_signal_id.
        company_filters:
          $ref: '#/components/schemas/TamCompanyFilters-Output'
        search_input:
          anyOf:
            - $ref: '#/components/schemas/TamSearchPreviewInput-Output'
            - type: 'null'
          description: Exact Search criteria supplied by the caller for this Preview.
      additionalProperties: false
      type: object
      required:
        - request_id
        - company_filters
      title: TamPreviewRequest
    TamPreviewResult:
      properties:
        accounts:
          $ref: '#/components/schemas/TamPreviewCounts'
        contacts:
          $ref: '#/components/schemas/TamPreviewCounts'
        qualifier:
          anyOf:
            - $ref: '#/components/schemas/TamQualifierAvailability'
            - type: 'null'
      type: object
      required:
        - accounts
        - contacts
      title: TamPreviewResult
    TamPreviewMember:
      properties:
        member_id:
          type: string
          format: uuid
          title: Member Id
        source_ordinal:
          type: integer
          minimum: 0
          title: Source Ordinal
        kind:
          type: string
          enum:
            - company
            - person
          title: Kind
        source_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Source Id
        company_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Company Id
        selected:
          type: boolean
          title: Selected
        is_importable:
          type: boolean
          title: Is Importable
        is_qualified:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Qualified
          description: >-
            Answered Qualifier Signal verdict; None for absent or failed
            research.
        preparation_exclusion_reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Preparation Exclusion Reason
        is_duplicate_source_row:
          type: boolean
          title: Is Duplicate Source Row
          default: false
        existing:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Existing
        exclusion_reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Exclusion Reason
          description: >-
            Failed/unanswered research uses QUALIFIER_FAILED, not a failing rule
            verdict. EXCLUDED_BY_USER means the member was removed after the
            Preview was READY.
        data:
          additionalProperties: true
          type: object
          title: Data
        qualification:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Qualification
          description: Retained answer or research failure status and reason.
      type: object
      required:
        - member_id
        - source_ordinal
        - kind
        - source_id
        - selected
        - is_importable
        - data
      title: TamPreviewMember
    PaginationMeta:
      properties:
        current_page:
          type: integer
          title: Current Page
        page_size:
          type: integer
          title: Page Size
        total_pages:
          type: integer
          title: Total Pages
        total_count:
          anyOf:
            - type: integer
            - type: 'null'
          title: Total Count
      type: object
      required:
        - current_page
        - page_size
        - total_pages
      title: PaginationMeta
    TamPreviewTotals:
      properties:
        companies:
          $ref: '#/components/schemas/TamPreviewCompanyTotals'
        people:
          $ref: '#/components/schemas/TamPreviewPeopleTotals'
      type: object
      required:
        - companies
        - people
      title: TamPreviewTotals
    TamPreviewContactsByAccount:
      properties:
        new_accounts:
          $ref: '#/components/schemas/TamPreviewContactTotals'
        existing_accounts:
          $ref: '#/components/schemas/TamPreviewContactTotals'
      type: object
      required:
        - new_accounts
        - existing_accounts
      title: TamPreviewContactsByAccount
    TamPreviewResearch:
      properties:
        status:
          type: string
          enum:
            - not_started
            - dispatched
            - running
            - completed
            - failed
            - skipped
          title: Status
        reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Reason
        field_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Field Id
        field_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Field Name
        question:
          anyOf:
            - type: string
            - type: 'null'
          title: Question
        passed:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
          title: Passed
        not_matched:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
          title: Not Matched
        failed:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
          title: Failed
        started_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Started At
          description: When research was sent.
        finished_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Finished At
          description: 'Null: not stored yet.'
        cost:
          anyOf:
            - $ref: '#/components/schemas/TamResearchCost'
            - type: 'null'
          description: >-
            This research in AI signal credits: the estimate while preparing,
            the actual when READY. Not charged by the Preview; charged once when
            its Import is accepted.
      additionalProperties: true
      type: object
      required:
        - status
      title: TamPreviewResearch
      description: >-
        The Preview's Qualifier research, read from stored state only.


        Open object: later fields (for example a cost block) may be added
        without notice.
    TamImportMonth:
      properties:
        kind:
          type: string
          const: calendar_month
          title: Kind
          default: calendar_month
        start:
          type: string
          format: date-time
          title: Start
        end:
          type: string
          format: date-time
          title: End
      type: object
      required:
        - start
        - end
      title: TamImportMonth
    TamImportBalance:
      properties:
        limit:
          anyOf:
            - type: integer
            - type: 'null'
          title: Limit
          description: Monthly limit; null means unlimited.
        used:
          type: integer
          minimum: 0
          title: Used
          description: >-
            Records created by TAM Imports this month plus estimated
            still-missing records in active accepted Imports.
        remaining:
          anyOf:
            - type: integer
            - type: 'null'
          title: Remaining
          description: Remaining monthly balance; null means unlimited.
        would_add:
          anyOf:
            - type: integer
            - type: 'null'
          title: Would Add
        after_import:
          anyOf:
            - type: integer
            - type: 'null'
          title: After Import
        over_by:
          anyOf:
            - type: integer
            - type: 'null'
          title: Over By
      type: object
      required:
        - limit
        - used
        - remaining
      title: TamImportBalance
    TamContactFilters:
      properties:
        include_keywords:
          items:
            type: string
          type: array
          title: Include Keywords
        exclude_keywords:
          items:
            type: string
          type: array
          title: Exclude Keywords
        seniority:
          anyOf:
            - type: string
              enum:
                - Individual Contributor
                - Senior Individual Contributor
                - Manager
                - Senior Manager
                - Director
                - Senior Director
                - VP
                - SVP
                - EVP
                - C-Level
                - Founder
            - type: 'null'
          title: Seniority
        countries:
          items:
            type: string
          type: array
          title: Countries
      additionalProperties: false
      type: object
      title: TamContactFilters
    TamQualifierRule:
      properties:
        operator:
          type: string
          enum:
            - equals
            - contains
          title: Operator
          default: equals
        value:
          anyOf:
            - type: boolean
            - type: integer
            - type: number
            - type: string
          title: Value
      additionalProperties: false
      type: object
      required:
        - value
      title: TamQualifierRule
    TamCompanyFilters-Output:
      properties:
        account_view_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Account View Id
        filtering_rules:
          anyOf:
            - $ref: '#/components/schemas/TamFilters-Output'
            - type: 'null'
        searching_rule:
          anyOf:
            - $ref: '#/components/schemas/TamSearchRule'
            - type: 'null'
      additionalProperties: false
      type: object
      title: TamCompanyFilters
    TamSearchPreviewInput-Output:
      properties:
        filtering_rules:
          anyOf:
            - $ref: '#/components/schemas/TamFilters-Output'
            - type: 'null'
        title_enrichment:
          anyOf:
            - $ref: '#/components/schemas/TamSearchTitleEnrichment'
            - type: 'null'
        searching_rule:
          anyOf:
            - $ref: '#/components/schemas/TamSearchRule'
            - type: 'null'
        grouping_rule:
          anyOf:
            - $ref: '#/components/schemas/TamGroupRule'
            - type: 'null'
        sorting_rules:
          items:
            $ref: '#/components/schemas/TamSortRule'
          type: array
          title: Sorting Rules
          default: []
        with_titles:
          type: boolean
          title: With Titles
          default: false
        title_search:
          items:
            type: string
          type: array
          title: Title Search
          default: []
        exclude_companies_in_tam:
          type: boolean
          title: Exclude Companies In Tam
          default: false
        max_candidates:
          anyOf:
            - type: integer
              minimum: 1
            - type: 'null'
          title: Max Candidates
        query_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Query Id
        account_view_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Account View Id
      additionalProperties: false
      type: object
      title: TamSearchPreviewInput
    TamPreviewCounts:
      properties:
        matched:
          type: integer
          minimum: 0
          title: Matched
          description: Unique source identities inspected for this selection.
        eligible:
          type: integer
          minimum: 0
          title: Eligible
          description: 'Selected items eligible for Import: new + existing.'
        new:
          type: integer
          minimum: 0
          title: New
          description: Eligible items without a destination at Preview time.
        existing:
          type: integer
          minimum: 0
          title: Existing
          description: Eligible items already present at Preview time.
        exclusions:
          additionalProperties:
            type: integer
          type: object
          title: Exclusions
          description: >-
            Excluded item counts by reason, outside eligible. QUALIFIER_FAILED
            counts failed or unanswered research separately from
            QUALIFIER_NOT_MATCHED rule verdicts. EXCLUDED_BY_USER counts members
            removed after the Preview was READY.
        duplicate_source_rows:
          type: integer
          minimum: 0
          title: Duplicate Source Rows
          description: Repeated source rows, excluded from the matched denominator.
          default: 0
      type: object
      required:
        - matched
        - eligible
        - new
        - existing
      title: TamPreviewCounts
    TamQualifierAvailability:
      properties:
        available:
          type: boolean
          title: Available
        signal:
          anyOf:
            - $ref: '#/components/schemas/TamQualifierSignal'
            - type: 'null'
        reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Reason
      type: object
      required:
        - available
      title: TamQualifierAvailability
    TamPreviewCompanyTotals:
      properties:
        matched:
          type: integer
          minimum: 0
          title: Matched
        eligible:
          type: integer
          minimum: 0
          title: Eligible
          description: 'new + existing: what Import would write.'
        new:
          type: integer
          minimum: 0
          title: New
        existing:
          type: integer
          minimum: 0
          title: Existing
        excluded:
          type: integer
          minimum: 0
          title: Excluded
          description: Every exclusion reason plus repeated source rows.
      type: object
      required:
        - matched
        - eligible
        - new
        - existing
        - excluded
      title: TamPreviewCompanyTotals
    TamPreviewPeopleTotals:
      properties:
        matched:
          type: integer
          minimum: 0
          title: Matched
        eligible:
          type: integer
          minimum: 0
          title: Eligible
        excluded:
          type: integer
          minimum: 0
          title: Excluded
      type: object
      required:
        - matched
        - eligible
        - excluded
      title: TamPreviewPeopleTotals
    TamPreviewContactTotals:
      properties:
        new:
          type: integer
          minimum: 0
          title: New
          description: Selected Contacts without a destination at Preview time.
        existing:
          type: integer
          minimum: 0
          title: Existing
          description: Selected Contacts already present at Preview time.
        total:
          type: integer
          minimum: 0
          title: Total
          description: 'Selected Contacts: new + existing.'
      type: object
      required:
        - new
        - existing
        - total
      title: TamPreviewContactTotals
    TamResearchCost:
      properties:
        companies:
          anyOf:
            - type: integer
            - type: 'null'
          title: Companies
          description: Companies the Qualifier researches (the estimate's count).
        units:
          anyOf:
            - type: integer
            - type: 'null'
          title: Units
          description: >-
            Companies whose research returned a usable answer, pass or fail: the
            units charged. Failed or unanswered research is not charged. Known
            once READY.
        unit_rate:
          anyOf:
            - type: number
            - type: 'null'
          title: Unit Rate
          description: >-
            AI signal credits per answer at the list rate; null when
            unavailable.
        estimated_ai_signal_credits:
          anyOf:
            - type: integer
            - type: 'null'
          title: Estimated Ai Signal Credits
          description: >-
            companies x unit_rate at the list rate; null when the rate is
            unavailable.
        actual_ai_signal_credits:
          anyOf:
            - type: integer
            - type: 'null'
          title: Actual Ai Signal Credits
          description: units x unit_rate, known once READY.
        unit_product:
          type: string
          title: Unit Product
          description: The AI signal product these credits draw from.
        rate_basis:
          type: string
          const: list
          title: Rate Basis
          description: The global list rate, not a contracted rate.
          default: list
        charged:
          type: boolean
          title: Charged
          description: >-
            False until the customer's Import of this Preview is accepted; then
            true. A Preview that is never imported is never charged.
        charged_operation_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Charged Operation Id
          description: The accepted Import that charged the research.
      type: object
      required:
        - unit_product
        - charged
      title: TamResearchCost
      description: >-
        Qualifier research priced in AI signal credits, the unit every AI signal
        draws from.
    TamFilters-Output:
      properties:
        operator:
          type: string
          enum:
            - and
            - or
          title: Operator
          default: and
        filters:
          items:
            anyOf:
              - $ref: '#/components/schemas/TamRule'
              - $ref: '#/components/schemas/TamFilters-Output'
          type: array
          minItems: 1
          title: Filters
      additionalProperties: false
      type: object
      required:
        - filters
      title: TamFilters
    TamSearchRule:
      properties:
        value:
          type: string
          title: Value
      additionalProperties: false
      type: object
      required:
        - value
      title: TamSearchRule
    TamSearchTitleEnrichment:
      properties:
        condition:
          type: string
          enum:
            - and
            - or
          title: Condition
          default: or
        criterias:
          items:
            $ref: '#/components/schemas/TamTitleCriterion'
          type: array
          title: Criterias
          default: []
      additionalProperties: false
      type: object
      title: TamSearchTitleEnrichment
    TamGroupRule:
      properties:
        field:
          type: string
          title: Field
      additionalProperties: false
      type: object
      required:
        - field
      title: TamGroupRule
    TamSortRule:
      properties:
        field:
          type: string
          title: Field
        direction:
          type: string
          title: Direction
          default: desc
      additionalProperties: false
      type: object
      required:
        - field
      title: TamSortRule
    TamQualifierSignal:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        name:
          type: string
          title: Name
        question:
          type: string
          title: Question
        data_type:
          type: string
          title: Data Type
        rule:
          $ref: '#/components/schemas/TamQualifierRule'
      type: object
      required:
        - id
        - name
        - question
        - data_type
        - rule
      title: TamQualifierSignal
    TamRule:
      properties:
        field:
          type: string
          title: Field
        condition:
          type: string
          title: Condition
        value:
          anyOf:
            - {}
            - type: 'null'
          title: Value
      additionalProperties: false
      type: object
      required:
        - field
        - condition
      title: TamRule
    TamTitleCriterion:
      properties:
        condition:
          type: string
          enum:
            - and
            - or
          title: Condition
          default: and
        job_function:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Job Function
        seniority:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Seniority
        negate:
          type: boolean
          title: Negate
          default: false
      additionalProperties: false
      type: object
      title: TamTitleCriterion

````

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