broadcastUpdate Mutation

Updates an existing broadcast.

Input argument

broadcastUpdate accepts a single input argument, an input type, which contains the values it uses.

The fields inside input are:

clientMutationId (String)

A unique identifier for the client performing the mutation.

customerIds ([ID!])

The customer organizations when the broadcast is to be displayed for the specialists of the account in requests that were received from the selected organizations. This is available only when the "Specialists in requests from the following customers" visibility option is selected.

disabled (Boolean)

Whether the message should not be broadcasted.

endAt (ISO8601Timestamp)

The end date and time of the broadcast. This field is left empty when the message is to be broadcasted until the Disabled box is checked. (If the broadcast should end at midnight at the end of a day, specify 12:00am or 24:00.)

id (ID!)

The node ID of the record to update.

message (String)

Message that is to be broadcasted in the language of the account.

messageType (BroadcastMessageType)

The appropriate icon for the message. The selected icon is displayed alongside the message when the broadcast is presented.

serviceInstanceIds ([ID!])

The service instances for which the people, who are covered for them by an active SLA, need to see the broadcast. This is available only when the "People covered for the following service instance(s)" visibility option is selected.

source (String)

An identifier for the client application submitting the resource or the name of an external system

sourceID (String)

The unique identifier of the resource in an external system

startAt (ISO8601Timestamp)

The start date and time of the broadcast. (If the broadcast should start at midnight at the start of a day, specify 00:00.)

teamIds ([ID!])

The teams which members need to see the broadcast. This is available only when the "Members of the following team(s)" visibility option is selected.

timeZone (TimeZone)

The time zone that applies to the dates and times specified in the Start and End fields.

translationsToDelete ([ID!])

Identifiers of translations to remove from this broadcast.

visibility (BroadcastVisibility)

Defines the target audience of the broadcast.

Return fields

broadcast (Broadcast)

Record after mutation.

clientMutationId (String)

A unique identifier for the client performing the mutation.

errors ([ValidationError!])

Errors encountered during the mutation.