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

# Send an interactive message

> Send interactive buttons or a list. Needs an open window.

Send interactive reply buttons or a list. Pass a WhatsApp `interactive` object as-is; its `type` (e.g. `button`, `list`) is required. Target with `to` and `sender` (or just `to` if you have one active sender), or pass `conversation_id` to send into a specific existing thread. Needs an **open 24-hour window**. Async: returns **202** `{ message_id, status: "pending" }`.

The customer's choice arrives as an inbound message — read it via [List messages](/Karibu-WhatsApp/messages/list) or a webhook.


## OpenAPI

````yaml openapi.json POST /v1/whatsapp/messages/interactive
openapi: 3.1.0
info:
  title: Briq API
  description: Karibu Briq API Documentation
  version: '0.8'
servers:
  - url: https://karibu.briq.tz
    description: Production
  - url: https://pre-release.karibu.briq.tz
    description: Pre-release
  - url: http://karibu.briq.tz
    description: LocalPass
security: []
paths:
  /v1/whatsapp/messages/interactive:
    post:
      tags:
        - Karibu-Whatsapp-Messages
      summary: Send an interactive message
      description: Send interactive buttons or a list. Needs an open window.
      operationId: wa_send_interactive_message
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                to:
                  type: string
                  minLength: 7
                  maxLength: 20
                  pattern: ^\+?[1-9]\d{6,17}$
                  description: >-
                    Recipient phone in E.164 digits (optional leading +), e.g.
                    255712345678. The number you are messaging. Pair with
                    `sender`.
                sender:
                  type: string
                  maxLength: 64
                  description: >-
                    Which of your WhatsApp numbers to send from (number or
                    phone_number_id). Pair with `to` to target the conversation.
                    Optional when your workspace has a single active sender.
                    Preferred over sender_id.
                conversation_id:
                  type: string
                  format: uuid
                  description: >-
                    Alternative to `sender`. The id of an existing one-to-one
                    thread; recipient and sender are taken from it, so `to` /
                    `sender` / `sender_id` are ignored. Use this to pin a
                    precise conversation when the same recipient can be reached
                    through more than one of your senders.
                sender_id:
                  type: string
                  format: uuid
                  description: 'Deprecated: use `sender`.'
                interactive:
                  type: object
                  additionalProperties: true
                  description: >-
                    WhatsApp interactive object; its `type` (e.g. button, list)
                    is required.
              required:
                - interactive
            examples:
              example:
                value:
                  to: '255712345678'
                  interactive:
                    type: button
                    body:
                      text: Did this resolve your issue?
                    action:
                      buttons:
                        - type: reply
                          reply:
                            id: 'yes'
                            title: 'Yes'
                        - type: reply
                          reply:
                            id: 'no'
                            title: 'No'
      responses:
        '200':
          description: Sent immediately (provider acknowledged).
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    $ref: '#/components/schemas/WaSendData'
                  errors:
                    type: array
                    nullable: true
                    items:
                      $ref: '#/components/schemas/WaApiError'
                  request_id:
                    type: string
        '202':
          description: Queued
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    $ref: '#/components/schemas/WaSendData'
                  errors:
                    type: array
                    nullable: true
                    items:
                      $ref: '#/components/schemas/WaApiError'
                  request_id:
                    type: string
        '400':
          description: No active sender or template parameter count mismatch.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WaErrorEnvelope'
        '403':
          description: API key is not linked to a workspace (WORKSPACE_REQUIRED).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WaErrorEnvelope'
        '404':
          description: Template or sender not found in this workspace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WaErrorEnvelope'
        '422':
          description: >-
            Validation error, closed 24h window, recipient unreachable, or a
            provider failure (PROVIDER_UNAVAILABLE / WHATSAPP_REAUTH_REQUIRED /
            SEND_FAILED). On provider failures, data.message_id is present and
            pollable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WaErrorEnvelope'
components:
  schemas:
    WaSendData:
      type: object
      properties:
        message_id:
          type: string
          format: uuid
          nullable: true
          description: >-
            Internal message id. Use it with GET
            /v1/whatsapp/messages/{message_id}.
        conversation_id:
          type: string
          format: uuid
          nullable: true
        sender_id:
          type: string
          format: uuid
          nullable: true
          description: Internal UUID of the sender the message went out on.
        sender:
          type: string
          nullable: true
          example: '1107264639145282'
          description: The phone_number_id of the sender the message went out on.
        provider_message_id:
          type: string
          nullable: true
          description: WhatsApp wamid once the message is sent; null while queued.
        status:
          type: string
          example: pending
          enum:
            - pending
            - sent
            - failed
    WaApiError:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
        field:
          type: string
          nullable: true
    WaErrorEnvelope:
      type: object
      properties:
        success:
          type: boolean
          example: false
        data:
          type: object
          nullable: true
          description: >-
            On a failed send that still produced a record, carries the pollable
            message_id with status='failed'; otherwise null.
        errors:
          type: array
          items:
            $ref: '#/components/schemas/WaApiError'
        request_id:
          type: string

````