Skip to content

Updates part of player profile by id. Creates new profile if it doesn't exist

PATCH /v0/pam/v1/player/{playerId}

This endpoint updates parts of a player's profile by ID, excluding contact data fields such as phone, email, accountId, and userName.
If the profile does not exist, a new one will be created.

Parameters

Name In Type Required Description
migrated query - false Set isMigrated flag, default = false
validate query - false Validate player profile during update, default = true
Authorization header string true Access token for client (See "Auth API")
X-Actor-Id header string false none
X-Actor-Ip header string false none
X-Actor-Type header string false none
X-Brand header string true Client's brand via request header.
X-Operator-Id header string true Client's operator identifier via request header.
playerId path - true Player ID

Body examples

Example 1: Update operator user identifiers

This example shows how to update the operatorUserId and operatorUserName fields. These fields can only be set during the first player entrance to the iFrame (during account creation). If not provided initially, use this endpoint to update them.

{
  "profile": {
    "operatorUserId": "userId-2341",
    "operatorUserName": "user-name"
  }
}

Example 2: Update player country and registration data

This example shows how to update the player's country in both the profile and registration data.

{
  "profile": {
    "livingAddress": {
      "city": "London",
      "country": "GBR"
    },
    "country": "GBR"
  },
  "registrationData": {
    "RegistrationCountryIso2": "GB",
    "RegistrationCountryIso3": "GBR"
  }
}

Example responses

200 Response
"no example"
201 Response
"api/v2/player/{playerId}"
400 Response
{
  "brand": [
    "Brand is missing."
  ],
  "operatorId": [
    "Operator id is missing."
  ],
  "playerId": [
    "Failed to process list: missed player id"
  ]
}
500 Response
{
  "error": {
    "message": "Invalid response from remote service"
  }
}

Responses

Status Meaning Description Schema
200 OK Returns empty response in case of success update None
201 Created Returns uri in case profile was created None
400 Bad Request In case of invalid request None
500 Internal Server Error In case some internal error None