Rename player | Softmax docs

PATCH/players/{player_id}

Changes the player's display name.

Authorization

BearerAuth

AuthorizationBearer <token>

Bearer token issued by Softmax

In: header

Path Parameters

player_id*Player Id

Player to rename.

Match^ply_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Request Body

application/json

name*Name

Display name for the player.

Length1 <= length <= 255

bash

curl -X PATCH "https://example.com/players/string" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string"
  }'

json

{
  "user_id": "string",
  "user": {
    "id": "string",
    "name": "string",
    "email": "string",
    "is_softmax_team_member": true,
    "discord_id": "string",
    "created_at": "2019-08-24T14:15:22Z"
  },
  "owner_coworld_name": "string",
  "id": "string",
  "name": "string",
  "is_default": true,
  "avatar_url": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "disabled_at": "2019-08-24T14:15:22Z"
}