Method: contactGroups.update

Update the name of an existing contact group owned by the authenticated user.

HTTP request

PUT https://people.googleapis.com/v1/{contactGroup.resourceName=contactGroups/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
contactGroup.resourceName

string

The resource name for the contact group, assigned by the server. An ASCII string, in the form of contactGroups/contactGroupId.

Request body

The request body contains data with the following structure:

JSON representation
{
  "contactGroup": {
    "resourceName": string,
    "etag": string,
    "metadata": {
      object (ContactGroupMetadata)
    },
    "groupType": enum (GroupType),
    "name": string,
    "formattedName": string,
    "memberResourceNames": [
      string
    ],
    "memberCount": number,
    "clientData": [
      {
        object (GroupClientData)
      }
    ]
  }
}
Fields
contactGroup.etag

string

The HTTP entity tag of the resource. Used for web cache validation.

contactGroup.metadata

object (ContactGroupMetadata)

Metadata about the contact group.

contactGroup.groupType

enum (GroupType)

The read-only contact group type.

contactGroup.name

string

The contact group name set by the group owner or a system provided name for system groups.

contactGroup.formattedName

string

The read-only name translated and formatted in the viewer's account locale or the Accept-Language HTTP header locale for system groups names. Group names set by the owner are the same as name.

contactGroup.memberResourceNames[]

string

The list of contact person resource names that are members of the contact group. The field is not populated for LIST requests and can only be updated through the members.modify.

contactGroup.memberCount

number

The total number of contacts in the group irrespective of max members in specified in the request.

Response body

If successful, the response body contains an instance of ContactGroup.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/contacts

For more information, see the Authorization guide.

Try it!