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.

Scopes

You will need authorization for the https://www.googleapis.com/auth/contacts scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/contacts. You can set the scope for this method like this: people1 --scope <scope> contact-groups update ...

Required Scalar Argument

  • <resource-name> (string)
    • The resource name for the contact group, assigned by the server. An ASCII string, in the form of contactGroups/{contact_group_id}.

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

UpdateContactGroupRequest:
  contact-group:
    etag: string
    formatted-name: string
    group-type: string
    member-count: integer
    member-resource-names: [string]
    metadata:
      deleted: boolean
      update-time: string
    name: string
    resource-name: string
  read-group-fields: string
  update-group-fields: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

  • -r .contact-group etag=lorem
  • formatted-name=gubergren
    • 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.
  • group-type=eos
    • Output only. The contact group type.
  • member-count=97
    • Output only. The total number of contacts in the group irrespective of max members in specified in the request.
  • member-resource-names=ea
    • 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.
    • Each invocation of this argument appends the given value to the array.
  • metadata deleted=true
    • Output only. True if the contact group resource has been deleted. Populated only for ListContactGroups requests that include a sync token.

  • update-time=invidunt

    • Output only. The time the group was last updated.

  • .. name=amet

    • The contact group name set by the group owner or a system provided name for system groups. For contactGroups.create or contactGroups.update the name must be unique to the users contact groups. Attempting to create a group with a duplicate name will return a HTTP 409 error.

  • resource-name=duo

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

  • .. read-group-fields=ipsum

    • 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
  • update-group-fields=sed
    • 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

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.

  • -p access-token=string

    • OAuth access token.

  • -p alt=string

    • Data format for response.

  • -p callback=string

    • JSONP

  • -p fields=string

    • Selector specifying which fields to include in a partial response.

  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

  • -p oauth-token=string

    • OAuth 2.0 token for the current user.

  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.

  • -p quota-user=string

    • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").

  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").