Rename a caption track
curl --request PATCH \
--url https://api.pnplayer.com/v1/api/video/{videoId}/captions/{srclang} \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: <api-key>' \
--data '
{
"label": "English (CC)"
}
'import requests
url = "https://api.pnplayer.com/v1/api/video/{videoId}/captions/{srclang}"
payload = { "label": "English (CC)" }
headers = {
"X-Auth-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-Auth-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({label: 'English (CC)'})
};
fetch('https://api.pnplayer.com/v1/api/video/{videoId}/captions/{srclang}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.pnplayer.com/v1/api/video/{videoId}/captions/{srclang}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'label' => 'English (CC)'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Auth-Token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.pnplayer.com/v1/api/video/{videoId}/captions/{srclang}"
payload := strings.NewReader("{\n \"label\": \"English (CC)\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-Auth-Token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.pnplayer.com/v1/api/video/{videoId}/captions/{srclang}")
.header("X-Auth-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"label\": \"English (CC)\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pnplayer.com/v1/api/video/{videoId}/captions/{srclang}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-Auth-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"label\": \"English (CC)\"\n}"
response = http.request(request)
puts response.read_body{
"message": "success"
}{
"message": "<string>"
}{
"message": "Forbidden"
}{
"message": "Not found"
}Captions
Rename a caption track
Changes the display label of an existing caption track. Fires caption.updated. Requires the UPDATE_MEDIA scope.
PATCH
/
v1
/
api
/
video
/
{videoId}
/
captions
/
{srclang}
Rename a caption track
curl --request PATCH \
--url https://api.pnplayer.com/v1/api/video/{videoId}/captions/{srclang} \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: <api-key>' \
--data '
{
"label": "English (CC)"
}
'import requests
url = "https://api.pnplayer.com/v1/api/video/{videoId}/captions/{srclang}"
payload = { "label": "English (CC)" }
headers = {
"X-Auth-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-Auth-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({label: 'English (CC)'})
};
fetch('https://api.pnplayer.com/v1/api/video/{videoId}/captions/{srclang}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.pnplayer.com/v1/api/video/{videoId}/captions/{srclang}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'label' => 'English (CC)'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Auth-Token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.pnplayer.com/v1/api/video/{videoId}/captions/{srclang}"
payload := strings.NewReader("{\n \"label\": \"English (CC)\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-Auth-Token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.pnplayer.com/v1/api/video/{videoId}/captions/{srclang}")
.header("X-Auth-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"label\": \"English (CC)\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pnplayer.com/v1/api/video/{videoId}/captions/{srclang}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-Auth-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"label\": \"English (CC)\"\n}"
response = http.request(request)
puts response.read_body{
"message": "success"
}{
"message": "<string>"
}{
"message": "Forbidden"
}{
"message": "Not found"
}Authorizations
apiKeyAuthbearerAuth
API key created in the dashboard or via POST /v1/api/api-keys. Keys are prefixed pn_ and do not expire until revoked.
Path Parameters
Video ID (GUID)
Example:
"657bb740-a71b-4529-a012-528021c31a92"
Caption language code
Example:
"en"
Body
application/json
Example:
"English (CC)"
Response
Label updated
Example:
"success"
