Update the name of an existing contact group owned by the authenticated user.
Updated contact group names must be unique to the users contact groups. Attempting to create a group with a duplicate name will return a HTTP 409 error.
Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.
HTTP request
PUT https://people.googleapis.com/v1/{contactGroup.resourceName=contactGroups/*}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
contactGroup.resourceName |
The resource name for the contact group, assigned by the server. An ASCII string, in the form of |
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 ( |
Fields | |
---|---|
contactGroup.etag |
The HTTP entity tag of the resource. Used for web cache validation. |
contactGroup.metadata |
Output only. Metadata about the contact group. |
contactGroup.groupType |
Output only. The contact group type. |
contactGroup.name |
The contact group name set by the group owner or a system provided name for system groups. For |
contactGroup.formattedName |
Output only. The name translated and formatted in the viewer's account locale or the |
contactGroup.memberResourceNames[] |
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 |
contactGroup.memberCount |
Output only. The total number of contacts in the group irrespective of max members in specified in the request. |
contactGroup.clientData[] |
The group's client data. |
updateGroupFields |
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
|
readGroupFields |
Optional. A field mask to restrict which fields on the group are returned. Defaults to
|
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.