Folder

This module covers all operations related to the team folder. Use this API to create, associate, disassociate, and retrieve folder details.

Create Project Folder(s)

Create a folder in a project.

POST

/api/v3/portal/[PORTAL_ID]/projects/[PROJECT_ID]/documents/folders

OAuth Scope:

ZohoProjects.documents.CREATE, WorkDrive.workspace.ALL,Workdrive.team.ALL,WorkDrive.files.ALL

Path Parameters

Param Name

Data Type

Description

portal_id

String

required
regex : [0-9]+

Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the "id" field in the response).

project_id

String

required
regex : [0-9]+

Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the "id" field in the response).

Body Parameters

Param Name

Data Type

Description

name

String

required
max length : 100

Name of the Folder

parent_id

String

required
max length : 200

Enter the team folder or folder ID.
To get the folder IDs, use the Get Project Team Folder Details

user_permissions

JSONArray

required
max length : 10000

Enter the permission details for the folder.
To get the default folder permission, use the Get Project Team Folder Details

Request Example

cURL
Deluge
Node.js
Ruby
PHP
- Python
- C
- C#
- C++
- Clojure
- Go
- HTTP
- Java
- JS Fetch
- JSON
- Kotlin
- Objective-C
- OCaml
- PowerShell
- R
- Swift

curl -X POST \
'https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders' \
-H 'Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa' \
-H 'Content-Type: application/json' \
-d '{"name":"Team Folder","parent_id":"we9i836cbd87259dd451cb7c382802145f029","user_permissions":[{"add":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"remove":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}]}'

url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders";
params = Map();
params.put("name", "Team Folder");
params.put("parent_id", "we9i836cbd87259dd451cb7c382802145f029");
params.put("user_permissions", [{"add":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"remove":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}]);
response = invokeUrl
[
    url: url
    type: POST
    parameters: params.toString()
    connection: "projects"
];
info response;

const https = require('https');
const url = new URL('https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders');

const payload = JSON.stringify({"name":"Team Folder","parent_id":"we9i836cbd87259dd451cb7c382802145f029","user_permissions":[{"add":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"remove":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}]});

const options = {
  hostname: url.hostname,
  path: url.pathname + url.search,
  method: 'POST',
  headers: {
    'Authorization': 'Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa',
    'Content-Type': 'application/json',
    'Content-Length': Buffer.byteLength(payload)
  }
};

const req = https.request(options, (res) => {
  let data = '';
  res.on('data', (chunk) => { data += chunk; });
  res.on('end', () => { console.log(JSON.parse(data)); });
});

req.on('error', (err) => { console.error(err); });
req.write(payload);
req.end();

require 'net/http'
require 'uri'
require 'json'

url = URI("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
request["Content-Type"] = "application/json"
request.body = '{"name":"Team Folder","parent_id":"we9i836cbd87259dd451cb7c382802145f029","user_permissions":[{"add":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"remove":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}]}'

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

<?php
$url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders";

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => $url,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => '{"name":"Team Folder","parent_id":"we9i836cbd87259dd451cb7c382802145f029","user_permissions":[{"add":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"remove":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}]}',
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

import requests

url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders"

headers = {
    "Authorization": "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa",
    "Content-Type": "application/json",
}

payload = '{"name":"Team Folder","parent_id":"we9i836cbd87259dd451cb7c382802145f029","user_permissions":[{"add":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"remove":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}]}'

response = requests.post(url, headers=headers, data=payload)

print(response.json())

#include <stdio.h>
#include <string.h>
#include <curl/curl.h>

int main(void) {
    CURL *curl = curl_easy_init();
    if (curl) {
        struct curl_slist *headers = NULL;
        headers = curl_slist_append(headers, "Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");
        headers = curl_slist_append(headers, "Content-Type: application/json");

        curl_easy_setopt(curl, CURLOPT_URL, "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders");
        curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
        curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "POST");
        curl_easy_setopt(curl, CURLOPT_POSTFIELDS, "{\"name\":\"Team Folder\",\"parent_id\":\"we9i836cbd87259dd451cb7c382802145f029\",\"user_permissions\":[{\"add\":[{\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}],\"remove\":[{\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}],\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}]}");

        CURLcode res = curl_easy_perform(curl);
        if (res != CURLE_OK)
            fprintf(stderr, "curl failed: %s\n", curl_easy_strerror(res));

        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}

using System.Net.Http;
using System.Text;
using System.Web;

var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");

var request = new HttpRequestMessage(HttpMethod.Post, "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders");
request.Content = new StringContent(
    @"{""name"":""Team Folder"",""parent_id"":""we9i836cbd87259dd451cb7c382802145f029"",""user_permissions"":[{""add"":[{""workdrive_role"":""admin"",""users"":[{""zpuid"":""4000000002055""}],""profiles"":[{""id"":""4000000062001""}]}],""remove"":[{""workdrive_role"":""admin"",""users"":[{""zpuid"":""4000000002055""}],""profiles"":[{""id"":""4000000062001""}]}],""workdrive_role"":""admin"",""users"":[{""zpuid"":""4000000002055""}],""profiles"":[{""id"":""4000000062001""}]}]}",
    Encoding.UTF8,
    "application/json"
);

var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

#include <iostream>
#include <string>
#include <curl/curl.h>

static size_t WriteCallback(void* contents, size_t size, size_t nmemb, std::string* output) {
    output->append((char*)contents, size * nmemb);
    return size * nmemb;
}

int main() {
    CURL* curl = curl_easy_init();
    if (curl) {
        std::string response;
        struct curl_slist* headers = NULL;
        headers = curl_slist_append(headers, "Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");
        headers = curl_slist_append(headers, "Content-Type: application/json");

        curl_easy_setopt(curl, CURLOPT_URL, "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders");
        curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
        curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "POST");
        curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, WriteCallback);
        curl_easy_setopt(curl, CURLOPT_WRITEDATA, &response);
        curl_easy_setopt(curl, CURLOPT_POSTFIELDS, "{\"name\":\"Team Folder\",\"parent_id\":\"we9i836cbd87259dd451cb7c382802145f029\",\"user_permissions\":[{\"add\":[{\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}],\"remove\":[{\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}],\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}]}");

        CURLcode res = curl_easy_perform(curl);
        if (res == CURLE_OK)
            std::cout << response << std::endl;
        else
            std::cerr << curl_easy_strerror(res) << std::endl;

        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}

(require '[clj-http.client :as client])

(def response
  (client/post "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders"
    {:headers {"Authorization" "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
                "Content-Type" "application/json"}
     :body "{\"name\":\"Team Folder\",\"parent_id\":\"we9i836cbd87259dd451cb7c382802145f029\",\"user_permissions\":[{\"add\":[{\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}],\"remove\":[{\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}],\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}]}"
     :as :json}))

(println (:body response))

package main

import (
    "fmt"
    "io"
    "net/http"
    "strings"
)

func main() {
    payload := strings.NewReader("{\"name\":\"Team Folder\",\"parent_id\":\"we9i836cbd87259dd451cb7c382802145f029\",\"user_permissions\":[{\"add\":[{\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}],\"remove\":[{\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}],\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}]}")
    req, _ := http.NewRequest("POST", "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders", payload)
    req.Header.Add("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa")
    req.Header.Add("Content-Type", "application/json")

    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}

POST https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders HTTP/1.1
Host: https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders
Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa
Content-Type: application/json

{"name":"Team Folder","parent_id":"we9i836cbd87259dd451cb7c382802145f029","user_permissions":[{"add":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"remove":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}]}

HttpClientBuilder httpClientBuilder = HttpClientBuilder.create();

SSLContext sslContext = SSLContext.getDefault();
SSLConnectionSocketFactory sslConnectionSocketFactory = new SSLConnectionSocketFactory(sslContext, NoopHostnameVerifier.INSTANCE);
CloseableHttpClient httpclient = httpClientBuilder.setSSLSocketFactory(sslConnectionSocketFactory).build();

URIBuilder uriBuilder = new URIBuilder("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders");
HttpUriRequest requestObj = new HttpPost(uriBuilder.build());
requestObj.addHeader("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");

HttpEntityEnclosingRequestBase requestBase = (HttpEntityEnclosingRequestBase) requestObj;
String requestBody = "{\"name\":\"Team Folder\",\"parent_id\":\"we9i836cbd87259dd451cb7c382802145f029\",\"user_permissions\":[{\"add\":[{\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}],\"remove\":[{\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}],\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}]}";
requestBase.setEntity(new StringEntity(requestBody, HTTP.UTF_8));

HttpResponse response = httpclient.execute(requestObj);

HttpEntity responseEntity = response.getEntity();
Object responseObject = EntityUtils.toString(responseEntity);
String responseString = responseObject.toString();

const url = 'https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders';

const options = {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({"name":"Team Folder","parent_id":"we9i836cbd87259dd451cb7c382802145f029","user_permissions":[{"add":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"remove":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}]})
};

fetch(url, options)
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error(error));

