Create Broadcast
neuron_create_broadcastCreate a new broadcast message in draft status. Provide recipients directly or use recipientSources to resolve from contact lists. The WhatsApp channel is auto-resolved if not specified.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Display name or label for the broadcast | |
| botId | No | Identifier (UUID) of a bot to send through. Each recipient's channel is picked by the bot's load-balancer + sticky sessions. Takes precedence over channelId. | |
| message | Yes | Message content to broadcast to recipients | |
| mediaUrl | No | URL of media to attach (required for image or document message types) | |
| channelId | No | Identifier (UUID) of the WhatsApp channel to send through (auto-resolved from default channel if omitted) | |
| recipients | No | Direct list of recipients (alternative to recipientSources) | |
| messageType | No | Type of message to send (e.g., 'text', 'image', 'document') | |
| scheduledAt | No | ISO 8601 date-time for scheduled broadcast delivery (e.g., '2025-12-31T10:00:00Z'). Creates as draft if omitted. | |
| recipientSources | No | Resolve recipients dynamically from contact lists with filtering and exclusion |