Notifuse icon

Notifuse

Interact with the Notifuse API

Broadcast → Update

AI-generated

Summary

Update an existing broadcast by its ID, modifying properties such as name, audience list, audience segments, exclusion of unsubscribed contacts, scheduling, A/B test settings, tracking options, UTM parameters, and custom metadata.

Inputs

  • Broadcast ID (required) — ID of the broadcast to update
  • Name (required) — Name of the broadcast
  • Audience List ID (required) — ID of the list to send the broadcast to
  • Audience Segments — Optional segment IDs to further filter recipients
  • Exclude Unsubscribed — Whether to exclude unsubscribed contacts from the audience
  • Additional Fields — Collection of optional JSON fields including Data Feed settings, Schedule settings (is_scheduled, scheduled_date, scheduled_time, timezone, use_recipient_timezone), A/B Test settings (enabled, sample_percentage, variations, etc.), and Tracking Enabled flag to enable click and open tracking
  • UTM Parameters — UTM campaign, content, medium, source, and term parameters for tracking
  • Metadata — Custom key/value metadata stored with the broadcast

Output shape

a single record

Returns the updated broadcast object from the Notifuse API after applying the changes. If update fails, an error is thrown.

Examples

Example 1: Update a broadcast's name, audience list, add segments, exclude unsubscribed contacts, schedule it, enable tracking, set UTM parameters, and add custom metadata

Provide the required Broadcast ID, new name, audience list ID, optionally specify audience segments, set exclude unsubscribed to true, define schedule JSON in Additional Fields, enable tracking, fill UTM Parameter values, and add key/value metadata.

Links

Discussion