POST - Create avatar short code

This is an alternative to avatar hotloading, for applications that can’t pass query parameters between the browser and the desktop game.

A unique code can be generated for an avatar. Once created, this code can be used to retrieve the avatar ID during a period of time (1 hour).

The code consists of three letters followed by two numbers (e.g., ABC12) and expires past 1 hour.

Use this endpoint to create an avatar code

Request

POST https://api.readyplayer.me/v3/avatars/code

Request Body

Name	Type	Description
data.avatarId	string	The ID of the avatar for which you want to generate code.

Example Request Body

{
    "data": {
        "avatarId": "743a7c421b5a830535675049"
    }
}

Response

201: OK Created response

{
  "data": {
    "avatarId": "743a7c421b5a830535675049",
    "code": "ABC12"
  }
}