User APIs

Add User profile image(Avatar)

OVERVIEW

Note: This API endpoint is supported from Collaborate version 5.0 and above

Overview

Add a profile image for a user in Publisher

This API call is used to add a new profile image(avatar)

Note:

1. Following form-data parameters are optional: avatarXPosition, avatarYPosition, avatarWidth, avatarHeight

HTTP Request

POST /api/5/users/<USERID>/avatar

Form-data

file : <UploadedFile>
avatarXPosition : 806   (Optional)
avatarYPosition : 0   (Optional)
avatarWidth : 2160   (Optional)
avatarHeight : 2160   (Optional)

HTTP Response
Success

HTTP response 200 (User avatar should be changed)

 

Example HTTP Request & Response

POST http://example.com/context/api/5/users/4/avatar

 

Error messages

Summary Ref Code (V5)

Please enter valid numbers

 396

The file was not found

 397

Upload an image which has a size greater than 0

 406

The image type you are trying to upload is not supported

 398

Due to a system error, this {0} cannot be uploaded

 399

This file is unsupported, the file upload has been terminated

 400

This image is too small. Ensure the shortest side is at least 256 pixels long.

 401

Please enter valid x position or width. The sum of x position and width should not exceed the actual width of an image.

 402

Please enter valid y position or height. The sum of y position and height should not exceed the actual height of an image.

 403

Image height and width must be same. Only a square image can be uploaded for a user avatar.

 404

Error occurred while transferring data to repository or updating database

 405

 

Comments


1 Comments

Last Updated: Jun 10,2023