Method: users.patch

AI-generated Key Takeaways

• Display & Video 360 API v1 is sunset and this documentation details updating existing users via the API.

• The API request utilizes an HTTP PATCH method with specific path and query parameters for user identification and field updates.

• Authentication is required with the https://www.googleapis.com/auth/display-video-user-management scope, and prerequisites are detailed in the Managing Users guide.

• Successful requests will return the updated user details, however the "Try this method" feature is unavailable for this specific functionality.

Display & Video 360 API v1 has been 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/v1/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.