Method: buyers.clients.patch

  • This document details how to update an existing client using an HTTP PATCH request.

  • The request uses path parameters, specifically client.name, to identify the client to be updated.

  • Query parameters, such as updateMask, can be used to specify which fields of the client should be updated.

  • Both the request and response bodies contain an instance of the Client resource.

  • The action requires authorization with the https://www.googleapis.com/auth/authorized-buyers-marketplace OAuth scope.

Updates an existing client.

HTTP request

PATCH https://authorizedbuyersmarketplace.googleapis.com/v1/{client.name=buyers/*/clients/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
client.name

string

Output only. The resource name of the client. Format: buyers/{accountId}/clients/{clientAccountId}

Query parameters

Parameters
updateMask

string (FieldMask format)

List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path "*" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.

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

Response body

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

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/authorized-buyers-marketplace