Edit a created channel's guide

PUT/streams/{id}/guide/

write Change: creates or edits. Scopes

Your own title, subtitle and description for some titles (by key), shown while the plan's guide is edited. All three empty: back to the title's own words. Answers how many were kept.

Path parameters

idstring (uuid)required
The stream's id.

Body

editsobject[]required
- keystringrequired
- titlestring
- sub_titlestring
- descriptionstring

Response

200 OK

keptintegerrequired

Errors

400 Something sent is not valid. Each field that is wrong is named with what is wrong.
401 No credential, or one that is wrong, expired or revoked.
403 The account, or the key's or app's scopes, may not do this.
404
429 Slow down: wait the seconds in the Retry-After header, then try again.

What each error means

cURL

curl -X PUT 'https://panel.example.com/streams/1/guide/' \
  -H "Authorization: Bearer $MINIMUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "edits": [
    {
      "key": "string"
    }
  ]
}'

Python

import os
import requests

response = requests.put(
    "https://panel.example.com/streams/1/guide/",
    headers={"Authorization": f"Bearer {os.environ['MINIMUS_API_KEY']}"},
    json={
        "edits": [
            {
                "key": "string"
            }
        ]
    },
)
response.raise_for_status()
print(response.json())

JavaScript

const response = await fetch('https://panel.example.com/streams/1/guide/', {
  method: 'PUT',
  headers: { Authorization: `Bearer ${process.env.MINIMUS_API_KEY}`, 'Content-Type': 'application/json' },
  body: JSON.stringify({
    "edits": [
      {
        "key": "string"
      }
    ]
  }),
});
if (!response.ok) throw new Error(`${response.status}`);
console.log(await response.json());

Response 200

{
  "kept": 1
}

Edit a created channel's guide

Path parameters#

Body#

Response#

200 OK

Errors#

Path parameters

Body

Response

Errors