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

# Send a broadcast

> Sends an approved WhatsApp template to every contact in the group who has a WhatsApp conversation. Delivery is attempted per recipient; the response reports how many succeeded and failed.

Rate limit: 10 requests per minute.



## OpenAPI

````yaml /api-reference/openapi.json post /api/v1/contact-groups/{groupId}/broadcasts
openapi: 3.1.0
info:
  title: Adraa Inbox API
  description: >-
    Public REST API for Adraa Inbox. Assign agents to conversations and send
    messages from your own systems. Authenticate every request with a workspace
    API token.
  version: 1.0.0
  contact:
    email: support@adraa.ai
servers:
  - url: https://api.inbox.adraa.ai
    description: Production
security:
  - apiToken: []
paths:
  /api/v1/contact-groups/{groupId}/broadcasts:
    post:
      summary: Send a broadcast
      description: >-
        Sends an approved WhatsApp template to every contact in the group who
        has a WhatsApp conversation. Delivery is attempted per recipient; the
        response reports how many succeeded and failed.


        Rate limit: 10 requests per minute.
      operationId: sendBroadcast
      parameters:
        - $ref: '#/components/parameters/groupId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - templateName
              properties:
                templateName:
                  type: string
                  maxLength: 512
                  description: Name of an approved WhatsApp template in this workspace.
                  example: order_status_update
                language:
                  type: string
                  default: en_US
                  description: Template language code.
                  example: en_US
                parameters:
                  type: array
                  items:
                    type: string
                    maxLength: 1024
                  description: >-
                    Values for the template's {{1}}, {{2}}, … placeholders, in
                    order. The same values are used for every recipient.
                  example:
                    - Sara
                    - A-1043
                    - Shipped
      responses:
        '201':
          description: Broadcast processed
          content:
            application/json:
              schema:
                type: object
                properties:
                  broadcast:
                    $ref: '#/components/schemas/Broadcast'
        '400':
          description: The group is empty or no member has a WhatsApp conversation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: NO_WHATSAPP_RECIPIENTS
                  message: >-
                    None of the contacts in this group have a WhatsApp
                    conversation
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/ContactGroupNotFound'
components:
  parameters:
    groupId:
      name: groupId
      in: path
      required: true
      description: >-
        ID of the contact group. List groups with `GET /api/v1/contact-groups`
        to find it.
      schema:
        type: string
        example: cmbxh1a2b0004ph01q8r9s0t1
  schemas:
    Broadcast:
      type: object
      properties:
        id:
          type: string
          example: cmbxh3c4d0006ph01u2v3w4x5
        groupId:
          type:
            - string
            - 'null'
          example: cmbxh1a2b0004ph01q8r9s0t1
        groupName:
          type: string
          example: VIP customers
        channel:
          type: string
          example: whatsapp
        templateName:
          type: string
          example: order_status_update
        templateLanguage:
          type: string
          example: en_US
        status:
          type: string
          enum:
            - completed
            - partial
            - failed
          description: >-
            `completed` — every recipient succeeded; `partial` — some failed;
            `failed` — none were delivered.
          example: completed
        totalRecipients:
          type: integer
          description: Group members who had a WhatsApp conversation to deliver to.
          example: 37
        sentCount:
          type: integer
          example: 37
        failedCount:
          type: integer
          example: 0
        createdAt:
          type: string
          format: date-time
          example: '2026-06-15T12:00:00.000Z'
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: Machine-readable error code.
            message:
              type: string
              description: Human-readable explanation.
            details:
              description: Field-level details for validation errors.
              type: array
              items:
                type: object
                properties:
                  field:
                    type: string
                  message:
                    type: string
  responses:
    Unauthorized:
      description: Missing, invalid, or revoked API token
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: INVALID_API_TOKEN
              message: Invalid or revoked API token
    ContactGroupNotFound:
      description: Contact group does not exist or belongs to another workspace
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: CONTACT_GROUP_NOT_FOUND
              message: Contact group not found
  securitySchemes:
    apiToken:
      type: http
      scheme: bearer
      description: >-
        Workspace API token created in Settings → API. Tokens start with
        `adraa_`.

````