Skip to main content
Hooks for fetching and managing email broadcasts.

useGetBroadcasts

The useGetBroadcasts hook fetches email broadcasts, allowing you to retrieve a list of broadcasts and their details. API Reference

Usage

Parameters

useSearchBroadcasts

The useSearchBroadcasts hook allows you to search for email broadcasts based on specific criteria. API Reference

Usage

Parameters

useGetBroadcast

The useGetBroadcast hook fetches a specific email broadcast by its ID, allowing you to retrieve its details. API Reference

Usage

Parameters

useBroadcast

The useBroadcast hook provides comprehensive functionality for managing email campaigns (broadcasts) including creation, updates, deletion, duplication, and state management.

Usage

Return Values

  • onCreateBroadcast(payload: Partial<CampaignData>) - Creates a new broadcast
  • onUpdateBroadcast(payload: Partial<CampaignData>) - Updates an existing broadcast
  • onDeleteBroadcast(broadcastId: string) - Deletes a broadcast
  • onDuplicateBroadcast(broadcastId: string) - Duplicates a broadcast
  • onChangeBroadcastState(broadcastId: string, state: CampaignData["state"]) - Changes broadcast state
  • onBulkDeleteBroadcasts(broadcastIds: string[]) - Deletes multiple broadcasts
  • onCreateAndSendBroadcast(payload) - Creates and sends a broadcast with recipients
  • onSendTestEmail(recipients, broadcast) - Sends a test email