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

# Create campaigns

> Creates and dispatches a campaign to a defined recipient audience, immediately or on a schedule. Use campaigns for larger sends that need delivery metrics and lifecycle status.



## OpenAPI

````yaml /openapi.json post /campaigns
openapi: 3.1.0
info:
  title: Wachat API
  version: v1
  description: >-
    Wachat REST API. Authenticate with a workspace API key: send it as
    `Authorization: Bearer <key>`. Generate keys in the dashboard under
    Developers / API.
servers:
  - url: https://crm.wachat.net/api/v1
security:
  - http: []
tags:
  - name: Message
    description: >-
      Send a single WhatsApp message — text, media (image / video / document /
      audio) or a location pin — to one number, then read its delivery status or
      your message history. A file can be attached directly as a multipart
      `media` field or referenced by a public URL.
  - name: Template
    description: >-
      Create, list and manage your approved WhatsApp templates, and send a
      template to one number with your own header, body variables and button
      values. Use this for utility / marketing sends that need a pre-approved
      template — including one with a PDF / document header (pass the file's
      public URL as the header, e.g. from the Media endpoint).
  - name: Media
    description: >-
      Upload a file once (multipart / form-data, field name `file`, up to 16 MB)
      and get back a hosted public URL you can reuse across sends — for example
      a PDF to use as a document-header on a template, or an image on a message.
  - name: Contact
    description: >-
      Full create / read / update / delete over your contacts and leads,
      including search by number, tags and custom attributes.
  - name: ContactGroup
    description: >-
      Organise contacts into groups: create groups, list them, and add or remove
      members — handy for targeting broadcasts and campaigns.
  - name: Broadcast
    description: >-
      Send the same message to many contacts at once and track each broadcast's
      progress and per-recipient delivery.
  - name: Campaign
    description: >-
      Create, start, pause and monitor drip / marketing campaigns and their
      recipients.
  - name: Scheduled
    description: >-
      Schedule a WhatsApp send for a future time, list upcoming scheduled
      messages, and cancel one before it goes out.
  - name: AutoReply
    description: >-
      Manage keyword auto-replies — the automatic responses that fire when an
      inbound message matches a rule.
  - name: Flow
    description: >-
      Enroll a contact into an automation flow (chatbot) and manage your flows
      through the API.
  - name: Device
    description: >-
      List the WhatsApp numbers / devices connected to your workspace and check
      each one's connection status.
  - name: Webhook
    description: >-
      Register and manage webhook endpoints so Wachat POSTs real-time events
      (message received / sent / delivered / read / failed, plus campaign and
      contact events) to your server. When you set a signing secret each
      delivery carries an HMAC-SHA256 signature header you can verify.
  - name: Deal
    description: >-
      Manage sales-pipeline deals — create, list, update and move deals between
      stages.
  - name: Conversation
    description: >-
      Read your workspace inbox: list chat threads (conversations) and fetch the
      messages inside a thread.
  - name: Account
    description: Read your account details, plan, limits and message-credit usage.
paths:
  /campaigns:
    post:
      tags:
        - Campaign
      summary: Create campaigns
      description: >-
        Creates and dispatches a campaign to a defined recipient audience,
        immediately or on a schedule. Use campaigns for larger sends that need
        delivery metrics and lifecycle status.
      operationId: v1.campaigns.store
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StoreCampaignRequest'
      responses:
        '201':
          description: Resource created successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items: {}
                  meta:
                    type: string
                required:
                  - data
                  - meta
        '402':
          description: Request failed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        const: plan_limit
                      message:
                        anyOf:
                          - type: string
                          - type: string
                            enum:
                              - Campaign plan limit reached.
                      details:
                        type: string
                    required:
                      - code
                      - message
                      - details
                required:
                  - error
        '422':
          $ref: '#/components/responses/ValidationException'
          description: Request failed.
components:
  schemas:
    StoreCampaignRequest:
      type: object
      description: >-
        Create a campaign — a multi-recipient send (template, custom message or

        flow) with optional A/B testing. Scramble reads these rules to document
        the

        request body.


        Mirrors the input keys the existing App\CampaignController::store
        accepts

        (campaign_name / device_id / campaign_type / schedule_type /
        template_id(s) /

        flow_id / custom_message / send_date+send_time / timezone / ab_* /
        contacts),

        exposed under public-facing names. Recipients are supplied as a list of

        phone numbers in international format.
      properties:
        campaign_name:
          type: string
          description: Campaign label shown in the dashboard. Required.
          maxLength: 255
        device_id:
          type: string
          description: Sending device — the device's phone number or id. Required.
        campaign_type:
          type: string
          description: What the campaign sends. Required.
          enum:
            - custom
            - template
            - flow
        schedule_type:
          type: string
          description: >-
            When to send: now, later (needs send_date+send_time), or recurring.
            Required.
          enum:
            - now
            - later
            - recurring
        template_id:
          type:
            - integer
            - 'null'
          description: WaTemplate id (required for non-A/B template campaigns).
        template_id_a:
          type:
            - integer
            - 'null'
          description: 'A/B testing: the two competing WaTemplate ids.'
        template_id_b:
          type:
            - integer
            - 'null'
        flow_id:
          type:
            - integer
            - 'null'
          description: Flow id (required for flow campaigns).
        custom_message:
          type:
            - string
            - 'null'
          description: Free-text message body (required for custom campaigns).
          maxLength: 4096
        send_date:
          type:
            - string
            - 'null'
          format: date-time
          description: Date to send on (Y-m-d) — required when schedule_type=later.
        send_time:
          type:
            - string
            - 'null'
          description: Time to send at (HH:MM) — required when schedule_type=later.
          maxLength: 16
        timezone:
          type:
            - string
            - 'null'
          description: IANA timezone for send_date/send_time. Defaults to UTC.
          maxLength: 64
        ab_testing:
          type:
            - string
            - 'null'
          description: Enable A/B testing (template campaigns only).
        ab_split:
          type:
            - integer
            - 'null'
          description: Percentage of recipients sent variant A (10-90). Defaults to 50.
          minimum: 10
          maximum: 90
        contacts:
          type: array
          description: >-
            Recipient phone numbers in international format. At least one
            required.
          items:
            type: string
            maxLength: 32
          minItems: 1
      required:
        - campaign_name
        - device_id
        - campaign_type
        - schedule_type
        - contacts
      title: StoreCampaignRequest
  responses:
    ValidationException:
      description: Validation error
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: Errors overview.
              errors:
                type: object
                description: A detailed description of each field that failed validation.
                additionalProperties:
                  type: array
                  items:
                    type: string
            required:
              - message
              - errors
  securitySchemes:
    http:
      type: http
      scheme: bearer

````