Method: accounts.brands.patch

  • Updates to a brand are made using a PATCH request to the specified URL containing the brand name.

  • The brand name is a required path parameter in the format accounts/{account_id}/brands/{brandId}.

  • The updateMask query parameter is required to specify which fields to update, limited to displayNames and icon.

  • The request body should contain an instance of Brand with the updated information.

  • A successful update returns an instance of Brand in the response body.

  • The request requires the https://www.googleapis.com/auth/travelpartner OAuth scope for authorization.

Updates a brand.

HTTP request

PATCH https://travelpartner.googleapis.com/v3/{brand.name=accounts/*/brands/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
brand.name

string

Output only. The resource name for the brand in the format accounts/{account_id}/brands/{brandId}. The brandId corresponds to the partner's brand identifier used for landing page matching and the property-level brand identifier.

A default brand is applied to properties that do not have a brand. The brandId of the default brand is NO_BRAND_ID. It can be fetched and updated like any configured brand.

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. The field to update. Only the displayNames and icon fields can be updated. Use the syntax shown in the example URI below and provide the new value in the request body.

Example request URI and request body:

PATCH https://travelpartner.googleapis.com/v3/accounts/123456789/
brands/my-brand?updateMask=brand.display_names

 {
   "displayNames": [{
     "language": "en"
     "text": "Gilles' Gites"
   }]
 }

The information above is sufficient for forming the URI and request body. The sentence below is auto-generated, supplemental information about the FieldMask format in general.

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

boolean

When true, and the Brand is not found, a new Brand will be created. In this situation, updateMask is ignored.

Request body

The request body contains an instance of Brand.

Response body

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

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/travelpartner

For more information, see the OAuth 2.0 Overview.