broadcast_idstring required
broadcast_namestring required
template_idstring nullable required
channel_type'internal' | 'org' | 'agent' | 'custom' | 'whatsapp_bot' | 'messenger_bot' | 'instagram_dm' | 'tiktok_dm' | 'telegram_bot' | 'slack_bot' | 'teams_bot' | 'gmail' | 'outlook' | 'twilio' | 'telnyx' | 'email' | 'smpp' required
user_idstring nullable required
namestring nullable required
usernamestring nullable required
phonestring nullable required
emailstring nullable required
status'QUEUED' | 'SENDING' | 'PROCESSED' | 'SENT' | 'FAILED' | 'SKIPPED' required
The status of the broadcast recipient
source'API' | 'MANUAL' | 'INBOX' | 'IMPORT' | 'null' nullable required
How the recipient was triggered (transactional only)
payloadobject nullable required
is_skippedboolean nullable required
is_skipped_atstring date-time nullable required
is_failedboolean nullable required
is_failed_atstring date-time nullable required
is_bouncedboolean nullable required
is_bounced_atstring date-time nullable required
is_sentboolean nullable required
is_sent_atstring date-time nullable required
is_deliveredboolean nullable required
is_delivered_atstring date-time nullable required
is_complainedboolean nullable required
is_complained_atstring date-time nullable required
is_unsubscribedboolean nullable required
is_unsubscribed_atstring date-time nullable required
is_openedboolean nullable required
is_opened_atstring date-time nullable required
is_playedboolean nullable required
is_played_atstring date-time nullable required
error_messagestring nullable required
external_message_idstring nullable required
created_atstring date-time required
updated_atstring date-time required