Method: people.batchDeleteContacts

  • Delete a batch of contacts, limited to 500 resource names per request, while preserving non-contact data.

  • Send mutation requests for the same user sequentially to avoid latency issues and failures.

  • This operation utilizes a POST request to https://people.googleapis.com/v1/people:batchDeleteContacts and requires the https://www.googleapis.com/auth/contacts OAuth scope.

  • The request body should contain a JSON object with a resourceNames array listing the contact resource names to delete.

  • A successful deletion results in an empty response body.

Delete a batch of contacts. Any non-contact data will not be deleted.

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

HTTP request

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

The URL uses gRPC Transcoding syntax.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "resourceNames": [
    string
  ]
}
Fields
resourceNames[]

string

Required. The resource names of the contact to delete. It's repeatable. Allows up to 500 resource names in a single request.

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.