Method: contactGroups.create

Create a new contact group owned by the authenticated user.

Created 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

POST https://people.googleapis.com/v1/contactGroups

The URL uses gRPC Transcoding syntax.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "contactGroup": {
    object (ContactGroup)
  },
  "readGroupFields": string
}
Fields
contactGroup

object (ContactGroup)

Required. The contact group to create.
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
  • metadata
  • name

Response body

If successful, the response body contains a newly created instance of ContactGroup.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authorization guide.