Skip to main content
Module

x/gesso/types/params.ts>EditGroupParams

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

Properties

optional
name: string

The name of the group

optional
description: string

A description of the group

optional
ispublic: boolean

Whether the group is public (applies only to community groups). Currently you cannot set a group back to private once it has been made public.

optional
joinlevel: string

Allowed values: parent_context_auto_join, parent_context_request, invitation_only

optional
avatarid: number

The id of the attachment previously uploaded to the group that you would like to use as the avatar image for this group.

optional
storagequotamb: number

The allowed file storage for the group, in megabytes. This parameter is ignored if the caller does not have the manage_storage_quotas permission.

optional
members: string[]

An array of user ids for users you would like in the group. Users not in the group will be sent invitations. Existing group members who aren't in the list will be removed from the group.

optional
sisgroupid: string

The sis ID of the group. Must have manage_sis permission to set.

optional
overridesisstickiness: boolean

Default is true. If false, any fields containing “sticky” changes will not be updated. See SIS CSV Format documentation for information on which fields can have SIS stickiness