PATCH api/v1/groups/{key}

Endpoint to partially update the information for a specific group

Request Information

Name	Description	Type	Additional information
key	The unique key of the group to update the information for.	globally unique identifier	Required

The new information about the group to update.

Group

Name	Description	Type	Additional information
Name		string	Required
FunctionName		string	None.
Status		GroupStatus	None.
SchoolYear		integer	None.
Type		GroupType	Required
OrganisationKey		globally unique identifier	Required
Users		Collection of User	None.
AccountPngPicture		string	None.
AccountPngPictureUrl		string	None.
ActiveDirectoryId		string	None.
ResourceLockStatus	Indicates whether the resource is locked for editing (e.g. by Basispoort).	ResourceLockStatus	None.
ResourceLockOwnerName	Holds the name of the owner of the resource lock in case the ResourceLockStatus is Locked.	string	None.
IsLocked	This property is only added for backwards compatibility, but will be removed before release.	boolean	None.
SystemRoleType		GroupSystemRoleIdentificationMarkType	None.
InsertDate		date	None.
ModifiedDate		date	None.
AdImportSid		string	None.
GroupLoginAdImportSid		string	None.
GroupTemplateKey		globally unique identifier	None.
ActionLinks		Collection of Link	None.
Key		globally unique identifier	None.

None.