Groups: update

Updates a group's properties. Try it now.


HTTP request



Parameter name Value Description
Path parameters
groupKey string Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.


This request requires authorization with the following scope:


For more information, see the authentication and authorization page.

Request body

In the request body, supply a Groups resource with the following properties:

Property name Value Description Notes
Optional Properties
description string An extended description to help users determine the purpose of a group. For example, you can include information about who should join the group, the types of messages to send to the group, links to FAQs about the group, or related groups. Maximum length is 4,096 characters. writable
email string The group's email address. If your account has multiple domains, select the appropriate domain for the email address. The email must be unique. This property is required when creating a group. Group email addresses are subject to the same character usage rules as usernames, see the administration help center for the details. writable
name string The group's display name. writable


If successful, this method returns a Groups resource in the response body.

Try it!

Use the APIs Explorer below to call this method on live data and see the response.