Update Group

Update an Office 365 group.

Unless otherwise indicated, field types are text.

Input

  • Group

    • Id: The unique identifier for the group.

  • Properties

    • Allow External Senders (true/false): Indicates if people external to the organization can send messages to the group. Default value is false. Note: This field must be updated individually - cannot update other fields in conjunction with Allow External Senders. The error message: The request is currently not supported on the targeted entity set is indicative of this behavior.

    • Auto Subscribe New Members (true/false): Indicates if new members added to the group will be auto-subscribed to receive email notifications. You can set this property in a PATCH request for the group; do not set it in the initial POST request that creates the group. Default value is false. Note: This field must be updated individually - cannot update other fields in conjunction with Auto Subscribe New Members. The error message: The request is currently not supported on the targeted entity set is indicative of this behavior.

    • Description: An optional description for the group.

    • Display Name: The display name for the group. This property is required when a group is created and cannot be cleared during updates.

    • Mail Enabled (true/false): true: the group is mail-enabled. false: the group is not mail-enabled.

    • Mail Nickname: The mail alias for the group, unique in the organization. This property must be specified when a group is created. Note: This field must not contain a space.

    • Security Enabled (true/false): Specifies whether the group has security enabled. Only Office 365 groups can create/update this property.

    • Visibility (dropdown): Specifies the visibility of an Office 365 group. See group visibility options to learn more.

      • Public: Anyone can join the group without needing owner permission. Anyone can view the contents of the group.

      • Private: Owner permission is needed to join the group. Non-members cannot view the contents of the group.

      • Hiddenmembership: Owner permission is needed to join the group. Non-members cannot view the contents of the group. Non-members cannot see the members of the group. Administrators (global, company, user, and helpdesk) can view the membership of the group. The group appears in the global address book (GAL).

Output

  • Output
    • Status Code (number): The status code returned by the API. A value of 204 indicates the user was updated successfully.

See also