import { createGroupNotification } from '@esri/arcgis-rest-portal';
// send an email to an entire group
  authentication: UserSession,
  subject: "hello",
  message: "world!",
  id: groupId

Create a group notification.


Parameter Type Default Notes
requestOptions Required ICreateGroupNotificationOptions

Options for the request

Available requestOptions

Property Type Notes
message string | object

Message to be sent. For builtin and email notifications this is a string. For push notifications, this will be JSON.

authentication Inherited UserSession

A session representing a logged in user.

id Inherited string

Unique identifier of the group.

clientId Optional string

ClientId of the application through which user receives messages on the mobile device. This only applies to push notifications.

notificationChannelType Optional NotificationChannelType

The channel through which the notification is to be delivered. Supported values are push, email, or builtin. If push is chosen, a message will be delivered only to those group members that have registered their devices to receive push notifications. If the user has registered more than one device for the app, then message will be sent to all the registered devices. Email will be sent when the email option is chosen. If the builtin option is chosen, a notification will be added to the notifications list that the user can see when logged into the home app.

silentNotification Optional boolean

This only applies to push notifications. When set to true, message will be delivered to the app and it will not show as an alert to the user.

subject Optional string

Subject of the notification. This only applies to email and builtin notifications. For push notifications, subject/title is provided as a part of the message payload.

users Optional string[] | string

Array of usernames of the users in the group to whom the message should be sent. If not provided, the message will be sent to all users in the group if the user is an admin. Only group admins will be able to send notifications to a list of users. Group users will be able to send notifications to only one user at a time.

credentials Optional Inherited RequestCredentials

A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.

fetch Optional Inherited function(input: RequestInfo, init: RequestInit) : Promise<Response>

The implementation of fetch to use. Defaults to a global fetch.

headers Optional Inherited [key: string]: any

Additional Headers to pass into the request.

hideToken Optional Inherited boolean

Prevents the token from being passed in a URL Query param that is saved in browser history. Instead, the token will be passed in POST request body or through X-Esri-Authorization header. NOTE: This will force POST requests in browsers since auth header is not yet supported by preflight OPTIONS check with CORS.

httpMethod Optional Inherited HTTPMethods

The HTTP method to send the request with.

maxUrlLength Optional Inherited number

If the length of a GET request's URL exceeds maxUrlLength the request will use POST instead.

params Optional Inherited IParams

Additional parameters to pass in the request.

portal Optional Inherited string

Base url for the portal you want to make the request to. Defaults to authentication.portal if authentication exists, otherwise to ''.

rawResponse Optional Inherited boolean

Return the raw response


A Promise that will resolve with the success/failure status of the request


Function defined in packages/arcgis-rest-portal/src/groups/notification.ts:55