Create SMS Campaign
neuron_create_sms_campaignCreate a draft SMS campaign. Choose the audience via sourceType: 'all_contacts' or 'contact_list' (your own contacts), 'phones' (bring your own list — raw numbers you pass in), 'platform' (the wider Neuron audience — budget required, sent over the bulk campaign route), or 'curated' (SMS-opted-in marketplace lists via poolEntryIds; the list owner earns ₦2/contact). After creating, call neuron_estimate_sms_campaign to price it, then neuron_send_sms_campaign. Requires SMS to be enabled by an admin and a configured provider.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | 'blast' sends to everyone at once (default); 'drip' sends in scheduled batches | |
| title | Yes | Internal campaign title | |
| budget | No | Budget in kobo (required for sourceType 'platform'; caps how many messages send) | |
| phones | No | Raw phone numbers to text (required when sourceType is 'phones'); normalized + de-duplicated server-side, invalid ones dropped | |
| message | Yes | The SMS text to send. Include an opt-out (e.g. 'Reply STOP'). | |
| sourceType | Yes | Audience source | |
| countryCodes | No | Restrict to these country calling codes (e.g. ['234']). Omit for all. | |
| poolEntryIds | No | SMS-enabled list-pool entry UUIDs (required when sourceType is 'curated'; find them with neuron_browse_list_pool { smsEnabled: true }) | |
| smsChannelId | No | BYOK SMS channel UUID to send through instead of the platform provider | |
| sourceListIds | No | Contact list UUIDs (required when sourceType is 'contact_list') |