{"name":"Team Folder","parent_id":"we9i836cbd87259dd451cb7c382802145f029","user_permissions":[{"add":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"remove":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}]}

import java.net.HttpURLConnection
import java.net.URL
import okhttp3.HttpUrl.Companion.toHttpUrl

fun main() {
    val url = URL("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders")
    val conn = url.openConnection() as HttpURLConnection
    conn.requestMethod = "POST"
    conn.setRequestProperty("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa")
    conn.setRequestProperty("Content-Type", "application/json")
    conn.doOutput = true
    conn.outputStream.bufferedWriter().use { it.write("""{"name":"Team Folder","parent_id":"we9i836cbd87259dd451cb7c382802145f029","user_permissions":[{"add":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"remove":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}]}""") }

    val response = conn.inputStream.bufferedReader().readText()
    println(response)
}

NSURL *url = [NSURL URLWithString:@"https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders"];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:url];
[request setHTTPMethod:@"POST"];
[request setValue:@"Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa" forHTTPHeaderField:@"Authorization"];
[request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
NSData *body = [@"{\"name\":\"Team Folder\",\"parent_id\":\"we9i836cbd87259dd451cb7c382802145f029\",\"user_permissions\":[{\"add\":[{\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}],\"remove\":[{\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}],\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}]}" dataUsingEncoding:NSUTF8StringEncoding];
[request setHTTPBody:body];

NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *task = [session dataTaskWithRequest:request
    completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
        NSString *result = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];
        NSLog(@"%@", result);
}];
[task resume];

open Lwt
open Cohttp_lwt_unix

let () =
  let uri = Uri.of_string "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders" in
  let headers = Cohttp.Header.init ()
    |> fun h -> Cohttp.Header.add h "Authorization" "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
    |> fun h -> Cohttp.Header.add h "Content-Type" "application/json"
  in
  let body = Cohttp_lwt.Body.of_string {json|{"name":"Team Folder","parent_id":"we9i836cbd87259dd451cb7c382802145f029","user_permissions":[{"add":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"remove":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}]}|json} in
  Lwt_main.run (
    Client.post ~headers ~body uri >>= fun (_, body) ->
    Cohttp_lwt.Body.to_string body >|= fun s ->
    print_endline s)

$headers = @{
    "Authorization" = "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
    "Content-Type" = "application/json"
}

$body = @'
{"name":"Team Folder","parent_id":"we9i836cbd87259dd451cb7c382802145f029","user_permissions":[{"add":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"remove":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}]}
'@

$response = Invoke-RestMethod -Uri "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders" -Method POST -Headers $headers -Body $body

$response | ConvertTo-Json

library(httr)

url <- "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders"

response <- POST(
  url,
  add_headers(Authorization = "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"),
  content_type_json(),
  body = "{\"name\":\"Team Folder\",\"parent_id\":\"we9i836cbd87259dd451cb7c382802145f029\",\"user_permissions\":[{\"add\":[{\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}],\"remove\":[{\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}],\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}]}"
)

content(response, "text")

import Foundation

let url = URL(string: "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders")!
var request = URLRequest(url: url)
request.httpMethod = "POST"
request.setValue("Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa", forHTTPHeaderField: "Authorization")
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
request.httpBody = """
{"name":"Team Folder","parent_id":"we9i836cbd87259dd451cb7c382802145f029","user_permissions":[{"add":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"remove":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}]}
""".data(using: .utf8)

let semaphore = DispatchSemaphore(value: 0)
let task = URLSession.shared.dataTask(with: request) { data, response, error in
    if let data = data, let result = String(data: data, encoding: .utf8) {
        print(result)
    }
    semaphore.signal()
}
task.resume()
semaphore.wait()

Sample Input

Content-Type: application/json

{ "name" : "Team Folder", "parent_id" : "we9i836cbd87259dd451cb7c382802145f029", "user_permissions" : [ { "add" : [ { "workdrive_role" : "admin", "users" : [ { "zpuid" : "4000000002055" } ], "profiles" : [ { "id" : "4000000062001" } ] } ], "remove" : [ { "workdrive_role" : "admin", "users" : [ { "zpuid" : "4000000002055" } ], "profiles" : [ { "id" : "4000000062001" } ] } ], "workdrive_role" : "admin", "users" : [ { "zpuid" : "4000000002055" } ], "profiles" : [ { "id" : "4000000062001" } ] } ] }

Sample Response

200{ "folder" : [ { "folder_id" : "225955000000152005", "name" : "Checkinnn", "workdrive_folder_id" : "pyafy6181f9897619441da5185dd1af5245b4", "is_personal_space" : false, "is_folder" : false, "is_default" : false, "is_customized" : false } ] }

Possible Errors

Associate Folder(s) to the Project

Associate folder(s) to a project.

POST

/api/v3/portal/[PORTAL_ID]/projects/[PROJECT_ID]/documents/folders/associate

OAuth Scope:

ZohoProjects.documents.UPDATE, WorkDrive.workspace.ALL,Workdrive.team.ALL,WorkDrive.files.ALL

Path Parameters

Param Name

Data Type

Description

portal_id

String

required
regex : [0-9]+

Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the "id" field in the response).

project_id

String

required
regex : [0-9]+

Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the "id" field in the response).

Body Parameters

Param Name

Data Type

Description

workdrive_folders

JSONArray

max length : 10000
array size : 0-10

Id's of the folder

user_permissions

JSONArray

required
max length : 100000
array size : 0-10

Enter the permission details for the folder.
To get the default folder permission, use the Get Project Team Folder Details

Request Example

cURL
Deluge
Node.js
Ruby
PHP
- Python
- C
- C#
- C++
- Clojure
- Go
- HTTP
- Java
- JS Fetch
- JSON
- Kotlin
- Objective-C
- OCaml
- PowerShell
- R
- Swift

curl -X POST \
'https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/associate' \
-H 'Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa' \
-H 'Content-Type: application/json' \
-d '{"workdrive_folders":[{"id":"4000000062001","is_customized":true}],"user_permissions":[{"add":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"remove":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}]}'

url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/associate";
params = Map();
params.put("workdrive_folders", [{"id":"4000000062001","is_customized":true}]);
params.put("user_permissions", [{"add":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"remove":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}]);
response = invokeUrl
[
    url: url
    type: POST
    parameters: params.toString()
    connection: "projects"
];
info response;

const https = require('https');
const url = new URL('https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/associate');

const payload = JSON.stringify({"workdrive_folders":[{"id":"4000000062001","is_customized":true}],"user_permissions":[{"add":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"remove":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}]});

const options = {
  hostname: url.hostname,
  path: url.pathname + url.search,
  method: 'POST',
  headers: {
    'Authorization': 'Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa',
    'Content-Type': 'application/json',
    'Content-Length': Buffer.byteLength(payload)
  }
};

const req = https.request(options, (res) => {
  let data = '';
  res.on('data', (chunk) => { data += chunk; });
  res.on('end', () => { console.log(JSON.parse(data)); });
});

req.on('error', (err) => { console.error(err); });
req.write(payload);
req.end();

require 'net/http'
require 'uri'
require 'json'

url = URI("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/associate")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
request["Content-Type"] = "application/json"
request.body = '{"workdrive_folders":[{"id":"4000000062001","is_customized":true}],"user_permissions":[{"add":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"remove":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}]}'

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

<?php
$url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/associate";

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => $url,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => '{"workdrive_folders":[{"id":"4000000062001","is_customized":true}],"user_permissions":[{"add":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"remove":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}]}',
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

import requests

url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/associate"

headers = {
    "Authorization": "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa",
    "Content-Type": "application/json",
}

payload = '{"workdrive_folders":[{"id":"4000000062001","is_customized":true}],"user_permissions":[{"add":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"remove":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}]}'

response = requests.post(url, headers=headers, data=payload)

print(response.json())

#include <stdio.h>
#include <string.h>
#include <curl/curl.h>

int main(void) {
    CURL *curl = curl_easy_init();
    if (curl) {
        struct curl_slist *headers = NULL;
        headers = curl_slist_append(headers, "Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");
        headers = curl_slist_append(headers, "Content-Type: application/json");

        curl_easy_setopt(curl, CURLOPT_URL, "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/associate");
        curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
        curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "POST");
        curl_easy_setopt(curl, CURLOPT_POSTFIELDS, "{\"workdrive_folders\":[{\"id\":\"4000000062001\",\"is_customized\":true}],\"user_permissions\":[{\"add\":[{\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}],\"remove\":[{\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}],\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}]}");

        CURLcode res = curl_easy_perform(curl);
        if (res != CURLE_OK)
            fprintf(stderr, "curl failed: %s\n", curl_easy_strerror(res));

        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}

