Skip to content

Update Group

workmail_update_group R Documentation

Updates attributes in a group

Description

Updates attributes in a group.

Usage

workmail_update_group(OrganizationId, GroupId,
  HiddenFromGlobalAddressList)

Arguments

OrganizationId

[required] The identifier for the organization under which the group exists.
GroupId

[required] The identifier for the group to be updated.

The identifier can accept GroupId, Groupname, or email. The following identity formats are available:

  • Group ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234

  • Email address: group@domain.tld

  • Group name: group
HiddenFromGlobalAddressList

If enabled, the group is hidden from the global address list.

Value

An empty list.

Request syntax

svc$update_group(
  OrganizationId = "string",
  GroupId = "string",
  HiddenFromGlobalAddressList = TRUE|FALSE
)