Method: projects.locations.schedules.patch

Updates an active or paused Schedule.

When the Schedule is updated, new runs will be scheduled starting from the updated next execution time after the update time based on the time_specification in the updated Schedule. All unstarted runs before the update time will be skipped while already created runs will NOT be paused or canceled.

HTTP request

PATCH https://{service-endpoint}/v1beta1/{}

Where {service-endpoint} is one of the supported service endpoints.

Path parameters



Immutable. The resource name of the Schedule.

Query parameters


string (FieldMask format)

Required. The update mask applies to the resource. See google.protobuf.FieldMask.

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

Request body

The request body contains an instance of Schedule.

Response body

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

Authorization scopes

Requires the following OAuth scope:


For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • aiplatform.schedules.update

For more information, see the IAM documentation.