using System.Net.Http;
using System.Text;
using System.Web;

var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");

var request = new HttpRequestMessage(HttpMethod.Post, "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/associate");
request.Content = new StringContent(
    @"{""workdrive_folders"":[{""id"":""4000000062001"",""is_customized"":true}],""user_permissions"":[{""add"":[{""workdrive_role"":""admin"",""users"":[{""zpuid"":""4000000002055""}],""profiles"":[{""id"":""4000000062001""}]}],""remove"":[{""workdrive_role"":""admin"",""users"":[{""zpuid"":""4000000002055""}],""profiles"":[{""id"":""4000000062001""}]}],""workdrive_role"":""admin"",""users"":[{""zpuid"":""4000000002055""}],""profiles"":[{""id"":""4000000062001""}]}]}",
    Encoding.UTF8,
    "application/json"
);

var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

#include <iostream>
#include <string>
#include <curl/curl.h>

static size_t WriteCallback(void* contents, size_t size, size_t nmemb, std::string* output) {
    output->append((char*)contents, size * nmemb);
    return size * nmemb;
}

int main() {
    CURL* curl = curl_easy_init();
    if (curl) {
        std::string response;
        struct curl_slist* headers = NULL;
        headers = curl_slist_append(headers, "Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");
        headers = curl_slist_append(headers, "Content-Type: application/json");

        curl_easy_setopt(curl, CURLOPT_URL, "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/associate");
        curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
        curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "POST");
        curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, WriteCallback);
        curl_easy_setopt(curl, CURLOPT_WRITEDATA, &response);
        curl_easy_setopt(curl, CURLOPT_POSTFIELDS, "{\"workdrive_folders\":[{\"id\":\"4000000062001\",\"is_customized\":true}],\"user_permissions\":[{\"add\":[{\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}],\"remove\":[{\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}],\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}]}");

        CURLcode res = curl_easy_perform(curl);
        if (res == CURLE_OK)
            std::cout << response << std::endl;
        else
            std::cerr << curl_easy_strerror(res) << std::endl;

        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}

(require '[clj-http.client :as client])

(def response
  (client/post "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/associate"
    {:headers {"Authorization" "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
                "Content-Type" "application/json"}
     :body "{\"workdrive_folders\":[{\"id\":\"4000000062001\",\"is_customized\":true}],\"user_permissions\":[{\"add\":[{\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}],\"remove\":[{\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}],\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}]}"
     :as :json}))

(println (:body response))

package main

import (
    "fmt"
    "io"
    "net/http"
    "strings"
)

func main() {
    payload := strings.NewReader("{\"workdrive_folders\":[{\"id\":\"4000000062001\",\"is_customized\":true}],\"user_permissions\":[{\"add\":[{\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}],\"remove\":[{\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}],\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}]}")
    req, _ := http.NewRequest("POST", "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/associate", payload)
    req.Header.Add("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa")
    req.Header.Add("Content-Type", "application/json")

    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}

POST https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/associate HTTP/1.1
Host: https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/associate
Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa
Content-Type: application/json

{"workdrive_folders":[{"id":"4000000062001","is_customized":true}],"user_permissions":[{"add":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"remove":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}]}

HttpClientBuilder httpClientBuilder = HttpClientBuilder.create();

SSLContext sslContext = SSLContext.getDefault();
SSLConnectionSocketFactory sslConnectionSocketFactory = new SSLConnectionSocketFactory(sslContext, NoopHostnameVerifier.INSTANCE);
CloseableHttpClient httpclient = httpClientBuilder.setSSLSocketFactory(sslConnectionSocketFactory).build();

URIBuilder uriBuilder = new URIBuilder("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/associate");
HttpUriRequest requestObj = new HttpPost(uriBuilder.build());
requestObj.addHeader("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");

HttpEntityEnclosingRequestBase requestBase = (HttpEntityEnclosingRequestBase) requestObj;
String requestBody = "{\"workdrive_folders\":[{\"id\":\"4000000062001\",\"is_customized\":true}],\"user_permissions\":[{\"add\":[{\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}],\"remove\":[{\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}],\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}]}";
requestBase.setEntity(new StringEntity(requestBody, HTTP.UTF_8));

HttpResponse response = httpclient.execute(requestObj);

HttpEntity responseEntity = response.getEntity();
Object responseObject = EntityUtils.toString(responseEntity);
String responseString = responseObject.toString();

const url = 'https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/associate';

const options = {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({"workdrive_folders":[{"id":"4000000062001","is_customized":true}],"user_permissions":[{"add":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"remove":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}]})
};

fetch(url, options)
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error(error));

{"workdrive_folders":[{"id":"4000000062001","is_customized":true}],"user_permissions":[{"add":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"remove":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}]}

import java.net.HttpURLConnection
import java.net.URL
import okhttp3.HttpUrl.Companion.toHttpUrl

fun main() {
    val url = URL("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/associate")
    val conn = url.openConnection() as HttpURLConnection
    conn.requestMethod = "POST"
    conn.setRequestProperty("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa")
    conn.setRequestProperty("Content-Type", "application/json")
    conn.doOutput = true
    conn.outputStream.bufferedWriter().use { it.write("""{"workdrive_folders":[{"id":"4000000062001","is_customized":true}],"user_permissions":[{"add":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"remove":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}]}""") }

    val response = conn.inputStream.bufferedReader().readText()
    println(response)
}

NSURL *url = [NSURL URLWithString:@"https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/associate"];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:url];
[request setHTTPMethod:@"POST"];
[request setValue:@"Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa" forHTTPHeaderField:@"Authorization"];
[request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
NSData *body = [@"{\"workdrive_folders\":[{\"id\":\"4000000062001\",\"is_customized\":true}],\"user_permissions\":[{\"add\":[{\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}],\"remove\":[{\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}],\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}]}" dataUsingEncoding:NSUTF8StringEncoding];
[request setHTTPBody:body];

NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *task = [session dataTaskWithRequest:request
    completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
        NSString *result = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];
        NSLog(@"%@", result);
}];
[task resume];

open Lwt
open Cohttp_lwt_unix

let () =
  let uri = Uri.of_string "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/associate" in
  let headers = Cohttp.Header.init ()
    |> fun h -> Cohttp.Header.add h "Authorization" "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
    |> fun h -> Cohttp.Header.add h "Content-Type" "application/json"
  in
  let body = Cohttp_lwt.Body.of_string {json|{"workdrive_folders":[{"id":"4000000062001","is_customized":true}],"user_permissions":[{"add":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"remove":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}]}|json} in
  Lwt_main.run (
    Client.post ~headers ~body uri >>= fun (_, body) ->
    Cohttp_lwt.Body.to_string body >|= fun s ->
    print_endline s)

$headers = @{
    "Authorization" = "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
    "Content-Type" = "application/json"
}

$body = @'
{"workdrive_folders":[{"id":"4000000062001","is_customized":true}],"user_permissions":[{"add":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"remove":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}]}
'@

$response = Invoke-RestMethod -Uri "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/associate" -Method POST -Headers $headers -Body $body

$response | ConvertTo-Json

library(httr)

url <- "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/associate"

response <- POST(
  url,
  add_headers(Authorization = "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"),
  content_type_json(),
  body = "{\"workdrive_folders\":[{\"id\":\"4000000062001\",\"is_customized\":true}],\"user_permissions\":[{\"add\":[{\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}],\"remove\":[{\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}],\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}]}"
)

content(response, "text")

import Foundation

let url = URL(string: "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/associate")!
var request = URLRequest(url: url)
request.httpMethod = "POST"
request.setValue("Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa", forHTTPHeaderField: "Authorization")
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
request.httpBody = """
{"workdrive_folders":[{"id":"4000000062001","is_customized":true}],"user_permissions":[{"add":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"remove":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}]}
""".data(using: .utf8)

let semaphore = DispatchSemaphore(value: 0)
let task = URLSession.shared.dataTask(with: request) { data, response, error in
    if let data = data, let result = String(data: data, encoding: .utf8) {
        print(result)
    }
    semaphore.signal()
}
task.resume()
semaphore.wait()

Sample Input

Content-Type: application/json

{ "workdrive_folders" : [ { "id" : "4000000062001", "is_customized" : true } ], "user_permissions" : [ { "add" : [ { "workdrive_role" : "admin", "users" : [ { "zpuid" : "4000000002055" } ], "profiles" : [ { "id" : "4000000062001" } ] } ], "remove" : [ { "workdrive_role" : "admin", "users" : [ { "zpuid" : "4000000002055" } ], "profiles" : [ { "id" : "4000000062001" } ] } ], "workdrive_role" : "admin", "users" : [ { "zpuid" : "4000000002055" } ], "profiles" : [ { "id" : "4000000062001" } ] } ] }

