Skip to main content
inputCreateAnnouncementInput

Fields

body
String!
required

The announcement message. Simple HTML is sanitized server-side.

clientMutationId
String

A unique identifier for the client performing the mutation.

externalLink
String

Optional URL to attach to the announcement. Only available on Networks with external announcement links enabled; supplying one otherwise is rejected.

filter
MemberFilter

Notify every member the filter matches. Cannot be combined with recipientIds. An empty filter notifies everyone.

pmeClusterId
String

People Magic cluster ID ("clu_") whose live roster receives the announcement. Cannot be combined with recipientIds or filter, and requires People Magic to be enabled for the Network.

recipientIds
[ID!]

Resource IDs or GlobalIDs of the members to notify. Cannot be combined with filter. Omit both to notify everyone; an empty list is rejected.

spaceId
ID!
required

Resource ID or GlobalID of the space or Network to broadcast to.

subject
String

Short notification text shown to recipients, truncated to 150 characters. Defaults to a greeting attributed to the sender's role when omitted.