<< Back to GForge REST API

Entity: Sitenotification

GET

POST

postSiteNotification

Sends a site or project notification email to the selected audience.

Parameters (8)

Name Type Description
subject string Email subject. Required.
body string Email body. Required.
section string Section scope. Default site.
projectAdmins bool When true, sends to project admins.
siteAdmins bool When true, sends to site admins. Requires site admin access.
projectMembers bool When true, sends to all project members (requires projectId).
projectId int Project id to scope the notification. Use 0 for site-wide.
dryRun string When Y, returns the target audience without sending the email.

Return: object

Response with succeeded, type, dryRun, and users fields.

PUT

DELETE