Sample Response

200{ "folder" : [ { "folder_id" : "225955000000152013", "name" : "Ela - Folder - 11", "workdrive_folder_id" : "pyafyddb17b681eba4719a4f443d272bb55ba", "is_personal_space" : false, "is_folder" : false, "is_default" : false, "is_customized" : false } ] }

Possible Errors

Get Project Folder Settings

Retrieve details of the folder settings from a project.

GET

/api/v3/portal/[PORTAL_ID]/projects/[PROJECT_ID]/documents/folders/[FOLDER_ID]

OAuth Scope:

ZohoProjects.documents.READ, WorkDrive.workspace.ALL,Workdrive.team.ALL,WorkDrive.files.ALL

Path Parameters

Param Name

Data Type

Description

portal_id

String

required
regex : [0-9]+

Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the "id" field in the response).

project_id

String

required
regex : [0-9]+

Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the "id" field in the response).

folder_id

String

required
regex : [0-9]+

Identifier of a folder. Obtained from the Get Folders Details API - the "id" field in the response corresponds to folder_id.

Query Parameters

Param Name

Data Type

Description

id

String

Projects folder or folder Id

Request Example

cURL
Deluge
Node.js
Ruby
PHP
- Python
- C
- C#
- C++
- Clojure
- Go
- HTTP
- Java
- JS Fetch
- JSON
- Kotlin
- Objective-C
- OCaml
- PowerShell
- R
- Swift

curl -X GET \
'https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]?id=4000000062001' \
-H 'Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa'

url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]";
params = Map();
params.put("id", "4000000062001");
response = invokeUrl
[
    url: url
    type: GET
    parameters: params
    connection: "projects"
];
info response;

const https = require('https');
const url = new URL('https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]');
url.searchParams.append('id', '4000000062001');

const options = {
  hostname: url.hostname,
  path: url.pathname + url.search,
  method: 'GET',
  headers: {
    'Authorization': 'Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa'
  }
};

const req = https.request(options, (res) => {
  let data = '';
  res.on('data', (chunk) => { data += chunk; });
  res.on('end', () => { console.log(JSON.parse(data)); });
});

req.on('error', (err) => { console.error(err); });
req.end();

require 'net/http'
require 'uri'
require 'json'

url = URI("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]")
params = {
  "id" => "4000000062001"
}
url.query = URI.encode_www_form(params)

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"

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

<?php
$params = [
    'id' => '4000000062001',
];
$url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]" . "?" . http_build_query($params);

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => $url,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
  ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

import requests

url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]"

params = {
    "id": "4000000062001"
}

headers = {
    "Authorization": "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa",
}

response = requests.get(url, headers=headers, params=params)

print(response.json())

#include <stdio.h>
#include <string.h>
#include <curl/curl.h>

int main(void) {
    CURL *curl = curl_easy_init();
    if (curl) {
        char *enc_id = curl_easy_escape(curl, "4000000062001", 0);
        char url[2048];
        snprintf(url, sizeof(url), "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]?id=%s", enc_id);

        struct curl_slist *headers = NULL;
        headers = curl_slist_append(headers, "Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");

        curl_easy_setopt(curl, CURLOPT_URL, url);
        curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
        curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "GET");

        CURLcode res = curl_easy_perform(curl);
        if (res != CURLE_OK)
            fprintf(stderr, "curl failed: %s\n", curl_easy_strerror(res));

        curl_free(enc_id);
        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}

using System.Net.Http;
using System.Text;
using System.Web;

var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");

var query = HttpUtility.ParseQueryString(string.Empty);
query["id"] = "4000000062001";
var uriBuilder = new UriBuilder("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]") { Query = query.ToString() };
var request = new HttpRequestMessage(HttpMethod.Get, uriBuilder.Uri);

var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

#include <iostream>
#include <string>
#include <curl/curl.h>

static size_t WriteCallback(void* contents, size_t size, size_t nmemb, std::string* output) {
    output->append((char*)contents, size * nmemb);
    return size * nmemb;
}

int main() {
    CURL* curl = curl_easy_init();
    if (curl) {
        std::string response;
        char* enc_id = curl_easy_escape(curl, "4000000062001", 0);
        std::string url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]";
        url += "?id=" + std::string(enc_id);

        struct curl_slist* headers = NULL;
        headers = curl_slist_append(headers, "Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");

        curl_easy_setopt(curl, CURLOPT_URL, url.c_str());
        curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
        curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "GET");
        curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, WriteCallback);
        curl_easy_setopt(curl, CURLOPT_WRITEDATA, &response);

        CURLcode res = curl_easy_perform(curl);
        if (res == CURLE_OK)
            std::cout << response << std::endl;
        else
            std::cerr << curl_easy_strerror(res) << std::endl;

        curl_free(enc_id);
        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}

(require '[clj-http.client :as client])

(let [enc-id (java.net.URLEncoder/encode "4000000062001" "UTF-8")
      url (str "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]" "?id=" enc-id)]
(def response
  (client/get url
    {:headers {"Authorization" "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"}
     :as :json}))

(println (:body response))

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    req, _ := http.NewRequest("GET", "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]", nil)
    q := req.URL.Query()
    q.Add("id", "4000000062001")
    req.URL.RawQuery = q.Encode()
    req.Header.Add("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa")

    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}

GET https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]?id=4000000062001 HTTP/1.1
Host: https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]?id=4000000062001
Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa

HttpClientBuilder httpClientBuilder = HttpClientBuilder.create();

SSLContext sslContext = SSLContext.getDefault();
SSLConnectionSocketFactory sslConnectionSocketFactory = new SSLConnectionSocketFactory(sslContext, NoopHostnameVerifier.INSTANCE);
CloseableHttpClient httpclient = httpClientBuilder.setSSLSocketFactory(sslConnectionSocketFactory).build();

URIBuilder uriBuilder = new URIBuilder("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]");
uriBuilder.addParameter("id", "4000000062001");
HttpUriRequest requestObj = new HttpGet(uriBuilder.build());
requestObj.addHeader("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");

HttpResponse response = httpclient.execute(requestObj);

HttpEntity responseEntity = response.getEntity();
Object responseObject = EntityUtils.toString(responseEntity);
String responseString = responseObject.toString();

const url = 'https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]';

const params = new URLSearchParams({
  'id': '4000000062001'
});

const options = {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa'
  }
};

fetch(url + '?' + params.toString(), options)
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error(error));

id = "4000000062001"

import java.net.HttpURLConnection
import java.net.URL
import okhttp3.HttpUrl.Companion.toHttpUrl

fun main() {
    val urlBuilder = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]".toHttpUrl().newBuilder()
    urlBuilder.addQueryParameter("id", "4000000062001")
    val url = URL(urlBuilder.build().toString())
    val conn = url.openConnection() as HttpURLConnection
    conn.requestMethod = "GET"
    conn.setRequestProperty("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa")

    val response = conn.inputStream.bufferedReader().readText()
    println(response)
}

NSString *encodedId = [@"4000000062001" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *urlString = [NSString stringWithFormat:@"https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]?id=%@", encodedId];
NSURL *url = [NSURL URLWithString:urlString];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:url];
[request setHTTPMethod:@"GET"];
[request setValue:@"Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa" forHTTPHeaderField:@"Authorization"];

NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *task = [session dataTaskWithRequest:request
    completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
        NSString *result = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];
        NSLog(@"%@", result);
}];
[task resume];

open Lwt
open Cohttp_lwt_unix

let () =
  let enc_id = Uri.pct_encode "4000000062001" in
  let uri = Uri.of_string ("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]" ^ "?id=" ^ enc_id) in
  let headers = Cohttp.Header.init ()
    |> fun h -> Cohttp.Header.add h "Authorization" "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
  in
  Lwt_main.run (
    Client.get ~headers uri >>= fun (_, body) ->
    Cohttp_lwt.Body.to_string body >|= fun s ->
    print_endline s)

$headers = @{
    "Authorization" = "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
}

$params = @{
    id = "4000000062001"
}
$queryString = ($params.GetEnumerator() | ForEach-Object { "$($_.Key)=$([System.Uri]::EscapeDataString($_.Value))" }) -join "&"
$url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]" + "?" + $queryString

$response = Invoke-RestMethod -Uri $url -Method GET -Headers $headers

$response | ConvertTo-Json

library(httr)

url <- "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]"

params <- list(
  id = "4000000062001"
)

response <- GET(
  url,
  add_headers(Authorization = "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"),
  query = params
)

content(response, "text")

import Foundation

