Method: networks.customFields.patch

  • This document details the API for updating a CustomField object using a PATCH HTTP request.

  • The API requires a customField.name path parameter to identify the CustomField resource and a required updateMask query parameter to specify the fields to update.

  • Both the request and response bodies contain an instance of the CustomField object.

  • Updating a CustomField requires the https://www.googleapis.com/auth/admanager OAuth scope for authorization.

API to update a CustomField object.

HTTP request

PATCH https://admanager.googleapis.com/v1/{customField.name}

Path parameters

Parameters
customField.name

string

Identifier. The resource name of the CustomField. Format: networks/{networkCode}/customFields/{customField}

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. The list of fields to update.

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/admanager

For more information, see the OAuth 2.0 Overview.