Begins executing a batch update jobs operation.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Required. The resource name of the tenant under which the job is created.

The format is "projects/{projectId}/tenants/{tenantId}". For example, "projects/foo/tenants/bar".

Request body

The request body contains data with the following structure:

JSON representation
  "jobs": [
      object (Job)
  "updateMask": string

object (Job)

Required. The jobs to be updated. A maximum of 200 jobs can be updated in a batch.


string (FieldMask format)

Strongly recommended for the best service experience. Be aware that it will also increase latency when checking the status of a batch operation.

If updateMask is provided, only the specified fields in Job are updated. Otherwise all the fields are updated.

A field mask to restrict the fields that are updated. Only top level fields of Job are supported.

If updateMask is provided, The Job inside [JobResult][JobOperationResult.JobResult] will only contains fields that is updated, plus the Id of the Job. Otherwise, Job will include all fields, which can yield a very large response.

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

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires one of the following OAuth scopes:


For more information, see the Authentication Overview.