var components = URLComponents(string: "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]")!
components.queryItems = [
    URLQueryItem(name: "id", value: "4000000062001")
]
let url = components.url!
var request = URLRequest(url: url)
request.httpMethod = "GET"
request.setValue("Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa", forHTTPHeaderField: "Authorization")

let semaphore = DispatchSemaphore(value: 0)
let task = URLSession.shared.dataTask(with: request) { data, response, error in
    if let data = data, let result = String(data: data, encoding: .utf8) {
        print(result)
    }
    semaphore.signal()
}
task.resume()
semaphore.wait()

Sample Input

id : "4000000062001"

Sample Response

200{ "team_id" : "jurc891805595454c4ce8ae18933ff6cc77dc", "name" : "Ela - Folder - 11", "description" : "", "workdrive_folder_id" : "pyafyddb17b681eba4719a4f443d272bb55ba", "folder_id" : "225955000000152013", "user_permissions" : [ [ { "workdrive_role" : "editor", "profiles" : [ { "id" : "225955000000069452", "name" : "Employee" } ] }, { "workdrive_role" : "organizer", "profiles" : [ { "id" : "225955000000069449", "name" : "Manager" }, { "id" : "225955000000134013", "name" : "Custom Profile" }, { "id" : "225955000000069446", "name" : "jointadmin" } ] }, { "workdrive_role" : "commenter", "profiles" : [ { "id" : "225955000000069455", "name" : "Contractor" } ] } ] ] }

Possible Errors

Update Project Folder Details

Modify folder settings in a project.

PATCH

/api/v3/portal/[PORTAL_ID]/projects/[PROJECT_ID]/documents/folders/[FOLDER_ID]

OAuth Scope:

ZohoProjects.documents.UPDATE, WorkDrive.workspace.ALL,Workdrive.team.ALL,WorkDrive.files.ALL

Path Parameters

Param Name

Data Type

Description

portal_id

String

required
regex : [0-9]+

Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the "id" field in the response).

project_id

String

required
regex : [0-9]+

Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the "id" field in the response).

folder_id

String

required
regex : [0-9]+

Identifier of a folder. Obtained from the Get Folders Details API - the "id" field in the response corresponds to folder_id.

Body Parameters

Param Name

Data Type

Description

user_permissions

JSONArray

required
max length : 100000
array size : 0-10

Enter the permission details for the folder.
To get the default folder permission, use the Get Project Team Folder Details

Request Example

cURL
Deluge
Node.js
Ruby
PHP
- Python
- C
- C#
- C++
- Clojure
- Go
- HTTP
- Java
- JS Fetch
- JSON
- Kotlin
- Objective-C
- OCaml
- PowerShell
- R
- Swift

curl -X PATCH \
'https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]' \
-H 'Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa' \
-H 'Content-Type: application/json' \
-d '{"user_permissions":[{"add":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"remove":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}]}'

url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]";
params = Map();
params.put("user_permissions", [{"add":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"remove":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}]);
response = invokeUrl
[
    url: url
    type: PATCH
    parameters: params.toString()
    connection: "projects"
];
info response;

const https = require('https');
const url = new URL('https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]');

const payload = JSON.stringify({"user_permissions":[{"add":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"remove":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}]});

const options = {
  hostname: url.hostname,
  path: url.pathname + url.search,
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa',
    'Content-Type': 'application/json',
    'Content-Length': Buffer.byteLength(payload)
  }
};

const req = https.request(options, (res) => {
  let data = '';
  res.on('data', (chunk) => { data += chunk; });
  res.on('end', () => { console.log(JSON.parse(data)); });
});

req.on('error', (err) => { console.error(err); });
req.write(payload);
req.end();

require 'net/http'
require 'uri'
require 'json'

url = URI("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
request["Content-Type"] = "application/json"
request.body = '{"user_permissions":[{"add":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"remove":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}]}'

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

<?php
$url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]";

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => $url,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => '{"user_permissions":[{"add":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"remove":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}]}',
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

import requests

url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]"

headers = {
    "Authorization": "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa",
    "Content-Type": "application/json",
}

payload = '{"user_permissions":[{"add":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"remove":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}]}'

response = requests.patch(url, headers=headers, data=payload)

print(response.json())

#include <stdio.h>
#include <string.h>
#include <curl/curl.h>

int main(void) {
    CURL *curl = curl_easy_init();
    if (curl) {
        struct curl_slist *headers = NULL;
        headers = curl_slist_append(headers, "Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");
        headers = curl_slist_append(headers, "Content-Type: application/json");

        curl_easy_setopt(curl, CURLOPT_URL, "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]");
        curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
        curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "PATCH");
        curl_easy_setopt(curl, CURLOPT_POSTFIELDS, "{\"user_permissions\":[{\"add\":[{\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}],\"remove\":[{\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}],\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}]}");

        CURLcode res = curl_easy_perform(curl);
        if (res != CURLE_OK)
            fprintf(stderr, "curl failed: %s\n", curl_easy_strerror(res));

        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}

using System.Net.Http;
using System.Text;
using System.Web;

var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");

var request = new HttpRequestMessage(HttpMethod.Patch, "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]");
request.Content = new StringContent(
    @"{""user_permissions"":[{""add"":[{""workdrive_role"":""admin"",""users"":[{""zpuid"":""4000000002055""}],""profiles"":[{""id"":""4000000062001""}]}],""remove"":[{""workdrive_role"":""admin"",""users"":[{""zpuid"":""4000000002055""}],""profiles"":[{""id"":""4000000062001""}]}],""workdrive_role"":""admin"",""users"":[{""zpuid"":""4000000002055""}],""profiles"":[{""id"":""4000000062001""}]}]}",
    Encoding.UTF8,
    "application/json"
);

var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

#include <iostream>
#include <string>
#include <curl/curl.h>

static size_t WriteCallback(void* contents, size_t size, size_t nmemb, std::string* output) {
    output->append((char*)contents, size * nmemb);
    return size * nmemb;
}

int main() {
    CURL* curl = curl_easy_init();
    if (curl) {
        std::string response;
        struct curl_slist* headers = NULL;
        headers = curl_slist_append(headers, "Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");
        headers = curl_slist_append(headers, "Content-Type: application/json");

        curl_easy_setopt(curl, CURLOPT_URL, "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]");
        curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
        curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "PATCH");
        curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, WriteCallback);
        curl_easy_setopt(curl, CURLOPT_WRITEDATA, &response);
        curl_easy_setopt(curl, CURLOPT_POSTFIELDS, "{\"user_permissions\":[{\"add\":[{\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}],\"remove\":[{\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}],\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}]}");

        CURLcode res = curl_easy_perform(curl);
        if (res == CURLE_OK)
            std::cout << response << std::endl;
        else
            std::cerr << curl_easy_strerror(res) << std::endl;

        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}

(require '[clj-http.client :as client])

(def response
  (client/patch "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]"
    {:headers {"Authorization" "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
                "Content-Type" "application/json"}
     :body "{\"user_permissions\":[{\"add\":[{\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}],\"remove\":[{\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}],\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}]}"
     :as :json}))

(println (:body response))

package main

import (
    "fmt"
    "io"
    "net/http"
    "strings"
)

func main() {
    payload := strings.NewReader("{\"user_permissions\":[{\"add\":[{\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}],\"remove\":[{\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}],\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}]}")
    req, _ := http.NewRequest("PATCH", "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]", payload)
    req.Header.Add("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa")
    req.Header.Add("Content-Type", "application/json")

    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}

PATCH https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID] HTTP/1.1
Host: https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]
Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa
Content-Type: application/json

{"user_permissions":[{"add":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"remove":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}]}

HttpClientBuilder httpClientBuilder = HttpClientBuilder.create();

SSLContext sslContext = SSLContext.getDefault();
SSLConnectionSocketFactory sslConnectionSocketFactory = new SSLConnectionSocketFactory(sslContext, NoopHostnameVerifier.INSTANCE);
CloseableHttpClient httpclient = httpClientBuilder.setSSLSocketFactory(sslConnectionSocketFactory).build();

URIBuilder uriBuilder = new URIBuilder("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]");
HttpUriRequest requestObj = new HttpPatch(uriBuilder.build());
requestObj.addHeader("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");

HttpEntityEnclosingRequestBase requestBase = (HttpEntityEnclosingRequestBase) requestObj;
String requestBody = "{\"user_permissions\":[{\"add\":[{\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}],\"remove\":[{\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}],\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}]}";
requestBase.setEntity(new StringEntity(requestBody, HTTP.UTF_8));

HttpResponse response = httpclient.execute(requestObj);

HttpEntity responseEntity = response.getEntity();
Object responseObject = EntityUtils.toString(responseEntity);
String responseString = responseObject.toString();

const url = 'https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]';

