mutation CreateAnnouncement($input: CreateAnnouncementInput!) {
createAnnouncement(input: $input) {
announcement {
bodyHtml
bodyText
createdAt
externalLink
id
post {
__typename
... on Event {
__typename
}
}
}
clientMutationId
errors
queued
}
}{
"input": {
"body": "string",
"spaceId": "id"
}
}{
"data": {
"createAnnouncement": {
"announcement": {
"bodyHtml": "string",
"bodyText": "string",
"createdAt": "value",
"externalLink": "string",
"id": "id",
"post": {
"__typename": "Event"
}
},
"clientMutationId": "string",
"errors": [
"string"
],
"queued": true
}
}
}createAnnouncement
Send an announcement — a broadcast notification — to the members of a space or Network. This mutation’s cost scales with the audience it reaches: the base mutation cost plus one unit per recipient, up to a per-request ceiling. Naming recipients with recipientIds is charged for exactly those members; every other shape is charged for the target space’s whole membership, because the recipient set is not known until the send runs.
Required scope: host:write:network_announcements
createAnnouncement(input: CreateAnnouncementInput!): CreateAnnouncementPayloadArguments
Parameters for CreateAnnouncement
Returns
A unique identifier for the client performing the mutation.
True when recipient resolution was deferred to a background job, in which case the returned announcement is created but sent shortly. False when the announcement was created and sent synchronously.
mutation CreateAnnouncement($input: CreateAnnouncementInput!) {
createAnnouncement(input: $input) {
announcement {
bodyHtml
bodyText
createdAt
externalLink
id
post {
__typename
... on Event {
__typename
}
}
}
clientMutationId
errors
queued
}
}{
"input": {
"body": "string",
"spaceId": "id"
}
}{
"data": {
"createAnnouncement": {
"announcement": {
"bodyHtml": "string",
"bodyText": "string",
"createdAt": "value",
"externalLink": "string",
"id": "id",
"post": {
"__typename": "Event"
}
},
"clientMutationId": "string",
"errors": [
"string"
],
"queued": true
}
}
}