Skip to main content
POST
Update a broadcast

Authorizations

Authorization
string
header
required

API token for authentication

Body

application/json

Partial update of a broadcast. workspace_id, id and name are always applied; audience is merged one key at a time, and schedule, test_settings, utm_parameters, metadata and data_feed keep their stored value when the key is left out of the body. Send the key to change it — including an explicitly empty object to clear it.

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

Merged into the stored audience one key at a time, so a body naming only list retargets the broadcast without dropping its segments or its exclusion of unsubscribed contacts. Omit the whole object to leave the audience untouched.

schedule
object

Omit to keep the stored schedule. Sending it replaces the schedule wholesale, so a body carrying an empty or partial object clears is_scheduled — which a later resume reads to decide between restoring the schedule and sending now.

test_settings
object

Omit to keep the stored test settings. These hold the broadcast's template variations, so sending a partial object detaches its templates.

utm_parameters
object

Omit to keep the stored UTM parameters; send an empty object to clear them.

data_feed
object

Omit to keep the stored data feed settings and their last fetched data.

metadata
object

Custom metadata for the broadcast. Omit to keep the stored metadata; send an empty object to clear it.

Response

Broadcast updated successfully

broadcast
object