Skip to main content
inputUpdateBroadcastInput

Fields

broadcastId
ID!
required
name
StringInput
notificationTitle
OptionalStringInput

The title recipients see in the notification. Pass null to clear it; a broadcast with none cannot be sent.

content
StringInput

Set alongside contentFormat whenever the encoding of the new body differs from the stored one.

contentFormat
BroadcastContentFormatInput

How content is encoded. Changing this on its own re-checks the stored body against the new encoding, so switching format without also sending matching content is rejected rather than left to fail at send time.

isLinkUnfurlingEnabled
BooleanInput

Whether Slack expands the links and media in this broadcast. Omit to leave it unchanged.

senderType
BroadcastSenderTypeInput

Which kind of sender senderUserId describes. Validated against the state the broadcast will hold, so either half can be set on its own as long as the result is coherent: PLAIN_USER needs a senderUserId, PLAIN must not have one.

senderUserId
OptionalStringInput
senderEmailAddress
OptionalStringInput
sendTarget
BroadcastSendTargetInput

Pass a target to replace the current one, or null — equivalently a target with no scope and no recipients — to clear it. Omit to leave it unchanged. Clearing the target — or the sender — of a broadcast that is already scheduled is rejected, because a scheduled broadcast has to stay sendable.