updateGroup: Update Group Details

View source: R/GroupFunctions.R

updateGroupR Documentation

Update Group Details

Description

This function modifies one or more attributes of a group.

Usage

updateGroup(
  groupId,
  building_id = NULL,
  school_id = NULL,
  title = NULL,
  picture_url = NULL,
  description = NULL,
  website = NULL,
  access_code = NULL,
  privacy_level = NULL,
  category = NULL,
  options_invite_type = NULL,
  options_member_post = NULL,
  options_member_post_comment = NULL,
  options_create_discussion = NULL,
  options_create_files = NULL
)

Arguments

groupId

Can be found by navigating to the Schoology group information page.

building_id

The internal Schoology ID of the school building to which the group belongs.

school_id

The internal Schoology ID of the school to which the group belongs.

title

The title of the group.

picture_url

The URL of the group's profile picture.

description

The group description.

website

The group website.

access_code

The access code that users can use to join the group (only admins can see this value).

privacy_level

The privacy of the group. One of 'everyone', 'school', 'building', or 'group'.

category

The category of the group.

options_invite_type

How members can join the group. 0: Invite only, 1: Request to join, 2: Anyone can join. Default 0.

options_member_post

Whether or not a group member can post a group update. Default 1.

options_member_post_comment

Whether or not a group member can post comments to group udpates. Default 1.

options_create_discussion

Whether or not a group member can create a discussion thread. Default 0.

options_create_files

Whether or not members can create resources for the group. Default 0.

Value

A dataframe of updated group details.

References

API Documentation


sterfa02/SchoologyAPI documentation built on Jan. 10, 2023, 11:27 p.m.