Rename Folder

If you wish to change the name of a folder then this API enables you to rename an existing folder. You would need to send an

HTTP PUT request to https://dev.vdocipher.com/api/videos/folders/{{folderID}}.

The PUT request body should include a new name for the folder.

{
  "name": "{{newFolderName}}"
}

Sample Code for Renaming a Folder

The sample folder ID is written as {{folderId}}. Replace this with the desired folder ID.

The sample new folder name is written as {{newFolderName}}. Replace this with the desired new folder name.

The sample API Secret Key is a1b2c3d4e5.

CURL

curl -X PUT \
  https://dev.vdocipher.com/api/videos/folders/{{folderID}} \
  -H 'Accept: application/json' \
  -H 'Authorization: Apisecret a1b2c3d4e5' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "{{newFolderName}}"
}'

NODE

var request = require('request');

var options = {
  method: 'PUT',
  url: 'https://dev.vdocipher.com/api/videos/folders/{{folderID}}',
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'Authorization': 'Apisecret a1b2c3d4e5',
  },
  body: {name: '{{newFolderName}}'},
  json: true,
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

PHP

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://dev.vdocipher.com/api/videos/folders/{{folderID}}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    "name" => "{{newFolderName}}"
  ]),
  CURLOPT_HTTPHEADER => array(
    "Accept: application/json",
    "Authorization: Apisecret a1b2c3d4e5",
    "Content-Type: application/json"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

C#

var client = new RestClient("https://dev.vdocipher.com/api/videos/folders/{{folderID}}");
var request = new RestRequest(Method.PUT);
request.AddHeader("Accept", "application/json");
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Apisecret a1b2c3d4e5");
request.AddParameter("undefined", "{\"name\": \"{{newfolderName}}\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Python

import requests

url = "https://dev.vdocipher.com/api/videos/folders/{{folderID}}"
payload = json.dumps({
  "name": "{{newFolderName}}"
})
headers = {
  'Authorization': "Apisecret a1b2c3d4e5",
  'Content-Type': "application/json",
  'Accept': "application/json",
}

response = requests.request("PUT", url, headers=headers)

print(response.text)

Ruby

require 'uri'
require 'net/http'

url = URI("https://dev.vdocipher.com/api/videos/folders/{{folderID}}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Apisecret a1b2c3d4e5'
request["Content-Type"] = 'application/json'
request["Accept"] = 'application/json'
request.body = ({
  :name => "{{newFolderName}}"
}).to_json

response = http.request(request)
puts response.read_body

Sample Response from API

{
  "message": "Folder has been updated"
}