Update player - SquadVault

PATCH

/

players

/

{playerId}

Update player

curl --request PATCH \
  --url https://api.squadvault.xyz/v1/players/{playerId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{}'

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://api.squadvault.xyz/v1/players/{playerId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.squadvault.xyz/v1/players/{playerId}"

payload = {}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "id": "<string>",
  "organizationId": "<string>",
  "userId": "<string>",
  "name": "<string>",
  "role": "<string>",
  "mainGame": "cs",
  "nationality": "de",
  "discordUserId": "<string>",
  "discordUsername": "<string>",
  "archivedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "gamerTagCount": 123,
  "teamCount": 123,
  "gamerTags": [
    {
      "id": "<string>",
      "organizationId": "<string>",
      "playerId": "<string>",
      "game": "cs",
      "gamerTag": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "teams": [
    {
      "id": "<string>",
      "name": "<string>",
      "game": "cs"
    }
  ]
}

Authorizations

x-api-key

string

header

required

Organization API key from Settings → API keys.

Path Parameters

playerId

string

required

Body

application/json

name

string

gamerTags

object[]

Minimum array length: 1

Show child attributes

mainGame

enum<string> | null

Available options:

cs,

valorant,

overwatch,

fortnite,

minecraft,

rocket-league,

league,

other

role

string | null

nationality

string | null

ISO 3166-1 alpha-2 country code (lowercase). United Kingdom is uk. Set null to clear.

Example:

"uk"

teamIds

string[]

archived

boolean

Set true to archive the player; false to restore.

discordUserId

string | null

Response

Updated player

id

string

organizationId

string

userId

string | null

name

string

role

string | null

mainGame

enum<string> | null

Available options:

cs,

valorant,

overwatch,

fortnite,

minecraft,

rocket-league,

league,

other

nationality

string | null

ISO 3166-1 alpha-2 country code (lowercase). United Kingdom is uk.

Example:

"de"

discordUserId

string | null

discordUsername

string | null

archivedAt

string<date-time> | null

createdAt

string<date-time>

updatedAt

string<date-time>

gamerTagCount

integer

teamCount

integer

gamerTags

object[]

Show child attributes

teams

object[]

Show child attributes

Update player

curl --request PATCH \
  --url https://api.squadvault.xyz/v1/players/{playerId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{}'

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://api.squadvault.xyz/v1/players/{playerId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.squadvault.xyz/v1/players/{playerId}"

payload = {}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "id": "<string>",
  "organizationId": "<string>",
  "userId": "<string>",
  "name": "<string>",
  "role": "<string>",
  "mainGame": "cs",
  "nationality": "de",
  "discordUserId": "<string>",
  "discordUsername": "<string>",
  "archivedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "gamerTagCount": 123,
  "teamCount": 123,
  "gamerTags": [
    {
      "id": "<string>",
      "organizationId": "<string>",
      "playerId": "<string>",
      "game": "cs",
      "gamerTag": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "teams": [
    {
      "id": "<string>",
      "name": "<string>",
      "game": "cs"
    }
  ]
}