const options = {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({"user_permissions":[{"add":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"remove":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}]})
};

fetch(url, options)
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error(error));

{"user_permissions":[{"add":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"remove":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}]}

import java.net.HttpURLConnection
import java.net.URL
import okhttp3.HttpUrl.Companion.toHttpUrl

fun main() {
    val url = URL("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]")
    val conn = url.openConnection() as HttpURLConnection
    conn.requestMethod = "PATCH"
    conn.setRequestProperty("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa")
    conn.setRequestProperty("Content-Type", "application/json")
    conn.doOutput = true
    conn.outputStream.bufferedWriter().use { it.write("""{"user_permissions":[{"add":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"remove":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}]}""") }

    val response = conn.inputStream.bufferedReader().readText()
    println(response)
}

NSURL *url = [NSURL URLWithString:@"https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]"];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:url];
[request setHTTPMethod:@"PATCH"];
[request setValue:@"Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa" forHTTPHeaderField:@"Authorization"];
[request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
NSData *body = [@"{\"user_permissions\":[{\"add\":[{\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}],\"remove\":[{\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}],\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}]}" dataUsingEncoding:NSUTF8StringEncoding];
[request setHTTPBody:body];

NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *task = [session dataTaskWithRequest:request
    completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
        NSString *result = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];
        NSLog(@"%@", result);
}];
[task resume];

open Lwt
open Cohttp_lwt_unix

let () =
  let uri = Uri.of_string "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]" in
  let headers = Cohttp.Header.init ()
    |> fun h -> Cohttp.Header.add h "Authorization" "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
    |> fun h -> Cohttp.Header.add h "Content-Type" "application/json"
  in
  let body = Cohttp_lwt.Body.of_string {json|{"user_permissions":[{"add":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"remove":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}]}|json} in
  Lwt_main.run (
    Client.patch ~headers ~body uri >>= fun (_, body) ->
    Cohttp_lwt.Body.to_string body >|= fun s ->
    print_endline s)

$headers = @{
    "Authorization" = "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
    "Content-Type" = "application/json"
}

$body = @'
{"user_permissions":[{"add":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"remove":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}]}
'@

$response = Invoke-RestMethod -Uri "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]" -Method PATCH -Headers $headers -Body $body

$response | ConvertTo-Json

library(httr)

url <- "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]"

response <- PATCH(
  url,
  add_headers(Authorization = "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"),
  content_type_json(),
  body = "{\"user_permissions\":[{\"add\":[{\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}],\"remove\":[{\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}],\"workdrive_role\":\"admin\",\"users\":[{\"zpuid\":\"4000000002055\"}],\"profiles\":[{\"id\":\"4000000062001\"}]}]}"
)

content(response, "text")

import Foundation

let url = URL(string: "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]")!
var request = URLRequest(url: url)
request.httpMethod = "PATCH"
request.setValue("Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa", forHTTPHeaderField: "Authorization")
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
request.httpBody = """
{"user_permissions":[{"add":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"remove":[{"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}],"workdrive_role":"admin","users":[{"zpuid":"4000000002055"}],"profiles":[{"id":"4000000062001"}]}]}
""".data(using: .utf8)

let semaphore = DispatchSemaphore(value: 0)
let task = URLSession.shared.dataTask(with: request) { data, response, error in
    if let data = data, let result = String(data: data, encoding: .utf8) {
        print(result)
    }
    semaphore.signal()
}
task.resume()
semaphore.wait()

Sample Input

Content-Type: application/json

{ "user_permissions" : [ { "add" : [ { "workdrive_role" : "admin", "users" : [ { "zpuid" : "4000000002055" } ], "profiles" : [ { "id" : "4000000062001" } ] } ], "remove" : [ { "workdrive_role" : "admin", "users" : [ { "zpuid" : "4000000002055" } ], "profiles" : [ { "id" : "4000000062001" } ] } ], "workdrive_role" : "admin", "users" : [ { "zpuid" : "4000000002055" } ], "profiles" : [ { "id" : "4000000062001" } ] } ] }

Sample Response

204 No Content

Possible Errors

Disassociate Folder(s)

Disassociate folder(s) from a project.

DELETE

/api/v3/portal/[PORTAL_ID]/projects/[PROJECT_ID]/documents/folders/[FOLDER_ID]/disassociate

OAuth Scope:

ZohoProjects.documents.DELETE, WorkDrive.workspace.ALL,Workdrive.team.ALL,WorkDrive.files.ALL

Path Parameters

Param Name

Data Type

Description

portal_id

String

required
regex : [0-9]+

Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the "id" field in the response).

project_id

String

required
regex : [0-9]+

Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the "id" field in the response).

folder_id

String

required
regex : [0-9]+

Identifier of a folder. Obtained from the Get Folders Details API - the "id" field in the response corresponds to folder_id.

Request Example

cURL
Deluge
Node.js
Ruby
PHP
- Python
- C
- C#
- C++
- Clojure
- Go
- HTTP
- Java
- JS Fetch
- Kotlin
- Objective-C
- OCaml
- PowerShell
- R
- Swift

curl -X DELETE \
'https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]/disassociate' \
-H 'Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa'

url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]/disassociate";
response = invokeUrl
[
    url: url
    type: DELETE
    connection: "projects"
];
info response;

const https = require('https');
const url = new URL('https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]/disassociate');

const options = {
  hostname: url.hostname,
  path: url.pathname + url.search,
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa'
  }
};

const req = https.request(options, (res) => {
  let data = '';
  res.on('data', (chunk) => { data += chunk; });
  res.on('end', () => { console.log(JSON.parse(data)); });
});

req.on('error', (err) => { console.error(err); });
req.end();

require 'net/http'
require 'uri'
require 'json'

url = URI("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]/disassociate")

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

request = Net::HTTP::Delete.new(url)
request["Authorization"] = "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"

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

<?php
$url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]/disassociate";

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => $url,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
  ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

import requests

url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]/disassociate"

headers = {
    "Authorization": "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa",
}

response = requests.delete(url, headers=headers)

print(response.json())

#include <stdio.h>
#include <string.h>
#include <curl/curl.h>

int main(void) {
    CURL *curl = curl_easy_init();
    if (curl) {
        struct curl_slist *headers = NULL;
        headers = curl_slist_append(headers, "Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");

        curl_easy_setopt(curl, CURLOPT_URL, "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]/disassociate");
        curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
        curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "DELETE");

        CURLcode res = curl_easy_perform(curl);
        if (res != CURLE_OK)
            fprintf(stderr, "curl failed: %s\n", curl_easy_strerror(res));

        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}

using System.Net.Http;
using System.Text;
using System.Web;

var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");

var request = new HttpRequestMessage(HttpMethod.Delete, "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]/disassociate");

var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

#include <iostream>
#include <string>
#include <curl/curl.h>

static size_t WriteCallback(void* contents, size_t size, size_t nmemb, std::string* output) {
    output->append((char*)contents, size * nmemb);
    return size * nmemb;
}

int main() {
    CURL* curl = curl_easy_init();
    if (curl) {
        std::string response;
        struct curl_slist* headers = NULL;
        headers = curl_slist_append(headers, "Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");

        curl_easy_setopt(curl, CURLOPT_URL, "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]/disassociate");
        curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
        curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "DELETE");
        curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, WriteCallback);
        curl_easy_setopt(curl, CURLOPT_WRITEDATA, &response);

        CURLcode res = curl_easy_perform(curl);
        if (res == CURLE_OK)
            std::cout << response << std::endl;
        else
            std::cerr << curl_easy_strerror(res) << std::endl;

        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}

(require '[clj-http.client :as client])

(def response
  (client/delete "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]/disassociate"
    {:headers {"Authorization" "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"}
     :as :json}))

(println (:body response))

package main

import (
    "fmt"
    "io"
    "net/http"
)

func main() {
    req, _ := http.NewRequest("DELETE", "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]/disassociate", nil)
    req.Header.Add("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa")

    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}

DELETE https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]/disassociate HTTP/1.1
Host: https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]/disassociate
Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa

HttpClientBuilder httpClientBuilder = HttpClientBuilder.create();

SSLContext sslContext = SSLContext.getDefault();
SSLConnectionSocketFactory sslConnectionSocketFactory = new SSLConnectionSocketFactory(sslContext, NoopHostnameVerifier.INSTANCE);
CloseableHttpClient httpclient = httpClientBuilder.setSSLSocketFactory(sslConnectionSocketFactory).build();

URIBuilder uriBuilder = new URIBuilder("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]/disassociate");
HttpUriRequest requestObj = new HttpDelete(uriBuilder.build());
requestObj.addHeader("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");

HttpResponse response = httpclient.execute(requestObj);

