Chilkat Online Tools

delphiDll / PandaDoc API Reference / Rename Documents Folder

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
json: HCkJsonObject;
sbRequestBody: HCkStringBuilder;
resp: HCkHttpResponse;

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

http := CkHttp_Create();

// 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"
// }

json := CkJsonObject_Create();
CkJsonObject_UpdateString(json,'name','Another documents folder');

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

sbRequestBody := CkStringBuilder_Create();
CkJsonObject_EmitSb(json,sbRequestBody);

resp := CkHttp_PTextSb(http,'PUT','https://api.pandadoc.com/public/v1/documents/folders/{{documents_folder_uuid}}',sbRequestBody,'utf-8','application/json',False,False);
if (CkHttp_getLastMethodSuccess(http) = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

Memo1.Lines.Add(IntToStr(CkHttpResponse_getStatusCode(resp)));
Memo1.Lines.Add(CkHttpResponse__bodyStr(resp));
CkHttpResponse_Dispose(resp);

CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);

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": [
  ]
}