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

# Cancel Follow-ups

> Cancel your follow-ups that have not fired, so they never fire. One that already fired, expired or was canceled reports why per id; another person's follow-up reads as not found.

Returns `followUpIds`, `succeededCount`, `failedCount` and ordered `results`; `ok` is true only when every id was canceled.

### Authorization

Requires `agents:invoke`.



## OpenAPI

````yaml /openapi.json post /api/v1/follow-ups/cancel
openapi: 3.1.0
info:
  title: OmniCommerce API
  version: 1.0.0
  license:
    name: Proprietary
    url: https://omnicommerce.sg/terms
  description: >-
    OmniCommerce API surface for agents and developer integrations. Includes
    public endpoints (merchant discovery, product search, compare, catalog, ACO
    retrieval) and authenticated endpoints (product management via API key
    Bearer tokens).
servers:
  - url: https://omnicommerce.ai
    description: Production
  - url: http://localhost:3000
    description: Local development
security: []
tags:
  - name: agentic-checkout
    description: Merchant-fulfilled agentic checkout
    x-group: Agentic Checkout
  - name: agents
    description: agents
    x-group: Agents
  - name: analytics
    description: Sales performance across marketplaces
    x-group: Analytics
  - name: aops
    description: Agent operating procedures
    x-group: AOPs
  - name: branding
    description: branding
    x-group: Branding
  - name: campaigns
    description: Campaign briefs, offer windows, and marketplace runs
    x-group: Campaigns
  - name: catalog
    description: catalog
    x-group: Catalog
  - name: commerce
    description: commerce
    x-group: Commerce
  - name: developer-platform
    description: Authenticated developer platform APIs
    x-group: Developer Platform
  - name: documents
    description: Knowledge base document uploads
    x-group: Knowledge Base
  - name: follow-ups
    description: follow-ups
    x-group: Follow Ups
  - name: inventory
    description: Inventory quantities, planning signals, and marketplace listing absence
    x-group: Inventory
  - name: looks
    description: AI-styled product looks
    x-group: Looks
  - name: oauth
    description: OAuth token endpoints
    x-group: OAuth
  - name: orders
    description: Workspace and agentic orders
    x-group: Orders
  - name: organizations
    description: Organization management
    x-group: Organizations
  - name: price-books
    description: Marketplace list-price markup rules
    x-group: Price Books
  - name: products
    description: Product CRUD, bulk import, enrichment, publish, and delist
    x-group: Products
  - name: promotions
    description: Central promotions and marketplace sync
    x-group: Promotions
  - name: public-agent
    description: Public agent discovery and catalog APIs
    x-group: Public Agent
  - name: returns
    description: returns
    x-group: Returns
  - name: reviews
    description: Marketplace product reviews and seller replies
    x-group: Reviews
  - name: scripts
    description: scripts
    x-group: Scripts
  - name: settlements
    description: settlements
    x-group: Settlements
  - name: ucp
    description: Universal Commerce Protocol
    x-group: UCP
paths:
  /api/v1/follow-ups/cancel:
    post:
      tags:
        - follow-ups
      summary: Cancel Follow-ups
      description: >-
        Cancel your follow-ups that have not fired, so they never fire. One that
        already fired, expired or was canceled reports why per id; another
        person's follow-up reads as not found.


        Returns `followUpIds`, `succeededCount`, `failedCount` and ordered
        `results`; `ok` is true only when every id was canceled.


        ### Authorization


        Requires `agents:invoke`.
      operationId: post_v1_follow_ups_cancel
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                followUpIds:
                  minItems: 1
                  maxItems: 20
                  type: array
                  items:
                    type: string
                    format: uuid
                    pattern: >-
                      ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                  description: The follow-ups to cancel, from follow_up or list_follow_ups.
                organizationId:
                  type: string
                  minLength: 1
                  maxLength: 120
              required:
                - followUpIds
              additionalProperties: false
            example:
              followUpIds:
                - 3f1c2b9e-8f0a-4c51-9d1e-2a6b7c8d9e0f
      responses:
        '200':
          description: One result per id.
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                  operationId:
                    type: string
                  status:
                    type: string
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                      followUpIds:
                        type: array
                        items:
                          type: string
                      succeededCount:
                        type: integer
                      failedCount:
                        type: integer
                      results:
                        type: array
                        items:
                          type: object
        '400':
          description: Invalid payload, or a follow-up the request cannot make.
        '401':
          description: Unauthorized
        '403':
          description: >-
            Missing agents:invoke scope or Assistant access, or an OAuth client
            credential: follow-ups belong to a person (API key or session).
        '500':
          description: Internal Server Error
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        Bearer API key for server-to-server access. Session auth is also
        supported in first-party UI flows.

````

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