Method: customFields.patch

Full name: projects.locations.instances.customFields.patch

Update a CustomField.

HTTP request


Path parameters

Parameters
customField.name

string

Identifier. The unique name(ID) of the CustomField. Format: projects/{project}/locations/{location}/instances/{instance}/customFields/{customField}

Query parameters

Parameters
updateMask

string (FieldMask format)

Optional. The list of fields to update. If not included, all fields will be updated (effectively a full replacement). Mutable fields: displayName, type, scopes, type_options, description.

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

Response body

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

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.