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

# Create campaign

> Create a campaign from contact lists, contact tags and/or numbers. It's saved as a draft (or scheduled); send it with Send campaign.

Scope: `sms:send`.

Repeated numbers are removed. People who opted out are left out when the campaign is sent.



## OpenAPI

````yaml /openapi.json post /sms/campaigns
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:
    post:
      tags:
        - SMS campaigns
      summary: Create campaign
      description: >-
        Create a campaign from contact lists, contact tags and/or numbers. It's
        saved as a draft (or scheduled); send it with Send campaign.


        Scope: `sms:send`.


        Repeated numbers are removed. People who opted out are left out when the
        campaign is sent.
      operationId: createCampaign
      parameters:
        - 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:
                name:
                  type: string
                  example: November offer
                  description: For your own reference.
                message:
                  type: string
                  example: >-
                    Hi {first_name}, 20% off until Friday. Reply STOP to opt
                    out.
                  description: >-
                    The SMS text. Personalise with {first_name}, {name} or
                    {phone}.
                contactListIds:
                  type: array
                  items:
                    type: string
                  description: Contact lists to send to.
                tags:
                  type: array
                  items:
                    type: string
                  example:
                    - vip
                  description: Send to contacts carrying any of these tags.
                manualPhones:
                  type: array
                  items:
                    type: string
                  description: Extra numbers.
                sendType:
                  type: string
                  enum:
                    - immediate
                    - scheduled
                  description: Default immediate.
                scheduledAt:
                  type: string
                  format: date-time
                  description: Required when sendType is scheduled.
              required:
                - name
                - message
            example:
              name: November offer
              message: Hi {first_name}, 20% off until Friday. Reply STOP to opt out.
              contactListIds:
                - c51e…
              tags:
                - vip
      responses:
        '201':
          description: Success
          content:
            application/json:
              example:
                success: true
                data:
                  id: 6f1c…
                  name: November offer
                  status: draft
                  totalRecipients: 1200
                  totalQueued: 1200
                  createdAt: '2026-11-12T09:00:00.000Z'
        '400':
          description: >-
            Missing name or message, unknown contact list, or no valid
            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'
        '403':
          description: >-
            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'
        '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.