> ## Documentation Index > Fetch the complete documentation index at: https://docs.kapso.ai/llms.txt > Use this file to discover all available pages before exploring further. # Create broadcast > Create a broadcast campaign in draft mode. Workflow: create broadcast → add recipients → send. Broadcasts stay in draft until you call the send endpoint. ## OpenAPI ````yaml /api/platform/v1/openapi-platform.yaml post /whatsapp/broadcasts openapi: 3.1.0 info: title: Kapso Platform API version: 0.2.0 description: > Build WhatsApp messaging into your product. Manage customers, connect phone numbers, send broadcasts, and handle conversations. servers: - url: https://api.kapso.ai/platform/v1 description: Production security: - ApiKeyAuth: [] tags: - name: Customers description: Manage customer accounts - name: Setup Links description: WhatsApp onboarding via embedded signup - name: Phone Numbers description: Connect and manage WhatsApp numbers - name: Webhooks description: Subscribe to WhatsApp events - name: Display Names description: Update WhatsApp business display names - name: Broadcasts description: | Send template messages at scale **Alpha**: This API is in alpha and subject to change - name: Conversations description: Manage conversation state - name: Media description: Upload media files for WhatsApp messaging - name: Users description: Manage project team members - name: Inbox Embeds description: Create and manage embeddable inbox access links - name: Webhook Deliveries description: View webhook delivery attempts and their status - name: External API Logs description: View logs of external API calls made by the project - name: Log Search description: Search Logs V2 events across API, Meta, workflow, and webhook sources - name: Provider Models description: List available AI provider models - name: WhatsApp Flows description: Build interactive WhatsApp Flows for surveys and forms - name: Contacts description: Manage WhatsApp contacts paths: /whatsapp/broadcasts: post: tags: - Broadcasts summary: Create broadcast description: > Create a broadcast campaign in draft mode. Workflow: create broadcast → add recipients → send. Broadcasts stay in draft until you call the send endpoint. operationId: createWhatsappBroadcast requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/WhatsappBroadcastCreateRequest' examples: meta_id: summary: Create with Meta template ID (preferred) value: whatsapp_broadcast: name: Weekend Sale 2025 phone_number_id: '1234567890' whatsapp_template_id: '784203120908608' legacy: summary: Legacy UUID (backward compatibility) value: whatsapp_broadcast: name: Weekend Sale 2025 phone_number_id: '1234567890' whatsapp_template_id: 7a8b9c0d-1e2f-3a4b-5c6d-7e8f9a0b1c2d responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/WhatsappBroadcastResponse' examples: draft: value: data: id: 5f6a7b8c-9d0e-1f2a-3b4c-5d6e7f8a9b0c name: Weekend Sale 2025 status: draft started_at: null completed_at: null created_at: '2025-07-14T15:00:00Z' updated_at: '2025-07-14T15:00:00Z' phone_number_id: '1234567890' whatsapp_template: id: '784203120908608' meta_template_id: '784203120908608' name: weekend_sale_2025 language_code: en_US category: MARKETING status: approved components: - type: BODY text: >- Hi {{name}}! Get {{discount}}% off this weekend only! example: body_text_named_params: - param_name: name example: John - param_name: discount example: '25' total_recipients: 0 sent_count: 0 failed_count: 0 delivered_count: 0 read_count: 0 responded_count: 0 pending_count: 0 response_rate: 0 '401': $ref: '#/components/responses/UnauthorizedError' '404': description: Phone number or template not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '422': $ref: '#/components/responses/ValidationError' components: schemas: WhatsappBroadcastCreateRequest: type: object required: - whatsapp_broadcast properties: whatsapp_broadcast: type: object required: - name - phone_number_id - whatsapp_template_id properties: name: type: string description: Campaign name phone_number_id: type: string description: Phone number ID to send from whatsapp_template_id: type: string description: >- Meta template ID (preferred) or internal UUID (legacy compatibility only). Migrate to Meta IDs for future compatibility. WhatsappBroadcastResponse: type: object required: - data properties: data: $ref: '#/components/schemas/WhatsappBroadcast' ErrorResponse: type: object required: - error properties: error: type: string WhatsappBroadcast: type: object required: - id - name - status - created_at - updated_at - total_recipients properties: id: type: string format: uuid name: type: string description: Campaign label status: type: string enum: - draft - scheduled - sending - stopped - completed - failed scheduled_at: type: - string - 'null' format: date-time description: When broadcast is scheduled to send started_at: type: - string - 'null' format: date-time description: When sending started stopped_at: type: - string - 'null' format: date-time description: When sending was stopped completed_at: type: - string - 'null' format: date-time description: When completed created_at: type: string format: date-time updated_at: type: string format: date-time sent_count: type: integer minimum: 0 description: Messages sent failed_count: type: integer minimum: 0 description: Failures delivered_count: type: integer minimum: 0 description: Delivered read_count: type: integer minimum: 0 description: Read pending_count: type: integer minimum: 0 description: Pending responded_count: type: integer minimum: 0 description: Responses response_rate: type: number format: float description: Response rate % total_recipients: type: integer minimum: 0 description: Total recipients phone_number_id: type: - string - 'null' description: Phone number ID whatsapp_template: anyOf: - $ref: '#/components/schemas/WhatsappBroadcastTemplate' - type: 'null' WhatsappBroadcastTemplate: type: object required: - id - name - language_code - category - status properties: id: type: string description: >- Meta template ID when available, otherwise internal UUID for legacy support meta_template_id: type: - string - 'null' description: Meta's external template identifier name: type: string language_code: type: string category: type: string status: type: string components: type: array description: Template component definitions (BODY, HEADER, BUTTON, etc.) items: type: object additionalProperties: true responses: UnauthorizedError: description: Missing or invalid API key content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' ValidationError: description: Request validation failed content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' securitySchemes: ApiKeyAuth: type: apiKey in: header name: X-API-Key ````