neuron_create_broadcast

Parameters schema

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "name",
    "message"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Display name or label for the broadcast"
    },
    "message": {
      "type": "string",
      "description": "Message content to broadcast to recipients"
    },
    "mediaUrl": {
      "type": "string",
      "description": "URL of media to attach (required for image or document message types)"
    },
    "channelId": {
      "type": "string",
      "description": "Identifier (UUID) of the WhatsApp channel to send through (auto-resolved from default channel if omitted)"
    },
    "recipients": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "phone"
        ],
        "properties": {
          "phone": {
            "type": "string",
            "description": "Recipient phone number in E.164 format (e.g., '+2348012345678')"
          },
          "contactName": {
            "type": "string",
            "description": "Display name of the recipient contact"
          }
        },
        "additionalProperties": false
      },
      "description": "Direct list of recipients (alternative to recipientSources)"
    },
    "messageType": {
      "type": "string",
      "description": "Type of message to send (e.g., 'text', 'image', 'document')"
    },
    "recipientSources": {
      "type": "object",
      "properties": {
        "phones": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Individual phone numbers in E.164 format to include"
        },
        "filters": {
          "type": "object",
          "properties": {
            "tags": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "Only include contacts matching these tags"
            }
          },
          "description": "Additional filters to narrow down recipients",
          "additionalProperties": false
        },
        "listIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Contact list identifiers (UUIDs or slugs) to include as recipients"
        },
        "excludeListIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Contact list identifiers (UUIDs or slugs) to exclude from recipients"
        }
      },
      "description": "Resolve recipients dynamically from contact lists with filtering and exclusion",
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

• Data resourceWhatsApp Business API

  Meta · messaging

  name mention0.75

Parent server