Method: networks.contacts.batchUpdate

  • The contacts.batchUpdate method allows for batch updating of Contact objects using a POST request to https://admanager.googleapis.com/v1/{parent}/contacts:batchUpdate .

  • The request requires a parent path parameter specifying the network code and a request body containing a list of UpdateContactRequest objects, with a maximum of 100 objects allowed per batch.

  • Each UpdateContactRequest must include the Contact object to update and an updateMask specifying the fields to be modified.

  • The response body returns a list of the updated Contact objects.

  • This method requires the https://www.googleapis.com/auth/admanager OAuth scope for authorization.

API to batch update Contact objects.

HTTP request

POST https://admanager.googleapis.com/v1/{parent}/contacts:batchUpdate

Path parameters

Parameters
parent

string

Required. The parent resource where Contacts will be updated. Format: networks/{networkCode} The parent field in the UpdateContactRequest must match this field.

Request body

The request body contains data with the following structure:

JSON representation
 { 
 "requests" 
 : 
 [ 
 { 
 object (  UpdateContactRequest 
 
) 
 } 
 ] 
 } 
Fields
requests[]

object ( UpdateContactRequest )

Required. The Contact objects to update. A maximum of 100 objects can be updated in a batch.

Response body

Response object for contacts.batchUpdate method.

If successful, the response body contains data with the following structure:

JSON representation
 { 
 "contacts" 
 : 
 [ 
 { 
 object (  Contact 
 
) 
 } 
 ] 
 } 
Fields
contacts[]

object ( Contact )

The Contact objects updated.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview .

UpdateContactRequest

Request object for contacts.patch method.

JSON representation
 { 
 "contact" 
 : 
 { 
 object (  Contact 
 
) 
 } 
 , 
 "updateMask" 
 : 
 string 
 } 
Fields
contact

object ( Contact )

Required. The Contact to update.

The Contact 's name is used to identify the Contact to update.

updateMask

string ( FieldMask format)

Required. The list of fields to update.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo" .

Create a Mobile Website
View Site in Mobile | Classic
Share by: