Skip to main content
Module

x/gesso/types/params.ts>UpdateGlobalNotificationParams

A TypeScript API client for Canvas LMS
Latest
interface UpdateGlobalNotificationParams
import { type UpdateGlobalNotificationParams } from "https://deno.land/x/gesso@v0.1.2/types/params.ts";

Properties

optional
accountnotificationsubject: string

The subject of the notification.

optional
accountnotificationmessage: string

The message body of the notification.

optional
accountnotificationstartat: Date

The start date and time of the notification in ISO8601 format. e.g. 2014-01-01T01:00Z

optional
accountnotificationendat: Date

The end date and time of the notification in ISO8601 format. e.g. 2014-01-01T01:00Z

optional
accountnotificationicon: string

Allowed values: warning, information, question, error, calendar

optional
account_notification_roles: string[]

The role(s) to send global notification to. Note: ommitting this field will send to everyone Example: account_notification_roles: ["StudentEnrollment", "TeacherEnrollment"]