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": {
      "updateTime": string,
      "deleted": boolean
    },
    "groupType": enum (GroupType),
    "name": string,
    "formattedName": string,
    "memberResourceNames": [
      string
    ],
    "memberCount": integer,
    "clientData": [
      {
        "key": string,
        "value": string
      }
    ]
  },
  "updateGroupFields": string,
  "readGroupFields": string
}
Fields
contactGroup.etag

string

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

contactGroup.metadata

object (ContactGroupMetadata)

Output only. Metadata about the contact group.

contactGroup.groupType

enum (GroupType)

Output only. The 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

Output only. The 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

Output only. The list of contact person resource names that are members of the contact group. The field is only populated for GET requests and will only return as many members as maxMembers in the get request.

contactGroup.memberCount

integer

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

contactGroup.clientData[]

object (GroupClientData)

The group's client data.

updateGroupFields

string (FieldMask format)

Optional. A field mask to restrict which fields on the group are updated. Multiple fields can be specified by separating them with commas. Defaults to name if not set or set to empty. Updated fields are replaced. Valid values are:

  • clientData
  • name
readGroupFields

string (FieldMask format)

Optional. A field mask to restrict which fields on the group are returned. Defaults to metadata, groupType, and name if not set or set to empty. Valid fields are:

  • clientData
  • groupType
  • memberCount
  • metadata
  • name

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.