Send a broadcast
create_broadcastMUTATES Text-Em-All data AND SENDS MESSAGES (spends account credits): creates + sends a broadcast to the given contacts. Text-Em-All API: POST /v1/broadcasts. Set broadcastType to 'SMS' (a text broadcast — provide textMessage) or 'Announcement' (a voice broadcast — provide voiceText for text-to-speech, or a pre-recorded AudioID via fields.Audio). Contacts is a list of { primaryPhone, firstName?, lastName?, notes? }. Extra documented fields (CallerID, TextNumberID, Lists, RetryTimes, CallThrottle, MaxMessageLength, StartDate, CheckCallingWindow) go through fields (PascalCase). Returns the created broadcast.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Additional documented Text-Em-All fields to send verbatim in the JSON write body, using the API's PascalCase names (e.g. CallerID, TextNumberID, Lists, RetryTimes). Merged OVER the typed fields above. | |
| contacts | Yes | Recipients (each needs primaryPhone). Required. | |
| voiceText | No | Text-to-speech message for an Announcement broadcast (mapped to Audio.TextToSpeech=true + Audio.Text). | |
| textMessage | No | The text body for an SMS broadcast (TextMessage). Required when broadcastType='SMS'. | |
| broadcastName | Yes | A name/label for this broadcast (BroadcastName). Required. | |
| broadcastType | Yes | 'SMS' for a text broadcast, 'Announcement' for a voice broadcast. Required. | |
| primaryPhoneNumbersOnly | No | Only send to each contact's primary phone number (PrimaryPhoneNumbersOnly, default true). |