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

# Create Follow-up

> Leave a one-shot follow-up on an assistant conversation you can open. Give exactly one of `at` (ISO 8601 with a timezone), `after` (a duration such as 90m, 4h, 14d or 2w) or `eventType` with an optional CEL `match` over `event` (the event's condition fields, as in AOP event triggers).

When it fires it continues `threadId` from `note` as you (`then=resume`, the default) or only emails you (`then=notify`). It never interrupts a run in progress: the continuation waits in the conversation's queue. A stopped conversation, or one whose last run failed, is not continued.

An event follow-up waits `expires` (10d by default) for its event; a timed one may be at most a year ahead.

### Authorization

Requires `agents:invoke` with a person's credential (API key or session); OAuth client credentials act for no one and are refused. The follow-up runs as that person.



## OpenAPI

````yaml /openapi.json post /api/v1/follow-ups
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:
    post:
      tags:
        - follow-ups
      summary: Create Follow-up
      description: >-
        Leave a one-shot follow-up on an assistant conversation you can open.
        Give exactly one of `at` (ISO 8601 with a timezone), `after` (a duration
        such as 90m, 4h, 14d or 2w) or `eventType` with an optional CEL `match`
        over `event` (the event's condition fields, as in AOP event triggers).


        When it fires it continues `threadId` from `note` as you (`then=resume`,
        the default) or only emails you (`then=notify`). It never interrupts a
        run in progress: the continuation waits in the conversation's queue. A
        stopped conversation, or one whose last run failed, is not continued.


        An event follow-up waits `expires` (10d by default) for its event; a
        timed one may be at most a year ahead.


        ### Authorization


        Requires `agents:invoke` with a person's credential (API key or
        session); OAuth client credentials act for no one and are refused. The
        follow-up runs as that person.
      operationId: post_v1_follow_ups
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                at:
                  description: Future ISO 8601 time with timezone. Use only one trigger.
                  type: string
                  format: date-time
                  pattern: >-
                    ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
                after:
                  description: Delay such as 90m, 4h, 14d or 2w.
                  type: string
                eventType:
                  description: Fire on this event's first matching occurrence.
                  type: string
                  enum:
                    - telegram.message.received
                    - customer.message.received
                    - product.created
                    - product.updated
                    - product.deleted
                    - product.delisted
                    - product.price.changed
                    - product.inventory.changed
                    - product.enrichment.started
                    - product.enrichment.completed
                    - product.listing.error
                    - product.geo.created
                    - product.geo.updated
                    - product.ai_visibility.measured
                    - agent.action.approved
                    - order.created
                    - order.updated
                    - order.deleted
                    - order.status.changed
                    - look.created
                    - look.deleted
                    - review.created
                    - review.updated
                    - review.status.changed
                    - campaign.started
                    - campaign.window.started
                    - campaign.window.completed
                    - campaign.window.failed
                    - campaign.offer.failed
                    - campaign.completed
                    - account_statement.created
                    - account_statement.updated
                    - account_statement.status.changed
                    - account_statement.reconciliation.changed
                    - account_statement.transactions.synced
                    - account_statement.transactions.failed
                    - account_statement.sync.queued
                    - account_statement.sync.started
                    - account_statement.sync.completed
                    - account_statement.sync.failed
                    - account_statement.sync.unavailable
                match:
                  description: >-
                    CEL event filter, e.g. event.sku == "A-1". Only with
                    eventType.
                  type: string
                  maxLength: 2000
                note:
                  type: string
                  minLength: 1
                  maxLength: 4000
                  description: What to check or do when the follow-up fires.
                then:
                  description: >-
                    resume continues this chat (default); notify only emails
                    you.
                  type: string
                  enum:
                    - resume
                    - notify
                expires:
                  description: >-
                    Expiry duration; events default to 10d. Must outlast a timed
                    trigger.
                  type: string
                organizationId:
                  type: string
                  minLength: 1
                  maxLength: 120
                threadId:
                  type: string
                  minLength: 1
                  maxLength: 200
                  description: The assistant conversation (session) to continue.
              required:
                - note
                - threadId
              additionalProperties: false
            example:
              threadId: thread_123
              after: 7d
              note: >-
                Compare SKU A-1's units sold over the 7 days since the price cut
                with the 7 days before; if there is no lift, propose reverting
                the price.
      responses:
        '200':
          description: The follow-up, waiting.
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                  operationId:
                    type: string
                  status:
                    type: string
                  data:
                    type: object
                    properties:
                      followUp:
                        type: object
                        properties:
                          id:
                            type: string
                            format: uuid
                          threadId:
                            type: string
                          ownerUserId:
                            type: string
                          state:
                            type: string
                            enum:
                              - waiting
                              - fired
                              - expired
                              - canceled
                              - failed
                          trigger:
                            type: string
                            enum:
                              - schedule
                              - event
                          fireAt:
                            type:
                              - string
                              - 'null'
                            format: date-time
                          eventType:
                            type:
                              - string
                              - 'null'
                          match:
                            type: string
                            description: CEL condition; empty when none
                          note:
                            type: string
                          then:
                            type: string
                            enum:
                              - resume
                              - notify
                          expiresAt:
                            type: string
                            format: date-time
                          firedAt:
                            type:
                              - string
                              - 'null'
                            format: date-time
                          failure:
                            type:
                              - string
                              - 'null'
                          createdAt:
                            type: string
                            format: date-time
                          url:
                            type:
                              - string
                              - 'null'
                            format: uri
                        required:
                          - id
                          - threadId
                          - state
                          - trigger
                          - note
                          - then
                          - expiresAt
        '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.