broadcastFlows

Decline broadcast flow

Declines a broadcast flow and requests edits. This endpoint creates a review event and updates the broadcast flow status to needs-edit.

Requirements:

  • Only admins or managers can decline broadcast flows
  • A statusReason must be provided explaining the required changes
  • The statusReason must be between 1 and 400 characters
  • Only the root broadcast flow (not child batches) can be reviewed

Actions:

  • Creates a BroadcastEvent of type 'review' with declined status
  • Updates the broadcast flow status to needs-edit
  • Records the reviewer, review timestamp, and required changes
post/broadcastFlows/{broadcastFlowId}/review/decline

Request body

statusReasonstring required

Required explanation of what changes are needed

Example request

{
  "statusReason": "Please update the message content to be more clear and fix the typo in the subject line."
}

Response

Broadcast flow declined successfully