HttpEntity responseEntity = response.getEntity();
Object responseObject = EntityUtils.toString(responseEntity);
String responseString = responseObject.toString();

const url = 'https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]/disassociate';

const options = {
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa'
  }
};

fetch(url, options)
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error(error));

import java.net.HttpURLConnection
import java.net.URL
import okhttp3.HttpUrl.Companion.toHttpUrl

fun main() {
    val url = URL("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]/disassociate")
    val conn = url.openConnection() as HttpURLConnection
    conn.requestMethod = "DELETE"
    conn.setRequestProperty("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa")

    val response = conn.inputStream.bufferedReader().readText()
    println(response)
}

NSURL *url = [NSURL URLWithString:@"https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]/disassociate"];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:url];
[request setHTTPMethod:@"DELETE"];
[request setValue:@"Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa" forHTTPHeaderField:@"Authorization"];

NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *task = [session dataTaskWithRequest:request
    completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
        NSString *result = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];
        NSLog(@"%@", result);
}];
[task resume];

open Lwt
open Cohttp_lwt_unix

let () =
  let uri = Uri.of_string "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]/disassociate" in
  let headers = Cohttp.Header.init ()
    |> fun h -> Cohttp.Header.add h "Authorization" "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
  in
  Lwt_main.run (
    Client.delete ~headers uri >>= fun (_, body) ->
    Cohttp_lwt.Body.to_string body >|= fun s ->
    print_endline s)

$headers = @{
    "Authorization" = "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
}

$response = Invoke-RestMethod -Uri "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]/disassociate" -Method DELETE -Headers $headers

$response | ConvertTo-Json

library(httr)

url <- "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]/disassociate"

response <- DELETE(
  url,
  add_headers(Authorization = "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa")
)

content(response, "text")

import Foundation

let url = URL(string: "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]/disassociate")!
var request = URLRequest(url: url)
request.httpMethod = "DELETE"
request.setValue("Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa", forHTTPHeaderField: "Authorization")

let semaphore = DispatchSemaphore(value: 0)
let task = URLSession.shared.dataTask(with: request) { data, response, error in
    if let data = data, let result = String(data: data, encoding: .utf8) {
        print(result)
    }
    semaphore.signal()
}
task.resume()
semaphore.wait()

Sample Response

204 No Content{ "status" : "success" }

Possible Errors

Delete a Folder

DELETE

/api/v3/portal/[PORTAL_ID]/projects/[PROJECT_ID]/documents/folders/[FOLDER_ID]

OAuth Scope:

ZohoProjects.documents.DELETE

Path Parameters

Param Name

Data Type

Description

portal_id

String

required
regex : [0-9]+

Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the "id" field in the response).

project_id

String

required
regex : [0-9]+

Unique, immutable identifier of the project within the specified portal. You can obtain it from the Get Projects API (the "id" field in the response).

folder_id

String

required
regex : [0-9]+

Identifier of a folder. Obtained from the Get Folders Details API - the "id" field in the response corresponds to folder_id.

Request Example

cURL
Deluge
Node.js
Ruby
PHP
- Python
- C
- C#
- C++
- Clojure
- Go
- HTTP
- Java
- JS Fetch
- Kotlin
- Objective-C
- OCaml
- PowerShell
- R
- Swift

curl -X DELETE \
'https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]' \
-H 'Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa'

url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]";
response = invokeUrl
[
    url: url
    type: DELETE
    connection: "projects"
];
info response;

const https = require('https');
const url = new URL('https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]');

const options = {
  hostname: url.hostname,
  path: url.pathname + url.search,
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa'
  }
};

const req = https.request(options, (res) => {
  let data = '';
  res.on('data', (chunk) => { data += chunk; });
  res.on('end', () => { console.log(JSON.parse(data)); });
});

req.on('error', (err) => { console.error(err); });
req.end();

require 'net/http'
require 'uri'
require 'json'

url = URI("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]")

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

request = Net::HTTP::Delete.new(url)
request["Authorization"] = "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"

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

<?php
$url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]";

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => $url,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
  ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

import requests

url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]"

headers = {
    "Authorization": "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa",
}

response = requests.delete(url, headers=headers)

print(response.json())

#include <stdio.h>
#include <string.h>
#include <curl/curl.h>

int main(void) {
    CURL *curl = curl_easy_init();
    if (curl) {
        struct curl_slist *headers = NULL;
        headers = curl_slist_append(headers, "Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");

        curl_easy_setopt(curl, CURLOPT_URL, "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]");
        curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
        curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "DELETE");

        CURLcode res = curl_easy_perform(curl);
        if (res != CURLE_OK)
            fprintf(stderr, "curl failed: %s\n", curl_easy_strerror(res));

        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}

using System.Net.Http;
using System.Text;
using System.Web;

var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");

var request = new HttpRequestMessage(HttpMethod.Delete, "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]");

var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

#include <iostream>
#include <string>
#include <curl/curl.h>

static size_t WriteCallback(void* contents, size_t size, size_t nmemb, std::string* output) {
    output->append((char*)contents, size * nmemb);
    return size * nmemb;
}

int main() {
    CURL* curl = curl_easy_init();
    if (curl) {
        std::string response;
        struct curl_slist* headers = NULL;
        headers = curl_slist_append(headers, "Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");

        curl_easy_setopt(curl, CURLOPT_URL, "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]");
        curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
        curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "DELETE");
        curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, WriteCallback);
        curl_easy_setopt(curl, CURLOPT_WRITEDATA, &response);

        CURLcode res = curl_easy_perform(curl);
        if (res == CURLE_OK)
            std::cout << response << std::endl;
        else
            std::cerr << curl_easy_strerror(res) << std::endl;

        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}

(require '[clj-http.client :as client])

(def response
  (client/delete "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]"
    {:headers {"Authorization" "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"}
     :as :json}))

(println (:body response))

package main

import (
    "fmt"
    "io"
    "net/http"
)

func main() {
    req, _ := http.NewRequest("DELETE", "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]", nil)
    req.Header.Add("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa")

    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}

DELETE https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID] HTTP/1.1
Host: https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]
Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa

HttpClientBuilder httpClientBuilder = HttpClientBuilder.create();

SSLContext sslContext = SSLContext.getDefault();
SSLConnectionSocketFactory sslConnectionSocketFactory = new SSLConnectionSocketFactory(sslContext, NoopHostnameVerifier.INSTANCE);
CloseableHttpClient httpclient = httpClientBuilder.setSSLSocketFactory(sslConnectionSocketFactory).build();

URIBuilder uriBuilder = new URIBuilder("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]");
HttpUriRequest requestObj = new HttpDelete(uriBuilder.build());
requestObj.addHeader("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");

HttpResponse response = httpclient.execute(requestObj);

HttpEntity responseEntity = response.getEntity();
Object responseObject = EntityUtils.toString(responseEntity);
String responseString = responseObject.toString();

const url = 'https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]';

const options = {
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa'
  }
};

fetch(url, options)
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error(error));

import java.net.HttpURLConnection
import java.net.URL
import okhttp3.HttpUrl.Companion.toHttpUrl

fun main() {
    val url = URL("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]")
    val conn = url.openConnection() as HttpURLConnection
    conn.requestMethod = "DELETE"
    conn.setRequestProperty("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa")

    val response = conn.inputStream.bufferedReader().readText()
    println(response)
}

NSURL *url = [NSURL URLWithString:@"https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]"];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:url];
[request setHTTPMethod:@"DELETE"];
[request setValue:@"Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa" forHTTPHeaderField:@"Authorization"];

NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *task = [session dataTaskWithRequest:request
    completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
        NSString *result = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];
        NSLog(@"%@", result);
}];
[task resume];

open Lwt
open Cohttp_lwt_unix

let () =
  let uri = Uri.of_string "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]" in
  let headers = Cohttp.Header.init ()
    |> fun h -> Cohttp.Header.add h "Authorization" "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
  in
  Lwt_main.run (
    Client.delete ~headers uri >>= fun (_, body) ->
    Cohttp_lwt.Body.to_string body >|= fun s ->
    print_endline s)

$headers = @{
    "Authorization" = "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
}

$response = Invoke-RestMethod -Uri "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]" -Method DELETE -Headers $headers

$response | ConvertTo-Json

library(httr)

url <- "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]"

response <- DELETE(
  url,
  add_headers(Authorization = "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa")
)

content(response, "text")

import Foundation

let url = URL(string: "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/projects/23806000097545166/documents/folders/[FOLDER_ID]")!
var request = URLRequest(url: url)
request.httpMethod = "DELETE"
request.setValue("Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa", forHTTPHeaderField: "Authorization")

let semaphore = DispatchSemaphore(value: 0)
let task = URLSession.shared.dataTask(with: request) { data, response, error in
    if let data = data, let result = String(data: data, encoding: .utf8) {
        print(result)
    }
    semaphore.signal()
}
task.resume()
semaphore.wait()

Sample Response

204 No Content{ "status" : "success" }

Get Folders Details

GET

/api/v3/portal/[PORTAL_ID]/folder

OAuth Scope:

ZohoProjects.documents.READ

Path Parameters

Param Name

Data Type

Description

portal_id

String

required
regex : [0-9]+

Unique, immutable identifier of the portal in Zoho Projects. You can obtain it from the Get Portals API (the "id" field in the response).

Query Parameters

Param Name

Data Type

Description

module_name

String

Module Name

Request Example

cURL
Deluge
Node.js
Ruby
PHP
- Python
- C
- C#
- C++
- Clojure
- Go
- HTTP
- Java
- JS Fetch
- JSON
- Kotlin
- Objective-C
- OCaml
- PowerShell
- R
- Swift

curl -X GET \
'https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/folder?module_name=task' \
-H 'Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa'

url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/folder";
params = Map();
params.put("module_name", "task");
response = invokeUrl
[
    url: url
    type: GET
    parameters: params
    connection: "projects"
];
info response;

const https = require('https');
const url = new URL('https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/folder');
url.searchParams.append('module_name', 'task');

const options = {
  hostname: url.hostname,
  path: url.pathname + url.search,
  method: 'GET',
  headers: {
    'Authorization': 'Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa'
  }
};

const req = https.request(options, (res) => {
  let data = '';
  res.on('data', (chunk) => { data += chunk; });
  res.on('end', () => { console.log(JSON.parse(data)); });
});

req.on('error', (err) => { console.error(err); });
req.end();

require 'net/http'
require 'uri'
require 'json'

url = URI("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/folder")
params = {
  "module_name" => "task"
}
url.query = URI.encode_www_form(params)

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"

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

<?php
$params = [
    'module_name' => 'task',
];
$url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/folder" . "?" . http_build_query($params);

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => $url,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
  ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

import requests

url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/folder"

params = {
    "module_name": "task"
}

headers = {
    "Authorization": "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa",
}

response = requests.get(url, headers=headers, params=params)

print(response.json())

#include <stdio.h>
#include <string.h>
#include <curl/curl.h>

int main(void) {
    CURL *curl = curl_easy_init();
    if (curl) {
        char *enc_module_name = curl_easy_escape(curl, "task", 0);
        char url[2048];
        snprintf(url, sizeof(url), "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/folder?module_name=%s", enc_module_name);

        struct curl_slist *headers = NULL;
        headers = curl_slist_append(headers, "Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");

        curl_easy_setopt(curl, CURLOPT_URL, url);
        curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
        curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "GET");

        CURLcode res = curl_easy_perform(curl);
        if (res != CURLE_OK)
            fprintf(stderr, "curl failed: %s\n", curl_easy_strerror(res));

        curl_free(enc_module_name);
        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}

using System.Net.Http;
using System.Text;
using System.Web;

var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");

var query = HttpUtility.ParseQueryString(string.Empty);
query["module_name"] = "task";
var uriBuilder = new UriBuilder("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/folder") { Query = query.ToString() };
var request = new HttpRequestMessage(HttpMethod.Get, uriBuilder.Uri);

var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

#include <iostream>
#include <string>
#include <curl/curl.h>

static size_t WriteCallback(void* contents, size_t size, size_t nmemb, std::string* output) {
    output->append((char*)contents, size * nmemb);
    return size * nmemb;
}

int main() {
    CURL* curl = curl_easy_init();
    if (curl) {
        std::string response;
        char* enc_module_name = curl_easy_escape(curl, "task", 0);
        std::string url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/folder";
        url += "?module_name=" + std::string(enc_module_name);

        struct curl_slist* headers = NULL;
        headers = curl_slist_append(headers, "Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");

        curl_easy_setopt(curl, CURLOPT_URL, url.c_str());
        curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
        curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "GET");
        curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, WriteCallback);
        curl_easy_setopt(curl, CURLOPT_WRITEDATA, &response);

        CURLcode res = curl_easy_perform(curl);
        if (res == CURLE_OK)
            std::cout << response << std::endl;
        else
            std::cerr << curl_easy_strerror(res) << std::endl;

        curl_free(enc_module_name);
        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}

(require '[clj-http.client :as client])

(let [enc-module_name (java.net.URLEncoder/encode "task" "UTF-8")
      url (str "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/folder" "?module_name=" enc-module_name)]
(def response
  (client/get url
    {:headers {"Authorization" "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"}
     :as :json}))

(println (:body response))

package main

import (
    "fmt"
    "io"
    "net/http"
    "net/url"
)

func main() {
    req, _ := http.NewRequest("GET", "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/folder", nil)
    q := req.URL.Query()
    q.Add("module_name", "task")
    req.URL.RawQuery = q.Encode()
    req.Header.Add("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa")

    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}

GET https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/folder?module_name=task HTTP/1.1
Host: https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/folder?module_name=task
Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa

HttpClientBuilder httpClientBuilder = HttpClientBuilder.create();

SSLContext sslContext = SSLContext.getDefault();
SSLConnectionSocketFactory sslConnectionSocketFactory = new SSLConnectionSocketFactory(sslContext, NoopHostnameVerifier.INSTANCE);
CloseableHttpClient httpclient = httpClientBuilder.setSSLSocketFactory(sslConnectionSocketFactory).build();

URIBuilder uriBuilder = new URIBuilder("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/folder");
uriBuilder.addParameter("module_name", "task");
HttpUriRequest requestObj = new HttpGet(uriBuilder.build());
requestObj.addHeader("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");

HttpResponse response = httpclient.execute(requestObj);

HttpEntity responseEntity = response.getEntity();
Object responseObject = EntityUtils.toString(responseEntity);
String responseString = responseObject.toString();

const url = 'https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/folder';

const params = new URLSearchParams({
  'module_name': 'task'
});

const options = {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa'
  }
};

fetch(url + '?' + params.toString(), options)
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error(error));

module_name = "task"

import java.net.HttpURLConnection
import java.net.URL
import okhttp3.HttpUrl.Companion.toHttpUrl

fun main() {
    val urlBuilder = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/folder".toHttpUrl().newBuilder()
    urlBuilder.addQueryParameter("module_name", "task")
    val url = URL(urlBuilder.build().toString())
    val conn = url.openConnection() as HttpURLConnection
    conn.requestMethod = "GET"
    conn.setRequestProperty("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa")

    val response = conn.inputStream.bufferedReader().readText()
    println(response)
}

NSString *encodedModule_name = [@"task" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *urlString = [NSString stringWithFormat:@"https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/folder?module_name=%@", encodedModule_name];
NSURL *url = [NSURL URLWithString:urlString];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:url];
[request setHTTPMethod:@"GET"];
[request setValue:@"Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa" forHTTPHeaderField:@"Authorization"];

NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *task = [session dataTaskWithRequest:request
    completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
        NSString *result = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];
        NSLog(@"%@", result);
}];
[task resume];

open Lwt
open Cohttp_lwt_unix

let () =
  let enc_module_name = Uri.pct_encode "task" in
  let uri = Uri.of_string ("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/folder" ^ "?module_name=" ^ enc_module_name) in
  let headers = Cohttp.Header.init ()
    |> fun h -> Cohttp.Header.add h "Authorization" "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
  in
  Lwt_main.run (
    Client.get ~headers uri >>= fun (_, body) ->
    Cohttp_lwt.Body.to_string body >|= fun s ->
    print_endline s)

$headers = @{
    "Authorization" = "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
}

$params = @{
    module_name = "task"
}
$queryString = ($params.GetEnumerator() | ForEach-Object { "$($_.Key)=$([System.Uri]::EscapeDataString($_.Value))" }) -join "&"
$url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/folder" + "?" + $queryString

$response = Invoke-RestMethod -Uri $url -Method GET -Headers $headers

$response | ConvertTo-Json

library(httr)

url <- "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/folder"

params <- list(
  module_name = "task"
)

response <- GET(
  url,
  add_headers(Authorization = "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"),
  query = params
)

content(response, "text")

import Foundation

var components = URLComponents(string: "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/folder")!
components.queryItems = [
    URLQueryItem(name: "module_name", value: "task")
]
let url = components.url!
var request = URLRequest(url: url)
request.httpMethod = "GET"
request.setValue("Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa", forHTTPHeaderField: "Authorization")

let semaphore = DispatchSemaphore(value: 0)
let task = URLSession.shared.dataTask(with: request) { data, response, error in
    if let data = data, let result = String(data: data, encoding: .utf8) {
        print(result)
    }
    semaphore.signal()
}
task.resume()
semaphore.wait()

Sample Input

module_name : "task"

Sample Response

200