Video Channels

Update a video channel

PUT

https://peertube2.cpy.re/api/v1/video-channels/{channelHandle}

curl -X PUT 'https://peertube2.cpy.re/api/v1/video-channels/my_username%20%7C%20my_username%40example.com' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "publicEmail": "user@example.com",
  "bulkVideosSupportUpdate": true
}'

const body = `{
  "publicEmail": "user@example.com",
  "bulkVideosSupportUpdate": true
}`;

const response = await fetch('https://peertube2.cpy.re/api/v1/video-channels/my_username%20%7C%20my_username%40example.com', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "publicEmail": "user@example.com",
  "bulkVideosSupportUpdate": true
}'''

response = requests.put(
    'https://peertube2.cpy.re/api/v1/video-channels/my_username%20%7C%20my_username%40example.com',
    data=body.encode('utf-8'),
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "publicEmail": "user@example.com",
  "bulkVideosSupportUpdate": true
}

Body

application/json

displayNameany

Channel display name

descriptionany

Channel description

supportany

How to support/fund the channel

publicEmailstring<email> | null

Public email visible in podcast RSS feeds

bulkVideosSupportUpdateboolean

Update the support field for all videos of this channel

Parameters

channelHandlestringrequiredpath

The video channel handle

Response

204No Content

successful operation

Authorization

OAuth2oauth2

Authenticating via OAuth requires the following steps:

Have an activated account
Generate an access token for that account at /api/v1/users/token.
Make requests with the Authorization: Bearer <token> header
Profit, depending on the role assigned to the account

Note that the access token is valid for 1 day and is given along with a refresh token valid for 2 weeks.

Docs by Sourcey