Update User Avatar

Updates the avatar of a particular user.

Update the avatar of a particular user

POSTyourpodURL.symphony.com/pod/v1/admin/user/{uid}/avatar/update

Path parameters

uid*integer (int64)

User ID as a decimal integer

Header parameters

Body

application/json

imagestring

Base64 encoded image. Original image must be less than 2MB.

Response

200400401403500

Success

Body

application/json

formatenum

TEXTXML

messagestring

Request

JavaScriptCurl

const response = await fetch('yourpodURL.symphony.com/pod/v1/admin/user/{uid}/avatar/update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "format": "TEXT",
  "message": "Success"
}

📘 Note

This API also allows the current user to update his own avatar.

🚧 Required Permissions

Calling this endpoint requires the User Provisioning role with ACCESS_USER_PROVISIONING_API privilege. See Bot Permissions for a list of roles and associated privileges.