Skip to main content
PATCH
/
players
/
{id}
Update player profile
curl --request PATCH \
  --url https://api.engagefabric.com/players/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayName": "Jane Doe",
  "avatarUrl": "https://example.com/avatars/janedoe.png",
  "locale": "fr-FR",
  "status": "ACTIVE",
  "metadata": {
    "accountType": "premium",
    "tier": "gold"
  }
}
'
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "projectId": "123e4567-e89b-12d3-a456-426614174000",
  "externalUserId": "user_12345",
  "xp": 1250,
  "level": 5,
  "lives": 3,
  "maxLives": 5,
  "livesUpdatedAt": "2025-01-15T10:30:00Z",
  "currencies": {
    "coins": 500,
    "gems": 50
  },
  "status": "ACTIVE",
  "isFlagged": false,
  "createdAt": "2025-01-15T10:30:00Z",
  "updatedAt": "2025-01-15T10:30:00Z",
  "lastSeenAt": "2025-01-15T10:30:00Z",
  "displayName": "John Doe",
  "avatarUrl": "https://example.com/avatars/johndoe.png",
  "locale": "en-US",
  "flagReason": null,
  "metadata": {
    "accountType": "premium"
  },
  "deletedAt": null
}

Path Parameters

​
id
string
required

Player UUID

Body

application/json
​
displayName
string

Player display name

Maximum string length: 255
Example:

"Jane Doe"

​
avatarUrl
string

Player avatar URL

Maximum string length: 500
Example:

"https://example.com/avatars/janedoe.png"

​
locale
string

Player locale (e.g., en-US, fr-FR)

Maximum string length: 10
Example:

"fr-FR"

​
status
enum<string>

Player status

Available options:
ACTIVE,
SUSPENDED,
BANNED
​
metadata
object

Additional player metadata

Example:
{ "accountType": "premium", "tier": "gold" }

Response

Player updated successfully

​
id
string
required

Unique player identifier

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
projectId
string
required

Project ID this player belongs to

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
externalUserId
string
required

External user ID from client application

Example:

"user_12345"

​
xp
number
required

Player XP

Example:

1250

​
level
number
required

Player level

Example:

5

​
lives
number
required

Current lives/energy

Example:

3

​
maxLives
number
required

Maximum lives

Example:

5

​
livesUpdatedAt
string<date-time>
required

Last time lives were updated

Example:

"2025-01-15T10:30:00Z"

​
currencies
object
required

Player currencies (key-value pairs)

Example:
{ "coins": 500, "gems": 50 }
​
status
enum<string>
required

Player status

Available options:
ACTIVE,
SUSPENDED,
BANNED
Example:

"ACTIVE"

​
isFlagged
boolean
required

Whether player is flagged for review

Example:

false

​
createdAt
string<date-time>
required

Creation timestamp

Example:

"2025-01-15T10:30:00Z"

​
updatedAt
string<date-time>
required

Last update timestamp

Example:

"2025-01-15T10:30:00Z"

​
lastSeenAt
string<date-time>
required

Last activity timestamp

Example:

"2025-01-15T10:30:00Z"

​
displayName
object

Player display name

Example:

"John Doe"

​
avatarUrl
object

Player avatar URL

Example:

"https://example.com/avatars/johndoe.png"

​
locale
object

Player locale

Example:

"en-US"

​
flagReason
object

Reason for flagging

Example:

null

​
metadata
object

Additional player metadata

Example:
{ "accountType": "premium" }
​
deletedAt
object

Soft deletion timestamp

Example:

null