Method: locations.placeActionLinks.patch

  • Updates a specified place action link with provided details and returns the updated link.

  • Uses the PATCH HTTP request method and requires a placeActionLink.name path parameter.

  • Requires an updateMask query parameter indicating the fields to be updated.

  • The request body must contain a PlaceActionLink object and a successful response will return the updated PlaceActionLink object.

  • Requires https://www.googleapis.com/auth/business.manage authorization scope for access.

Updates the specified place action link and returns it.

HTTP request

PATCH https://mybusinessplaceactions.googleapis.com/v1/{placeActionLink.name=locations/*/placeActionLinks/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
placeActionLink.name

string

Optional. The resource name, in the format locations/{locationId}/placeActionLinks/{place_action_link_id}.

The name field will only be considered in placeActionLinks.patch and placeActionLinks.delete requests for updating and deleting links respectively. However, it will be ignored in placeActionLinks.create request, where place_action_link_id will be assigned by the server on successful creation of a new link and returned as part of the response.

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. The specific fields to update. The only editable fields are uri, placeActionType and isPreferred. If the updated link already exists at the same location with the same placeActionType and uri, fails with an ALREADY_EXISTS error.

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

Response body

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

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/business.manage

For more information, see the OAuth 2.0 Overview.