Method: admin.projects.locations.subscriptions.patch

Updates properties of the specified subscription.

HTTP request

PATCH https://{endpoint}/v1/admin/{subscription.name=projects/*/locations/*/subscriptions/*}

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

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
subscription.name

string

The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscriptionId}

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. A mask specifying the subscription fields to change.

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 Subscription.

Response body

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

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.