Account Management - Update Avatar Url

Service:

Server

API Version:

241122

Update the avatar URL of the specified player

POST https://titleId.playfabapi.com/Server/UpdateAvatarUrl

Request Header

Name	Required	Type	Description
X-SecretKey	True	string	This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Request Body

Name	Required	Type	Description
ImageUrl	True	string	URL of the avatar image. If empty, it removes the existing avatar URL.
PlayFabId	True	string	Unique PlayFab assigned ID of the user on whom the operation will be performed.

Responses

Name	Type	Description
200 OK	EmptyResponse
400 Bad Request	ApiErrorWrapper	This is the outer wrapper for all responses with errors

Security

X-SecretKey

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Type: apiKey
In: header

Definitions

Name	Description
ApiErrorWrapper	The basic wrapper around every failed API response
EmptyResponse
UpdateAvatarUrlRequest

ApiErrorWrapper

The basic wrapper around every failed API response

Name	Type	Description
code	integer	Numerical HTTP code
error	string	Playfab error code
errorCode	integer	Numerical PlayFab error code
errorDetails	object	Detailed description of individual issues with the request object
errorMessage	string	Description for the PlayFab errorCode
status	string	String HTTP code

EmptyResponse

UpdateAvatarUrlRequest

Name	Type	Description
ImageUrl	string	URL of the avatar image. If empty, it removes the existing avatar URL.
PlayFabId	string	Unique PlayFab assigned ID of the user on whom the operation will be performed.