Method: users.patch

AI-generated Key Takeaways

• Display & Video 360 API v2 is sunset and this documentation details updating an existing user with the users.patch method.

• This method requires specific authentication outlined in the Managing Users guide and the "Try this method" feature is unavailable.

• The request utilizes an HTTP PATCH method to the specified endpoint with path and query parameters defining the user and fields to update.

• The request body should contain a User object and a successful response will return the updated User object.

• Authorization requires the https://www.googleapis.com/auth/display-video-user-management OAuth scope.

Display & Video 360 API v2 has sunset.

• HTTP request
• Path parameters
• Query parameters
• Request body
• Response body
• Authorization scopes
• Try it!

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.