Send ad-hoc campaign
gambot_send_campaignSend an ad-hoc WhatsApp campaign to a chosen audience via phone numbers, Excel upload, or CRM filters. Use a template or custom message; opt-out and consent compliance are handled automatically.
Instructions
Run an ad-hoc campaign WITHOUT saving it first. Provide an audience (recipientPhoneNumbers, excelRecipients or filters) and the message (messageType='Template'+templateId, or 'regular'+message). Compliance is built in: every org has an ACTIVE opt-out flow (recipients reply הסר/stop/unsubscribe to be excluded from future broadcasts); the response echoes it under optOut (enabled=true) and your consent-to-mail under consent.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| filters | No | CRM segment { filters:[...], logic } → resolved to phones. | |
| message | No | ||
| templateId | No | ||
| messageType | Yes | ||
| fromNumberId | No | ||
| defaultCountry | No | ISO-3166 alpha-2 (e.g. 'US','IL') to internationalize local/national recipient numbers. Optional if the organization has a saved country (set at onboarding); otherwise numbers must be full E.164 or the send is rejected. | |
| excelRecipients | No | Per-recipient: [{ phone, variables:{var1:..}, rowData:{} }]. | |
| consentConfirmed | No | Assert you have consent to mail this audience. Defaults to true. Recipients can always opt out (see `optOut` in the response). | |
| recipientPhoneNumbers | No | Explicit phone list. |