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

> Creates and dispatches a broadcast to contacts or groups using a message or approved template. Use it for one-to-many delivery when you need recipient-level status tracking.



## OpenAPI

````yaml /openapi.json post /broadcasts
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:
  /broadcasts:
    post:
      tags:
        - Broadcast
      summary: Create broadcasts
      description: >-
        Creates and dispatches a broadcast to contacts or groups using a message
        or approved template. Use it for one-to-many delivery when you need
        recipient-level status tracking.
      operationId: v1.broadcasts.store
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StoreBroadcastRequest'
      responses:
        '201':
          description: Resource created successfully.
          content:
            application/json:
              schema:
                anyOf:
                  - type: object
                    properties:
                      data:
                        type: array
                        items: {}
                      meta:
                        type: object
                        properties:
                          broadcast_ids:
                            anyOf:
                              - type: string
                              - type: array
                                prefixItems:
                                  - type: string
                                minItems: 1
                                maxItems: 1
                                additionalItems: false
                          devices_count:
                            anyOf:
                              - type: string
                              - type: integer
                                enum:
                                  - 1
                        required:
                          - broadcast_ids
                          - devices_count
                    required:
                      - data
                      - meta
                  - type: object
                    properties:
                      data:
                        type: object
                        properties:
                          broadcast_ids:
                            anyOf:
                              - type: string
                              - type: array
                                items:
                                  type: string
                                minItems: 0
                                maxItems: 0
                                additionalItems: false
                          devices_count:
                            anyOf:
                              - type: string
                              - type: integer
                                enum:
                                  - 1
                        required:
                          - broadcast_ids
                          - devices_count
                      meta:
                        type: string
                    required:
                      - data
                      - meta
        '422':
          $ref: '#/components/responses/ValidationException'
          description: Request failed.
components:
  schemas:
    StoreBroadcastRequest:
      type: object
      description: >-
        Create a broadcast — send one template to a list of contacts and/or a

        contact group. Scramble reads these rules to document the request body.


        Mirrors the input keys the existing BroadcastsController::store accepts

        (broadcast_name / template_id / contacts[] / groups[] / device_id /

        schedule_type+send_date+send_time / timezone), exposed under
        public-facing

        names. At least one of `recipients` or `group_id` is required; provide

        `schedule_at` to schedule for later, omit it to send now.
      properties:
        name:
          type: string
          description: Broadcast label shown in the dashboard. Required.
          maxLength: 255
        template_id:
          type: integer
          description: Approved WaTemplate id to send to every recipient. Required.
        group_id:
          type:
            - integer
            - 'null'
          description: Contact-group id — every member is added as a recipient.
        device_id:
          type:
            - integer
            - 'null'
          description: >-
            Sending device id (optional — defaults to the workspace's primary
            device).
        schedule_at:
          type:
            - string
            - 'null'
          description: >-
            When to send — ISO 8601 / parseable datetime. Omit to send
            immediately.
          maxLength: 64
        timezone:
          type:
            - string
            - 'null'
          description: IANA timezone for schedule_at (e.g. Asia/Kolkata). Defaults to UTC.
          maxLength: 64
        recipients:
          type:
            - array
            - 'null'
          description: Recipient contact ids. Required unless `group_id` is given.
          items:
            type: integer
      required:
        - name
        - template_id
      title: StoreBroadcastRequest
  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

````