Method: users.patch

Updates an existing user. Returns the updated user if successful.

This method has unique authentication requirements. Read the prerequisites in our Managing Users guide before using this method.

The "Try this method" feature does not work for this method.

HTTP request

PATCH https://displayvideo.googleapis.com/v2/users/{user.userId}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
user.userId

string (int64 format)

Output only. The unique ID of the user. Assigned by the system.

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. The mask to control which 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 User.

Response body

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

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/display-video-user-management

For more information, see the OAuth 2.0 Overview.