Skip to main content
POST
Update a broadcast

Authorizations

Authorization
string
header
required

API token for authentication

Body

application/json
workspace_id
string
required

The ID of the workspace

Example:

"ws_1234567890"

id
string
required

ID of the broadcast to update

Example:

"broadcast_12345"

name
string
required

Name of the broadcast

Maximum string length: 255
Example:

"Spring Newsletter 2024"

audience
object
required
schedule
object

Schedule settings for a broadcast. Note: When a broadcast is first created, these fields are empty/false. Use the /api/broadcasts.schedule endpoint to configure scheduling.

test_settings
object
tracking_enabled
boolean

Enable click and open tracking

Example:

true

utm_parameters
object
data_feed
object

Configuration for external data feeds

metadata
object

Custom metadata for the broadcast

Response

Broadcast updated successfully

broadcast
object