people.contactGroups.update
Renames an existing contact group owned by the authenticated user, requiring the new name to be unique. Returns HTTP 409 if the name duplicates another group.
Instructions
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 PUT] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON UpdateContactGroupRequest object accepting contactGroup, readGroupFields, updateGroupFields; pass it via params or whole via body_file Siblings over the same resource: batchGet, create, delete, get, list.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | No | Extra KEY=VALUE query pairs for endpoints whose parameters Discovery does not describe. | |
| params | No | Parameter map merged into the request; typed parameters win. | |
| dry_run | No | Return the request that would be sent, without sending it. | |
| body_file | No | Read the request body from this file ('-' for stdin) instead of building one from the parameters. The body is a JSON UpdateContactGroupRequest object. | |
| request_body | No | Request body of type UpdateContactGroupRequest: pass it via `params` (merged into the built body) or whole via `body_file`. | |
| resourceName | Yes | [URL path segment] The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| etag | No | ||
| name | No | ||
| metadata | No | ||
| groupType | No | ||
| clientData | No | ||
| memberCount | No | ||
| resourceName | No | ||
| formattedName | No | ||
| memberResourceNames | No |