Rename a player

PUT https://octopus.livepush.io/players/{player_id}/name

Base URL https://octopus.livepush.io — Core Streams & Media APIs

Updates the player's display name. Not used by the dashboard.

Requires a token with CanWritePlayers.

Authorization

Send a valid access token in the Authorization header.

bearerAuth — Bearer token (JWT)

headers.txt

Authorization: Bearer YOUR_API_TOKEN

Try it

PUT https://octopus.livepush.io/players/{player_id}/name — This call changes live data on your account.

Parameters

Path parameters

player_id string required

Unique identifier of the player.

example: pl_xxxxxxxxxxxx

Request body

application/json required

name string required

Example request body response.json

{
  "name": "Lobby screen"
}

Code samples

request.sh

curl -X PUT 'https://octopus.livepush.io/players/pl_xxxxxxxxxxxx/name' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Lobby screen"
  }'

const response = await fetch('https://octopus.livepush.io/players/pl_xxxxxxxxxxxx/name', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "Lobby screen"
  }),
});

if (!response.ok) {
  throw new Error(`Livepush API error ${response.status}`);
}

const data = await response.json();

import requests

headers = {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json',
}

payload = {
    "name": "Lobby screen"
}

response = requests.put('https://octopus.livepush.io/players/pl_xxxxxxxxxxxx/name', headers=headers, json=payload, timeout=30)
response.raise_for_status()
data = response.json()

Responses

Setting applied.

application/json

success boolean

Example 200 response response.json

{
  "success": true
}

No response body.

No such player for this account.