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

# Send or schedule a campaign

> Validates the campaign, resolves recipients from its segments (respecting global and topic unsubscribes and suppression), queues them and sets the status to sending (mode now) or scheduled (mode schedule); the dispatcher delivers asynchronously. Requires a verified Maileroo marketing provider, a verified sender and a registered company address in Settings > Finance. Only draft or scheduled campaigns can be sent; a retried call queues no duplicates.



## OpenAPI

````yaml https://www.amdital.com/openapi.json post /api/v1/campaigns/{id}/send
openapi: 3.0.0
info:
  title: AmDital API
  description: >-
    AmDital enterprise business operating system API — generated directly from
    the live NestJS controllers and their Zod request/response schemas (see
    apps/api/src/openapi/generate.ts).
  version: 2.0.0
  contact: {}
servers:
  - url: https://api.amdital.com
    description: Production
  - url: http://localhost:8000
    description: Local development
security:
  - bearerAuth: []
tags:
  - name: Health
    description: Liveness/readiness probe. Unauthenticated.
  - name: AuthNext
    description: >-
      Live authentication surface — login, password verification, token refresh,
      session management, MFA, and admin credential resets.
      login/verify-password/refresh are public (the credential exchange itself);
      session/MFA routes require the bearer JWT they issue; admin/* routes are
      internal-key gated, server-to-server only.
  - name: Content
    description: >-
      Generic tenant-scoped CRUD over the 49 allowlisted content/config
      collections (see the `collection` path parameter enum) — the NestJS
      replacement for Payload REST on these collections; response shapes match
      Payload REST so existing consumers work unchanged.
  - name: Activity
    description: >-
      Activity logs and screenshot capture/scoring for the time-tracking desktop
      agent.
  - name: Ai
    description: AMI agents, prompts, and workflows — create, deploy/activate, and manage.
  - name: Calendar
    description: Workspace calendars and calendar events.
  - name: Clients
    description: Client organizations and client contacts.
  - name: Content Admin
    description: >-
      Public reads for roadmap items, testimonials, feature ideas, and
      blog/survey content; write endpoints (create/update/remove, upvote, survey
      responses) require the `x-internal-key`/`x-api-key` server-to-server
      header — these writes are not for third-party API consumers.
  - name: Crm
    description: >-
      Companies, leads, deals, pipelines, products, sequences, sequence
      enrollments, custom field definitions, lead routing rules, and client
      portal tokens. Contacts are documented separately under the Clients tag.
  - name: Docs
    description: >-
      Tenant-internal wiki: doc categories and doc pages (distinct from the
      public docs-site content under Public Content).
  - name: Finance
    description: Invoices, payments, budgets, expenses, and purchase orders.
  - name: Goals
    description: Workspace goals/OKRs.
  - name: Hrms
    description: >-
      Employees, departments, roles, shifts, leave requests, performance
      reviews, payroll runs, compliance records, salary structures/revisions,
      bonuses, arrears, and the per-employee payroll activity feed.
  - name: Integrations
    description: Outbound webhooks and third-party integration tokens.
  - name: Lms
    description: >-
      Learning management: the paginated course list, enrollment/module/lesson
      CRUD, lesson completion, course favorites, and course-category CRUD.
  - name: Marketing
    description: Marketing campaigns, email templates, and marketing assets.
  - name: Public Content
    description: >-
      Fully public, unauthenticated docs/marketing content reads (doc
      categories, doc articles, changelog, FAQs) — paths intentionally match
      Payload REST exactly (no `/v1`, no auth) because apps/docs hardcodes these
      URLs.
  - name: Recruitment
    description: Job postings, applicants, and interviews.
  - name: Reports
    description: Saved report configurations/definitions.
  - name: Report Definitions
    description: >-
      Reusable saved report definitions (name/type/filter-definition/schedule)
      distinct from the one-off generated reports above — includes "run" to
      execute a definition and produce a new report_snapshots row.
  - name: Support
    description: Support channels and tickets, including ticket assignment.
  - name: Time
    description: Time entries/timers and timesheets, including submit/approve/reject.
  - name: Approvals
    description: >-
      Approval requests — read and decide only, by design (no
      create/update/delete).
  - name: Work
    description: Projects, tasks, sprints, chat channels/messages, and work files.
  - name: Notifications
    description: >-
      The signed-in user's in-app notification inbox for the current workspace
      (read-only).
  - name: Workspaces
    description: >-
      Workspaces the signed-in user belongs to (self-service, not scoped to one
      workspace).
  - name: Mcp
    description: >-
      Model Context Protocol server (stateless Streamable HTTP) — the JSON-RPC
      2.0 endpoint (POST, authenticated by a workspace API key or auth-next
      JWT), a public human-readable descriptor at `/info` (GET), and
      spec-mandated 405s for GET/DELETE at the bare endpoint (no SSE stream, no
      sessions).
  - name: Mcp OAuth
    description: >-
      Consent screen backing (read/decide a pending MCP OAuth authorization) and
      the workspace's connected-AI-tool grants (list/revoke). Bearer JWT
      required.
  - name: Metrics
    description: >-
      Prometheus text-format scrape endpoint, authenticated by its own static
      scrape token (not a user JWT).
  - name: Privacy
    description: >-
      GDPR self-service for the signed-in user (export of their personal data,
      irreversible account erasure) and workspace-admin export/erasure of an
      external help-desk requester by email. Bearer JWT required; impersonation
      tokens are refused.
  - name: Internal
    description: >-
      Server-to-server endpoints for AmDital's own apps (trusted Origin + proxy
      secret). Not for third-party API consumers.
paths:
  /api/v1/campaigns/{id}/send:
    post:
      tags:
        - Marketing
      summary: Send or schedule a campaign
      description: >-
        Validates the campaign, resolves recipients from its segments
        (respecting global and topic unsubscribes and suppression), queues them
        and sets the status to sending (mode now) or scheduled (mode schedule);
        the dispatcher delivers asynchronously. Requires a verified Maileroo
        marketing provider, a verified sender and a registered company address
        in Settings > Finance. Only draft or scheduled campaigns can be sent; a
        retried call queues no duplicates.
      operationId: MarketingServiceController_sendCampaign
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendCampaign'
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    type: object
                    required:
                      - campaignId
                      - status
                      - recipients
                      - excluded
                    properties:
                      campaignId:
                        type: string
                        format: uuid
                      status:
                        type: string
                        enum:
                          - scheduled
                          - sending
                      recipients:
                        type: integer
                        description: >-
                          Contacts queued for this campaign (also written to
                          stat_prospects).
                      excluded:
                        type: object
                        description: >-
                          Contacts of the selected segments that were not
                          queued, each counted under exactly one reason.
                        required:
                          - unsubscribed
                          - topicUnsubscribed
                          - suppressed
                          - noEmail
                        properties:
                          unsubscribed:
                            type: integer
                          topicUnsubscribed:
                            type: integer
                            description: >-
                              Unsubscribed from the campaign topic, or not
                              subscribed to a default-off topic.
                          suppressed:
                            type: integer
                            description: >-
                              Bounced, complained, cleaned or double-opt-in
                              pending.
                          noEmail:
                            type: integer
        '400':
          description: >-
            Invalid body or path id; campaign is not an email campaign, lacks
            subject, segments or an HTML template; no verified Maileroo
            marketing provider or sender; topic archived; or no sendable
            recipients
        '401':
          description: Missing or invalid authorization
        '403':
          description: Caller lacks marketing.campaigns.update.workspace
        '404':
          description: Campaign not found in this workspace
        '409':
          description: >-
            Campaign status is not draft or scheduled, or the workspace has no
            registered address in Settings > Finance
components:
  schemas:
    SendCampaign:
      type: object
      properties:
        mode:
          type: string
          enum:
            - now
            - schedule
        scheduledAt:
          type: string
          format: date-time
      required:
        - mode
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      scheme: bearer
      bearerFormat: JWT
      type: http

````

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