Notifuse icon

Notifuse

Interact with the Notifuse API

Broadcast → Create

AI-generated

Summary

Create a new broadcast in draft status targeting a specific audience list with optional segmentation and customization.

Inputs

  • Name (required) — Name of the broadcast to identify it.
  • Audience List ID (required) — ID of the audience list to which the broadcast will be sent.
  • Audience Segments — Optional segment IDs to further filter the recipients within the audience list.
  • Exclude Unsubscribed — Boolean flag to exclude contacts who have unsubscribed from receiving messages.
  • Additional Fields — Optional settings including Data Feed (JSON) for feed configurations, Test Settings (JSON) for A/B testing options, and option to enable tracking of clicks and opens.
  • UTM Parameters — Optional UTM campaign parameters (campaign, content, medium, source, term) for tracking broadcast links.
  • Metadata — Custom key/value metadata stored with the broadcast for additional context or identification.

Output shape

single record

Returns the created broadcast object as received from the Notifuse API, including its ID and configured details.

Examples

Example 1: Create a broadcast named 'Weekly Update' targeted to audience list 'list123', excluding unsubscribed contacts, with UTM campaign tracking enabled.

Name = 'Weekly Update'; Audience List ID = 'list123'; Exclude Unsubscribed = true; UTM Parameters: campaign='weekly_update', medium='email'.

Links

Discussion