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

# Send campaign

> Start sending a draft or scheduled campaign now, or pass scheduledAt to schedule it instead. Sending happens in the background.

Scope: `sms:send`.

Watch progress with Get campaign, or wait for the `campaign.completed` webhook.

With `scheduledAt` the reply is 200 `{ success, message: "Campaign scheduled for …" }` instead.



## OpenAPI

````yaml /openapi.json post /sms/campaigns/{id}/send
openapi: 3.1.0
info:
  title: Messaly API
  version: 1.0.0
  description: >-
    SMS, WhatsApp, email, contacts and CRM for your business. Amounts are in
    KES. Authenticate with an API key (Settings → API keys). A key can be
    limited to scopes and to IP addresses; a key with no scopes can call every
    endpoint here.
servers:
  - url: https://app.telaven.com/api/v1
    description: Production
security:
  - bearerAuth: []
  - apiKeyHeader: []
tags:
  - name: Account
    description: Wallet balance and SMS pricing.
  - name: SMS
    description: Send SMS and read messages and analytics.
  - name: SMS campaigns
    description: Create, schedule and send SMS campaigns to lists and tags.
  - name: Contacts
    description: Contacts and contact lists.
  - name: WhatsApp
    description: Send approved WhatsApp templates.
  - name: Email
    description: Email campaigns and unsubscribes.
  - name: CRM
    description: Deals, companies and pipelines.
paths:
  /sms/campaigns/{id}/send:
    post:
      tags:
        - SMS campaigns
      summary: Send campaign
      description: >-
        Start sending a draft or scheduled campaign now, or pass scheduledAt to
        schedule it instead. Sending happens in the background.


        Scope: `sms:send`.


        Watch progress with Get campaign, or wait for the `campaign.completed`
        webhook.


        With `scheduledAt` the reply is 200 `{ success, message: "Campaign
        scheduled for …" }` instead.
      operationId: sendCampaign
      parameters:
        - name: id
          in: path
          required: true
          description: The campaign ID.
          schema:
            type: string
            format: uuid
        - name: Idempotency-Key
          in: header
          required: false
          description: >-
            Optional. A unique value (e.g. a UUID) per operation, up to 255
            characters. Retrying with the same key and body returns the first
            response instead of doing it again. Kept 24 hours.
          schema:
            type: string
            example: 5f1c2b0e-8d6a-4c1f-9a43-2b7e0f6d1a90
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                scheduledAt:
                  type: string
                  format: date-time
                  description: 'Optional: schedule instead of sending now.'
              required: []
            example: {}
      responses:
        '202':
          description: Success
          content:
            application/json:
              example:
                success: true
                message: >-
                  Campaign queued for processing. 1196 recipient(s) will be sent
                  in batches.
                status: processing
                totalQueued: 1196
        '400':
          description: >-
            ALL_OPTED_OUT: Everyone on it has opted out. / The campaign isn't
            draft or scheduled, or has no recipients.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: No API key, or the key is wrong, disabled or expired.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '402':
          description: >-
            INSUFFICIENT_BALANCE: Your wallet doesn't cover the cost. Top up and
            retry.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: >-
            VERIFICATION_REQUIRED: The platform requires account verification
            before sending, and yours isn't approved yet. / The key doesn't have
            the scope this endpoint needs, or it's used from an address its IP
            allowlist doesn't include.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No campaign with that ID in your account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: >-
            IDEMPOTENCY_IN_PROGRESS: A request with this Idempotency-Key is
            still running. Wait and retry.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: >-
            IDEMPOTENCY_KEY_REUSED: This Idempotency-Key was already used for a
            different request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: >-
            More than 120 requests in a minute with this key. Wait for the
            number of seconds in Retry-After.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: >-
            Something went wrong on our side. Retry with backoff. A POST sent
            with an Idempotency-Key replays this same error for that key,
            because the request may have partly run: check the result before
            trying again with a new key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
        code:
          type: string
          description: Machine-readable code where one exists, e.g. INSUFFICIENT_BALANCE.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Authorization: Bearer tlv_…'
    apiKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key

````

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