Method: contactGroups.delete

  • Delete a contact group owned by the authenticated user, optionally including its contacts.

  • The request must specify the contact group's resource name and can include a query parameter to also delete contacts within the group.

  • This operation requires authorization with the https://www.googleapis.com/auth/contacts scope.

  • Requests for the same user should be sent sequentially to optimize performance and avoid failures.

Delete an existing contact group owned by the authenticated user by specifying a contact group resource name.

Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.

HTTP request

DELETE https://people.googleapis.com/v1/{resourceName=contactGroups/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
resourceName

string

Required. The resource name of the contact group to delete.

Query parameters

Parameters
deleteContacts

boolean

Optional. Set to true to also delete the contacts in the specified group.

Request body

The request body must be empty.

Response body

If successful, the response body is empty.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authorization guide.