KaiCalls Email Campaigns API

The Email Campaigns API from KaiCalls — 1 operation(s) for email campaigns.

GitHub OpenAPI

Operations 2

GET /v1/email-campaigns A business's email campaigns, sending addresses and emailable audience… #
POST /v1/email-campaigns Set up a sender, draft, approve, launch or stop an email campaign (emails:write) #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/kaicalls-com:kaicalls-com-email-campaigns-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

kaicalls-com-email-campaigns-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: KaiCalls Public Email Campaigns API
  version: '2026-06-05'
  description: Machine-readable surface for KaiCalls external developers and client agents.
servers:
- url: https://www.kaicalls.com/api
security:
- bearerAuth: []
tags:
- name: Email Campaigns
paths:
  /v1/email-campaigns:
    get:
      summary: A business's email campaigns, sending addresses and emailable audience…
      description: 'Without sender_id: the campaign view, the same one the dashboard campaign page shows: senders with their setup readiness, recent campaigns (or the one named by campaign_id) with status, the revision fingerprint the owner approves, outcome counts, and the audience that can be emailed (recorded consent, not on the do-not-email list). With sender_id: the DNS records that sending domain needs. Any member of the business can read. 503 email_campaigns_unavailable when the review cannot be built right now.'
      parameters:
      - name: business_id
        in: query
        required: true
        schema:
          type: string
      - name: campaign_id
        in: query
        required: false
        schema:
          type: string
      - name: sender_id
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Campaign view, or the sender setup records
        '400':
          description: business_id is required (invalid_request)
        '403':
          description: Missing emails:read scope or no access to business_id
        '503':
          description: email_campaigns_unavailable
      x-required-scopes: emails:read
      tags:
      - Email Campaigns
      operationId: getV1EmailCampaigns
      x-operation-id-source: derived
    post:
      summary: Set up a sender, draft, approve, launch or stop an email campaign (emails:write)
      description: The only way to send email through the API. Email goes out as a campaign from the business's own verified sending domain, only to customers with recorded email consent who are not on the do-not-email list, and only after the business owner approves the exact revision. The same actions, checks and role rules as the dashboard campaign page. action 'request_sender' (domain, from, reply_to) creates the sending domain (a subdomain the business controls) and returns the DNS records to add; it turns ready on its own once they verify. action 'check_sender' (sender_id) re-checks the records now. action 'record_consent' (lead_id and email, or emails, plus evidence_ref saying where the permission came from, optional expires_at) records email permission for existing customers; 'revoke_consent' takes it back. action 'draft' (sender_id, subject, text, lead_ids, optional daily_limit, default the most the sender and the Kai level allow) saves a campaign for review and returns id and fingerprint; nothing is sent. action 'approve' (campaign_id, fingerprint) approves that exact revision. action 'launch' (campaign_id) queues an approved campaign. action 'cancel' (campaign_id, fingerprint) stops it. Sending from a KaiCalls-managed domain also needs a Kai level that includes email, and is capped at what the level allows per day (see /dashboard/level). check_sender needs any member; request_sender, record_consent, revoke_consent and draft need an admin of the business; approve, launch and cancel need the business owner; all are checked against the API key's own user. A refusal from the campaign checks (unverified sender, missing consent, changed audience, no owner approval, Kai level, sending turned off) is 409 email_campaign_refused with the reason in message.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - action
              - business_id
              properties:
                action:
                  type: string
                  enum:
                  - request_sender
                  - check_sender
                  - record_consent
                  - revoke_consent
                  - draft
                  - approve
                  - launch
                  - cancel
                business_id:
                  type: string
                lead_id:
                  type: string
                  description: 'record_consent, revoke_consent: one customer (with email).'
                email:
                  type: string
                  description: 'record_consent, revoke_consent: that customer''s address.'
                emails:
                  type: array
                  items:
                    type: string
                  description: 'record_consent, revoke_consent: addresses of existing customers (up to 200).'
                evidence_ref:
                  type: string
                  description: 'record_consent, revoke_consent: where the permission came from, e.g. web form opt-in.'
                expires_at:
                  type: string
                  description: 'record_consent, optional: when the permission ends.'
                domain:
                  type: string
                  description: 'request_sender: the sending domain.'
                from:
                  type: string
                  description: 'request_sender: the From address.'
                reply_to:
                  type: string
                  description: 'request_sender: where replies go.'
                sender_id:
                  type: string
                  description: 'draft: the verified sender. check_sender: the sender to re-check.'
                subject:
                  type: string
                  description: 'draft: the subject line.'
                text:
                  type: string
                  description: 'draft: the plain-text body.'
                lead_ids:
                  type: array
                  items:
                    type: string
                  description: 'draft: the customers to email; each needs email consent.'
                daily_limit:
                  type: integer
                  description: 'draft: most emails sent per day (default: the most the sender and the Kai level allow).'
                campaign_id:
                  type: string
                  description: approve, launch, cancel.
                fingerprint:
                  type: string
                  description: 'approve, cancel: the exact revision, from draft or GET.'
      responses:
        '200':
          description: 'request_sender: { success, senderId, status, provisioned, setupComplete, records (DNS), detail }. check_sender: { verified, status, readiness }. record_consent, revoke_consent: { changed, skipped }. draft: { id, fingerprint, packet, readiness, sendable: false }. approve, launch, cancel: the campaign result.'
        '400':
          description: 'invalid_request: bad JSON, unknown action, missing business_id, or a missing campaign_id / fingerprint.'
          content:
            application/json:
              schema:
                type: object
                required:
                - error
                properties:
                  error:
                    type: object
                    required:
                    - code
                    - message
                    properties:
                      code:
                        type: string
                      message:
                        type: string
        '403':
          description: Missing emails:write scope, no access to business_id, or the role the action needs (admin for request_sender, record_consent, revoke_consent and draft, owner for approve, launch, cancel).
          content:
            application/json:
              schema:
                type: object
                required:
                - error
                properties:
                  error:
                    type: object
                    required:
                    - code
                    - message
                    properties:
                      code:
                        type: string
                      message:
                        type: string
        '409':
          description: 'email_campaign_refused: the campaign checks refused the action.'
          content:
            application/json:
              schema:
                type: object
                required:
                - error
                properties:
                  error:
                    type: object
                    required:
                    - code
                    - message
                    properties:
                      code:
                        type: string
                      message:
                        type: string
      x-required-scopes: emails:write
      tags:
      - Email Campaigns
      operationId: postV1EmailCampaigns
      x-operation-id-source: derived
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'KaiCalls API key. Per-operation scope requirements are published on each operation as `x-required-scopes` — a scope string, or a nested `{ allOf: [...] }` / `{ anyOf: [...] }` expression. An operation with no `x-required-scopes` requires a valid key but no particular scope.'
      x-scopes:
      - workspaces:read
      - workspaces:write
      - numbers:read
      - numbers:write
      - agents:read
      - agents:write
      - communication-runs:read
      - communication-runs:write
      - calls:read
      - calls:write
      - sms:read
      - sms:write
      - webhooks:read
      - webhooks:write
      - events:read
      - events:replay
      - lifecycle:write
      - leads:read
      - leads:write
      - emails:read
      - emails:write
      - sdr:read
      - sdr:write
      - evals:read
      - evals:write
      - appointments:read
      - appointments:write
      - knowledge:read
      - knowledge:write
      - products:read
      - products:write
      - integrations:write
      - approvals:write
      - concierge:write
      - billing:read
      - billing:write
      - call_evidence:read
      - call_evidence:write
      - support:write
    sessionAuth:
      type: apiKey
      in: cookie
      name: sb-access-token
      description: Authenticated dashboard session cookie. Used by first-party flows that mint or manage API keys.