Save embed channel logo settings

PUT https://octopus.livepush.io/streams/{stream_id}/embed/channel_logo

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

Configures the channel logo overlay: image, size, position, layout and click-through URL.

Requires a token with write access to the stream (CanWriteStreams).

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/streams/{stream_id}/embed/channel_logo — This call changes live data on your account.

Parameters

Path parameters

stream_id string required

Unique identifier of the stream.

example: st_xxxxxxxxxxxxx

Request body

application/json required

embedChannelIconURL string

Public URL of the logo image.
embedChannelIconSize string

Rendered size of the overlay.
embedChannelIconPosition string

Corner the logo is anchored to.
embedChannelIconLayout string

Layout variant for the overlay.
embedChannelIconAnchorURL string

URL opened when a viewer clicks the logo.

Example request body response.json

{
  "embedChannelIconURL": "https://cdn.example.com/logo.png",
  "embedChannelIconSize": "medium",
  "embedChannelIconPosition": "top-right",
  "embedChannelIconLayout": "compact",
  "embedChannelIconAnchorURL": "https://example.com"
}

Code samples

request.sh

curl -X PUT 'https://octopus.livepush.io/streams/st_xxxxxxxxxxxxx/embed/channel_logo' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "embedChannelIconURL": "https://cdn.example.com/logo.png",
    "embedChannelIconSize": "medium",
    "embedChannelIconPosition": "top-right",
    "embedChannelIconLayout": "compact",
    "embedChannelIconAnchorURL": "https://example.com"
  }'

const response = await fetch('https://octopus.livepush.io/streams/st_xxxxxxxxxxxxx/embed/channel_logo', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "embedChannelIconURL": "https://cdn.example.com/logo.png",
    "embedChannelIconSize": "medium",
    "embedChannelIconPosition": "top-right",
    "embedChannelIconLayout": "compact",
    "embedChannelIconAnchorURL": "https://example.com"
  }),
});

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 = {
    "embedChannelIconURL": "https://cdn.example.com/logo.png",
    "embedChannelIconSize": "medium",
    "embedChannelIconPosition": "top-right",
    "embedChannelIconLayout": "compact",
    "embedChannelIconAnchorURL": "https://example.com"
}

response = requests.put('https://octopus.livepush.io/streams/st_xxxxxxxxxxxxx/embed/channel_logo', 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.

Authorization#

Try it#

Parameters#