Chilkat Online Tools

phpAx / PandaDoc API Reference / Rename Documents Folder

Back to Collection Items

<?php

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

// Use this online tool to generate code from sample JSON: Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "name": "Another documents folder"
// }

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateString('name','Another documents folder');

$http->SetRequestHeader('Authorization','API-Key {{api_key}}');
$http->SetRequestHeader('Content-Type','application/json');

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbRequestBody = new COM("Chilkat.StringBuilder");
$json->EmitSb($sbRequestBody);

// resp is a Chilkat.HttpResponse
$resp = $http->PTextSb('PUT','https://api.pandadoc.com/public/v1/documents/folders/{{documents_folder_uuid}}',$sbRequestBody,'utf-8','application/json',0,0);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

print $resp->StatusCode . "\n";
print $resp->BodyStr . "\n";


?>

Curl Command

curl -X PUT
	-H "Authorization: Bearer {{access_token}}"
	-H "Authorization: API-Key {{api_key}}"
	-H "Content-Type: application/json"
	-d '{
    "name":"Another documents folder"
}'
https://api.pandadoc.com/public/v1/documents/folders/{{documents_folder_uuid}}

Postman Collection Item JSON

{
  "name": "Rename Documents Folder",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Authorization",
        "value": "Bearer {{access_token}}",
        "disabled": true
      },
      {
        "key": "Authorization",
        "type": "text",
        "value": "API-Key {{api_key}}"
      },
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\r\n    \"name\":\"Another documents folder\"\r\n}"
    },
    "url": {
      "raw": "https://api.pandadoc.com/public/v1/documents/folders/{{documents_folder_uuid}}",
      "protocol": "https",
      "host": [
        "api",
        "pandadoc",
        "com"
      ],
      "path": [
        "public",
        "v1",
        "documents",
        "folders",
        "{{documents_folder_uuid}}"
      ]
    },
    "description": "For details go to https://developers.pandadoc.com/reference#rename-documents-folder"
  },
  "response": [
  ]
}