HomeKnowledge BaseAPI Reference
API ReferenceSubmit a Ticket
API Reference
API ReferenceSubmit a Ticket

Update a broadcast

post
https://api.campaignrefinery.com/rest/broadcasts/update_broadcast

Renames an existing broadcast and optionally replaces its suppression lists and tag actions. The authenticated API key selects the account. suppression_uuids and actions are full replacements: if you send a list, that IS the list -- the broadcast ends up with exactly what the array contains, and anything previously attached but not re-sent is removed. Send [] to clear the set. Omit the field entirely to leave the current set untouched.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
uuid
required

The broadcast UUID.

string
required
length between 2 and 255

New display name for the broadcast.

suppression_uuids
array of uuids

Full replacement: the array you send becomes the broadcast's complete suppression set -- exactly these lists, nothing else; any previously attached list not in the array is detached. Send [] to detach all suppression lists. Omit the field to leave the current set untouched. Unknown UUIDs are ignored.

suppression_uuids
actions
array of objects

Tag-action rules. Each entry applies or removes tags when a contact opens the email, clicks any link, or clicks a specific link. Full replacement: the array you send becomes the broadcast's complete tag-action set -- any existing rule not re-sent is removed. Send [] to remove all rules. Omit the field to leave the current set untouched. Unknown tag UUIDs are ignored.

actions
Responses

401

Missing or invalid bearer token.

422

Validation error (e.g. missing or invalid broadcast_uuid, broadcast_name too short).

Updated about 1 month ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago