Method: customers.patch
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
PATCH https://sasportal.googleapis.com/v1alpha1/{customer.name=customers/*}
The URL uses gRPC Transcoding
syntax.
Path parameters
| Parameters |
customer.name
|
string
Output only. Resource name of the customer.
|
Query parameters
| Parameters |
updateMask
|
string ( FieldMask
format)
Fields to be updated.
A comma-separated list of fully qualified names of fields. Example: "user.displayName,photo"
.
|
Request body
The request body contains an instance of Customer
.
Response body
If successful, the response body contains an instance of Customer
.
Authorization Scopes
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/userinfo.email
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2023-12-05 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2023-12-05 UTC."],[[["\u003cp\u003eThis operation updates an existing customer within the Spectrum Access System.\u003c/p\u003e\n"],["\u003cp\u003eThe request must use the \u003ccode\u003ePATCH\u003c/code\u003e method and provide the customer's resource name in the URL path.\u003c/p\u003e\n"],["\u003cp\u003eAn optional \u003ccode\u003eupdateMask\u003c/code\u003e query parameter specifies the fields to be updated.\u003c/p\u003e\n"],["\u003cp\u003eThe request body should contain the updated customer data in the \u003ccode\u003eCustomer\u003c/code\u003e format.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires the \u003ccode\u003ehttps://www.googleapis.com/auth/userinfo.email\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["This document outlines the process for updating a customer resource via a `PATCH` request to a specific URL. The URL utilizes gRPC Transcoding syntax, including a path parameter `customer.name` that identifies the customer. Updates are managed through the `updateMask` query parameter, specifying fields to modify. The request body contains the updated customer details. A successful request returns the updated customer information in the response body. Finally, this operation requires the `userinfo.email` authorization scope.\n"],null,["# Method: customers.patch\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization Scopes](#body.aspect)\n\nUpdates an existing [customer](/spectrum-access-system/reference/rest/customers#Customer).\n\n### HTTP request\n\n`PATCH https://sasportal.googleapis.com/v1alpha1/{customer.name=customers/*}`\n\nThe URL uses [gRPC Transcoding](https://github.com/googleapis/googleapis/blob/master/google/api/http.proto) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-----------------|------------------------------------------------------|\n| `customer.name` | `string` Output only. Resource name of the customer. |\n\n### Query parameters\n\n| Parameters ||\n|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `updateMask` | `string (`[FieldMask](/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask)` format)` Fields to be updated. A comma-separated list of fully qualified names of fields. Example: `\"user.displayName,photo\"`. \u003cbr /\u003e |\n\n### Request body\n\nThe request body contains an instance of [Customer](/spectrum-access-system/reference/rest/customers#Customer).\n\n### Response body\n\nIf successful, the response body contains an instance of [Customer](/spectrum-access-system/reference/rest/customers#Customer).\n\n### Authorization Scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/userinfo.email`"]]
