Users

This module covers user-related operations within Zoho Projects. Use this API to manage portal users, client users, and resources. You can retrieve user details, add or deactivate users, update user profiles, and view the projects a user is associated with.

Get Users (Deprecated)

This API is deprecated. Use Get All Portal Users, Client Users, and Contacts instead.

Retrieve all users, client users, contacts, and resources in a specific portal. Use this API to access the complete list of users and their details within a portal.

GET

/api/v3/portal/[PORTAL_ID]/users

OAuth Scope:

ZohoProjects.users.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

type

int

Enter the user type.
Accepted values are 1 (Users), 2 (Client Users), 3 (Client Contacts), 6 (Resources).

view_type

String

Enter the view type.
Accepted values are 0 (Inactive), 1 (Active).

sort

String

Enter the sort criteria for the results. Example: alphabetical:asc. Accepted values: alphabetical, last_accessed_time, role, profile, added_time with asc or desc.

page

int

default : 1

Enter the page number.

per_page

int

limit : 1-200
default : 100

Enter the number of entries to be displayed per page.

filter

JSONObject

Enter the filter criteria to narrow down the user results.

criteria

JSONArray

max length : 10000
array size : >=0

Enter the list of filter conditions. Each condition is combined using the pattern.

ids

String

Enter the user IDs.

company_ids

String

Enter the customer IDs. You can obtain it from the Get Customers API (the "id" field in the response).

view

String

Enter the data view type.
Accepted values: list, grid.

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]/users?type=1&view_type=1&sort=alphabetical%3Aasc&page=1&per_page=10&filter=%7B%22criteria%22%3A%5B%7B%22cfid%22%3A%224000000000242%22%2C%22api_name%22%3A%22-%22%2C%22field_name%22%3A%22project%22%2C%22criteria_condition%22%3A%22contains%22%2C%22value%22%3A%5B%221752587000000097269%22%5D%2C%22relative_columns%22%3A%5B%7B%22cfid%22%3A%224000000000242%22%2C%22offset%22%3A%221%22%2C%22unit%22%3A%22days%22%2C%22prior%22%3A%22before%22%7D%5D%7D%5D%2C%22pattern%22%3A%221%22%7D&ids=4000000029001&company_ids=170876000003941041&view=list' \
-H 'Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa'

url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users";
filter_value = {"criteria":[{"cfid":"4000000000242","api_name":"-","field_name":"project","criteria_condition":"contains","value":["1752587000000097269"],"relative_columns":[{"cfid":"4000000000242","offset":"1","unit":"days","prior":"before"}]}],"pattern":"1"};
params = Map();
params.put("type", 1);
params.put("view_type", "1");
params.put("sort", "alphabetical:asc");
params.put("page", "1");
params.put("per_page", "10");
params.put("filter", filter_value);
params.put("ids", "4000000029001");
params.put("company_ids", "170876000003941041");
params.put("view", "list");
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]/users');
url.searchParams.append('type', '1');
url.searchParams.append('view_type', '1');
url.searchParams.append('sort', 'alphabetical:asc');
url.searchParams.append('page', '1');
url.searchParams.append('per_page', '10');
url.searchParams.append('filter', '{"criteria":[{"cfid":"4000000000242","api_name":"-","field_name":"project","criteria_condition":"contains","value":["1752587000000097269"],"relative_columns":[{"cfid":"4000000000242","offset":"1","unit":"days","prior":"before"}]}],"pattern":"1"}');
url.searchParams.append('ids', '4000000029001');
url.searchParams.append('company_ids', '170876000003941041');
url.searchParams.append('view', 'list');

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]/users")
params = {
  "type" => "1",
  "view_type" => "1",
  "sort" => "alphabetical:asc",
  "page" => "1",
  "per_page" => "10",
  "filter" => "{\"criteria\":[{\"cfid\":\"4000000000242\",\"api_name\":\"-\",\"field_name\":\"project\",\"criteria_condition\":\"contains\",\"value\":[\"1752587000000097269\"],\"relative_columns\":[{\"cfid\":\"4000000000242\",\"offset\":\"1\",\"unit\":\"days\",\"prior\":\"before\"}]}],\"pattern\":\"1\"}",
  "ids" => "4000000029001",
  "company_ids" => "170876000003941041",
  "view" => "list"
}
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 = [
    'type' => '1',
    'view_type' => '1',
    'sort' => 'alphabetical:asc',
    'page' => '1',
    'per_page' => '10',
    'filter' => '{"criteria":[{"cfid":"4000000000242","api_name":"-","field_name":"project","criteria_condition":"contains","value":["1752587000000097269"],"relative_columns":[{"cfid":"4000000000242","offset":"1","unit":"days","prior":"before"}]}],"pattern":"1"}',
    'ids' => '4000000029001',
    'company_ids' => '170876000003941041',
    'view' => 'list',
];
$url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users" . "?" . 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]/users"

params = {
    "type": "1",
    "view_type": "1",
    "sort": "alphabetical:asc",
    "page": "1",
    "per_page": "10",
    "filter": "{\"criteria\":[{\"cfid\":\"4000000000242\",\"api_name\":\"-\",\"field_name\":\"project\",\"criteria_condition\":\"contains\",\"value\":[\"1752587000000097269\"],\"relative_columns\":[{\"cfid\":\"4000000000242\",\"offset\":\"1\",\"unit\":\"days\",\"prior\":\"before\"}]}],\"pattern\":\"1\"}",
    "ids": "4000000029001",
    "company_ids": "170876000003941041",
    "view": "list"
}

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_type = curl_easy_escape(curl, "1", 0);
        char *enc_view_type = curl_easy_escape(curl, "1", 0);
        char *enc_sort = curl_easy_escape(curl, "alphabetical:asc", 0);
        char *enc_page = curl_easy_escape(curl, "1", 0);
        char *enc_per_page = curl_easy_escape(curl, "10", 0);
        char *enc_filter = curl_easy_escape(curl, "{\"criteria\":[{\"cfid\":\"4000000000242\",\"api_name\":\"-\",\"field_name\":\"project\",\"criteria_condition\":\"contains\",\"value\":[\"1752587000000097269\"],\"relative_columns\":[{\"cfid\":\"4000000000242\",\"offset\":\"1\",\"unit\":\"days\",\"prior\":\"before\"}]}],\"pattern\":\"1\"}", 0);
        char *enc_ids = curl_easy_escape(curl, "4000000029001", 0);
        char *enc_company_ids = curl_easy_escape(curl, "170876000003941041", 0);
        char *enc_view = curl_easy_escape(curl, "list", 0);
        char url[2048];
        snprintf(url, sizeof(url), "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users?type=%s&view_type=%s&sort=%s&page=%s&per_page=%s&filter=%s&ids=%s&company_ids=%s&view=%s", enc_type, enc_view_type, enc_sort, enc_page, enc_per_page, enc_filter, enc_ids, enc_company_ids, enc_view);

        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_type);
        curl_free(enc_view_type);
        curl_free(enc_sort);
        curl_free(enc_page);
        curl_free(enc_per_page);
        curl_free(enc_filter);
        curl_free(enc_ids);
        curl_free(enc_company_ids);
        curl_free(enc_view);
        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["type"] = "1";
query["view_type"] = "1";
query["sort"] = "alphabetical:asc";
query["page"] = "1";
query["per_page"] = "10";
query["filter"] = "{\"criteria\":[{\"cfid\":\"4000000000242\",\"api_name\":\"-\",\"field_name\":\"project\",\"criteria_condition\":\"contains\",\"value\":[\"1752587000000097269\"],\"relative_columns\":[{\"cfid\":\"4000000000242\",\"offset\":\"1\",\"unit\":\"days\",\"prior\":\"before\"}]}],\"pattern\":\"1\"}";
query["ids"] = "4000000029001";
query["company_ids"] = "170876000003941041";
query["view"] = "list";
var uriBuilder = new UriBuilder("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users") { 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_type = curl_easy_escape(curl, "1", 0);
        char* enc_view_type = curl_easy_escape(curl, "1", 0);
        char* enc_sort = curl_easy_escape(curl, "alphabetical:asc", 0);
        char* enc_page = curl_easy_escape(curl, "1", 0);
        char* enc_per_page = curl_easy_escape(curl, "10", 0);
        char* enc_filter = curl_easy_escape(curl, "{\"criteria\":[{\"cfid\":\"4000000000242\",\"api_name\":\"-\",\"field_name\":\"project\",\"criteria_condition\":\"contains\",\"value\":[\"1752587000000097269\"],\"relative_columns\":[{\"cfid\":\"4000000000242\",\"offset\":\"1\",\"unit\":\"days\",\"prior\":\"before\"}]}],\"pattern\":\"1\"}", 0);
        char* enc_ids = curl_easy_escape(curl, "4000000029001", 0);
        char* enc_company_ids = curl_easy_escape(curl, "170876000003941041", 0);
        char* enc_view = curl_easy_escape(curl, "list", 0);
        std::string url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users";
        url += "?type=" + std::string(enc_type);
        url += "&view_type=" + std::string(enc_view_type);
        url += "&sort=" + std::string(enc_sort);
        url += "&page=" + std::string(enc_page);
        url += "&per_page=" + std::string(enc_per_page);
        url += "&filter=" + std::string(enc_filter);
        url += "&ids=" + std::string(enc_ids);
        url += "&company_ids=" + std::string(enc_company_ids);
        url += "&view=" + std::string(enc_view);

        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_type);
        curl_free(enc_view_type);
        curl_free(enc_sort);
        curl_free(enc_page);
        curl_free(enc_per_page);
        curl_free(enc_filter);
        curl_free(enc_ids);
        curl_free(enc_company_ids);
        curl_free(enc_view);
        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}

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

(let [enc-type (java.net.URLEncoder/encode "1" "UTF-8")
      enc-view_type (java.net.URLEncoder/encode "1" "UTF-8")
      enc-sort (java.net.URLEncoder/encode "alphabetical:asc" "UTF-8")
      enc-page (java.net.URLEncoder/encode "1" "UTF-8")
      enc-per_page (java.net.URLEncoder/encode "10" "UTF-8")
      enc-filter (java.net.URLEncoder/encode "{\"criteria\":[{\"cfid\":\"4000000000242\",\"api_name\":\"-\",\"field_name\":\"project\",\"criteria_condition\":\"contains\",\"value\":[\"1752587000000097269\"],\"relative_columns\":[{\"cfid\":\"4000000000242\",\"offset\":\"1\",\"unit\":\"days\",\"prior\":\"before\"}]}],\"pattern\":\"1\"}" "UTF-8")
      enc-ids (java.net.URLEncoder/encode "4000000029001" "UTF-8")
      enc-company_ids (java.net.URLEncoder/encode "170876000003941041" "UTF-8")
      enc-view (java.net.URLEncoder/encode "list" "UTF-8")
      url (str "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users" "?type=" enc-type "&view_type=" enc-view_type "&sort=" enc-sort "&page=" enc-page "&per_page=" enc-per_page "&filter=" enc-filter "&ids=" enc-ids "&company_ids=" enc-company_ids "&view=" enc-view)]
(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]/users", nil)
    q := req.URL.Query()
    q.Add("type", "1")
    q.Add("view_type", "1")
    q.Add("sort", "alphabetical:asc")
    q.Add("page", "1")
    q.Add("per_page", "10")
    q.Add("filter", "{\"criteria\":[{\"cfid\":\"4000000000242\",\"api_name\":\"-\",\"field_name\":\"project\",\"criteria_condition\":\"contains\",\"value\":[\"1752587000000097269\"],\"relative_columns\":[{\"cfid\":\"4000000000242\",\"offset\":\"1\",\"unit\":\"days\",\"prior\":\"before\"}]}],\"pattern\":\"1\"}")
    q.Add("ids", "4000000029001")
    q.Add("company_ids", "170876000003941041")
    q.Add("view", "list")
    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]/users?type=1&view_type=1&sort=alphabetical%3Aasc&page=1&per_page=10&filter=%7B%22criteria%22%3A%5B%7B%22cfid%22%3A%224000000000242%22%2C%22api_name%22%3A%22-%22%2C%22field_name%22%3A%22project%22%2C%22criteria_condition%22%3A%22contains%22%2C%22value%22%3A%5B%221752587000000097269%22%5D%2C%22relative_columns%22%3A%5B%7B%22cfid%22%3A%224000000000242%22%2C%22offset%22%3A%221%22%2C%22unit%22%3A%22days%22%2C%22prior%22%3A%22before%22%7D%5D%7D%5D%2C%22pattern%22%3A%221%22%7D&ids=4000000029001&company_ids=170876000003941041&view=list HTTP/1.1
Host: https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users?type=1&view_type=1&sort=alphabetical%3Aasc&page=1&per_page=10&filter=%7B%22criteria%22%3A%5B%7B%22cfid%22%3A%224000000000242%22%2C%22api_name%22%3A%22-%22%2C%22field_name%22%3A%22project%22%2C%22criteria_condition%22%3A%22contains%22%2C%22value%22%3A%5B%221752587000000097269%22%5D%2C%22relative_columns%22%3A%5B%7B%22cfid%22%3A%224000000000242%22%2C%22offset%22%3A%221%22%2C%22unit%22%3A%22days%22%2C%22prior%22%3A%22before%22%7D%5D%7D%5D%2C%22pattern%22%3A%221%22%7D&ids=4000000029001&company_ids=170876000003941041&view=list
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]/users");
uriBuilder.addParameter("type", "1");
uriBuilder.addParameter("view_type", "1");
uriBuilder.addParameter("sort", "alphabetical:asc");
uriBuilder.addParameter("page", "1");
uriBuilder.addParameter("per_page", "10");
uriBuilder.addParameter("filter", "{\"criteria\":[{\"cfid\":\"4000000000242\",\"api_name\":\"-\",\"field_name\":\"project\",\"criteria_condition\":\"contains\",\"value\":[\"1752587000000097269\"],\"relative_columns\":[{\"cfid\":\"4000000000242\",\"offset\":\"1\",\"unit\":\"days\",\"prior\":\"before\"}]}],\"pattern\":\"1\"}");
uriBuilder.addParameter("ids", "4000000029001");
uriBuilder.addParameter("company_ids", "170876000003941041");
uriBuilder.addParameter("view", "list");
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]/users';

const params = new URLSearchParams({
  'type': '1',
  'view_type': '1',
  'sort': 'alphabetical:asc',
  'page': '1',
  'per_page': '10',
  'filter': '{"criteria":[{"cfid":"4000000000242","api_name":"-","field_name":"project","criteria_condition":"contains","value":["1752587000000097269"],"relative_columns":[{"cfid":"4000000000242","offset":"1","unit":"days","prior":"before"}]}],"pattern":"1"}',
  'ids': '4000000029001',
  'company_ids': '170876000003941041',
  'view': 'list'
});

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));

type = 1
view_type = "1"
sort = "alphabetical:asc"
page = "1"
per_page = "10"
filter = {"criteria":[{"cfid":"4000000000242","api_name":"-","field_name":"project","criteria_condition":"contains","value":["1752587000000097269"],"relative_columns":[{"cfid":"4000000000242","offset":"1","unit":"days","prior":"before"}]}],"pattern":"1"}
ids = "4000000029001"
company_ids = "170876000003941041"
view = "list"

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]/users".toHttpUrl().newBuilder()
    urlBuilder.addQueryParameter("type", "1")
    urlBuilder.addQueryParameter("view_type", "1")
    urlBuilder.addQueryParameter("sort", "alphabetical:asc")
    urlBuilder.addQueryParameter("page", "1")
    urlBuilder.addQueryParameter("per_page", "10")
    urlBuilder.addQueryParameter("filter", "{\"criteria\":[{\"cfid\":\"4000000000242\",\"api_name\":\"-\",\"field_name\":\"project\",\"criteria_condition\":\"contains\",\"value\":[\"1752587000000097269\"],\"relative_columns\":[{\"cfid\":\"4000000000242\",\"offset\":\"1\",\"unit\":\"days\",\"prior\":\"before\"}]}],\"pattern\":\"1\"}")
    urlBuilder.addQueryParameter("ids", "4000000029001")
    urlBuilder.addQueryParameter("company_ids", "170876000003941041")
    urlBuilder.addQueryParameter("view", "list")
    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 *encodedType = [@"1" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *encodedView_type = [@"1" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *encodedSort = [@"alphabetical:asc" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *encodedPage = [@"1" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *encodedPer_page = [@"10" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *encodedFilter = [@"{\"criteria\":[{\"cfid\":\"4000000000242\",\"api_name\":\"-\",\"field_name\":\"project\",\"criteria_condition\":\"contains\",\"value\":[\"1752587000000097269\"],\"relative_columns\":[{\"cfid\":\"4000000000242\",\"offset\":\"1\",\"unit\":\"days\",\"prior\":\"before\"}]}],\"pattern\":\"1\"}" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *encodedIds = [@"4000000029001" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *encodedCompany_ids = [@"170876000003941041" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *encodedView = [@"list" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *urlString = [NSString stringWithFormat:@"https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users?type=%@&view_type=%@&sort=%@&page=%@&per_page=%@&filter=%@&ids=%@&company_ids=%@&view=%@", encodedType, encodedView_type, encodedSort, encodedPage, encodedPer_page, encodedFilter, encodedIds, encodedCompany_ids, encodedView];
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_type = Uri.pct_encode "1" in
  let enc_view_type = Uri.pct_encode "1" in
  let enc_sort = Uri.pct_encode "alphabetical:asc" in
  let enc_page = Uri.pct_encode "1" in
  let enc_per_page = Uri.pct_encode "10" in
  let enc_filter = Uri.pct_encode "{\"criteria\":[{\"cfid\":\"4000000000242\",\"api_name\":\"-\",\"field_name\":\"project\",\"criteria_condition\":\"contains\",\"value\":[\"1752587000000097269\"],\"relative_columns\":[{\"cfid\":\"4000000000242\",\"offset\":\"1\",\"unit\":\"days\",\"prior\":\"before\"}]}],\"pattern\":\"1\"}" in
  let enc_ids = Uri.pct_encode "4000000029001" in
  let enc_company_ids = Uri.pct_encode "170876000003941041" in
  let enc_view = Uri.pct_encode "list" in
  let uri = Uri.of_string ("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users" ^ "?type=" ^ enc_type ^ "&view_type=" ^ enc_view_type ^ "&sort=" ^ enc_sort ^ "&page=" ^ enc_page ^ "&per_page=" ^ enc_per_page ^ "&filter=" ^ enc_filter ^ "&ids=" ^ enc_ids ^ "&company_ids=" ^ enc_company_ids ^ "&view=" ^ enc_view) 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 = @{
    type = "1"
    view_type = "1"
    sort = "alphabetical:asc"
    page = "1"
    per_page = "10"
    filter = "{`"criteria`":[{`"cfid`":`"4000000000242`",`"api_name`":`"-`",`"field_name`":`"project`",`"criteria_condition`":`"contains`",`"value`":[`"1752587000000097269`"],`"relative_columns`":[{`"cfid`":`"4000000000242`",`"offset`":`"1`",`"unit`":`"days`",`"prior`":`"before`"}]}],`"pattern`":`"1`"}"
    ids = "4000000029001"
    company_ids = "170876000003941041"
    view = "list"
}
$queryString = ($params.GetEnumerator() | ForEach-Object { "$($_.Key)=$([System.Uri]::EscapeDataString($_.Value))" }) -join "&"
$url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users" + "?" + $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]/users"

params <- list(
  type = "1",
  view_type = "1",
  sort = "alphabetical:asc",
  page = "1",
  per_page = "10",
  filter = "{\"criteria\":[{\"cfid\":\"4000000000242\",\"api_name\":\"-\",\"field_name\":\"project\",\"criteria_condition\":\"contains\",\"value\":[\"1752587000000097269\"],\"relative_columns\":[{\"cfid\":\"4000000000242\",\"offset\":\"1\",\"unit\":\"days\",\"prior\":\"before\"}]}],\"pattern\":\"1\"}",
  ids = "4000000029001",
  company_ids = "170876000003941041",
  view = "list"
)

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]/users")!
components.queryItems = [
    URLQueryItem(name: "type", value: "1"),
    URLQueryItem(name: "view_type", value: "1"),
    URLQueryItem(name: "sort", value: "alphabetical:asc"),
    URLQueryItem(name: "page", value: "1"),
    URLQueryItem(name: "per_page", value: "10"),
    URLQueryItem(name: "filter", value: "{\"criteria\":[{\"cfid\":\"4000000000242\",\"api_name\":\"-\",\"field_name\":\"project\",\"criteria_condition\":\"contains\",\"value\":[\"1752587000000097269\"],\"relative_columns\":[{\"cfid\":\"4000000000242\",\"offset\":\"1\",\"unit\":\"days\",\"prior\":\"before\"}]}],\"pattern\":\"1\"}"),
    URLQueryItem(name: "ids", value: "4000000029001"),
    URLQueryItem(name: "company_ids", value: "170876000003941041"),
    URLQueryItem(name: "view", value: "list")
]
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

type : 1 view_type : "1" sort : "alphabetical:asc" page : "1" per_page : "10" filter : { "criteria" : [ { "cfid" : "4000000000242", "api_name" : "-", "field_name" : "project", "criteria_condition" : "contains", "value" : [ "1752587000000097269" ], "relative_columns" : [ { "cfid" : "4000000000242", "offset" : "1", "unit" : "days", "prior" : "before" } ] } ], "pattern" : "1" } ids : "4000000029001" company_ids : "170876000003941041" view : "list"

Sample Response

200{ "page_info" : { "per_page" : "100", "has_next_page" : "true", "count" : "189", "page" : "1" }, "users" : [ { "updated_time" : "2024-03-07T07:50:20.347Z", "added_time" : "2021-07-27T14:39:49.031Z", "is_active" : true, "role" : { "name" : "Administrator", "id" : "103368000000048005", "type" : "1" }, "time_of_request" : "1969-12-31T23:59:59.999Z", "is_confirmed" : true, "profile" : { "name" : "Portal Owner", "id" : "103368000000048352", "type" : "1", "is_default" : true }, "last_name" : "Hemsworth", "display_name" : "Monica", "zuid" : "66295825", "last_accessed_on" : "2024-05-10T07:32:28.422Z", "full_name" : "Monica Hemsworth", "user_type" : "1", "id" : "103368000000048003", "invoice" : "120.0", "first_name" : "Monica", "email" : "monica.hemsworth@zylker.com", "status" : "1", "budget" : { "rate_per_hour" : "120.0", "cost_per_hour" : "120.0" } } ] }

Possible Errors

Get Associated Project(s)

Retrieve all projects associated with a specific user in a portal. Use this API to access the list of projects a user is part of within a portal.

GET

/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/projects

OAuth Scope:

ZohoProjects.users.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).

user_id

String

required
regex : [0-9]+

Identifier of an user. Obtained from the Get Users API - the "id" field in the response corresponds to user_id.

Query Parameters

Param Name

Data Type

Description

status

String

Enter the status of the projects to retrieve. Accepted values: active, archived

search_term

String

Enter a search term to filter the projects.

page

int

default : 1

Enter the page number.

per_page

int

limit : 1-200
default : 100

Enter the number of entries to be displayed per page.

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]/users/[USER_ID]/projects?status=active&search_term=Zoho+Projects&page=1&per_page=10' \
-H 'Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa'

url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/projects";
params = Map();
params.put("status", "active");
params.put("search_term", "Zoho Projects");
params.put("page", "1");
params.put("per_page", "10");
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]/users/[USER_ID]/projects');
url.searchParams.append('status', 'active');
url.searchParams.append('search_term', 'Zoho Projects');
url.searchParams.append('page', '1');
url.searchParams.append('per_page', '10');

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]/users/[USER_ID]/projects")
params = {
  "status" => "active",
  "search_term" => "Zoho Projects",
  "page" => "1",
  "per_page" => "10"
}
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 = [
    'status' => 'active',
    'search_term' => 'Zoho Projects',
    'page' => '1',
    'per_page' => '10',
];
$url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/projects" . "?" . 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]/users/[USER_ID]/projects"

params = {
    "status": "active",
    "search_term": "Zoho Projects",
    "page": "1",
    "per_page": "10"
}

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_status = curl_easy_escape(curl, "active", 0);
        char *enc_search_term = curl_easy_escape(curl, "Zoho Projects", 0);
        char *enc_page = curl_easy_escape(curl, "1", 0);
        char *enc_per_page = curl_easy_escape(curl, "10", 0);
        char url[2048];
        snprintf(url, sizeof(url), "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/projects?status=%s&search_term=%s&page=%s&per_page=%s", enc_status, enc_search_term, enc_page, enc_per_page);

        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_status);
        curl_free(enc_search_term);
        curl_free(enc_page);
        curl_free(enc_per_page);
        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["status"] = "active";
query["search_term"] = "Zoho Projects";
query["page"] = "1";
query["per_page"] = "10";
var uriBuilder = new UriBuilder("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/projects") { 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_status = curl_easy_escape(curl, "active", 0);
        char* enc_search_term = curl_easy_escape(curl, "Zoho Projects", 0);
        char* enc_page = curl_easy_escape(curl, "1", 0);
        char* enc_per_page = curl_easy_escape(curl, "10", 0);
        std::string url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/projects";
        url += "?status=" + std::string(enc_status);
        url += "&search_term=" + std::string(enc_search_term);
        url += "&page=" + std::string(enc_page);
        url += "&per_page=" + std::string(enc_per_page);

        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_status);
        curl_free(enc_search_term);
        curl_free(enc_page);
        curl_free(enc_per_page);
        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}

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

(let [enc-status (java.net.URLEncoder/encode "active" "UTF-8")
      enc-search_term (java.net.URLEncoder/encode "Zoho Projects" "UTF-8")
      enc-page (java.net.URLEncoder/encode "1" "UTF-8")
      enc-per_page (java.net.URLEncoder/encode "10" "UTF-8")
      url (str "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/projects" "?status=" enc-status "&search_term=" enc-search_term "&page=" enc-page "&per_page=" enc-per_page)]
(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]/users/[USER_ID]/projects", nil)
    q := req.URL.Query()
    q.Add("status", "active")
    q.Add("search_term", "Zoho Projects")
    q.Add("page", "1")
    q.Add("per_page", "10")
    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]/users/[USER_ID]/projects?status=active&search_term=Zoho+Projects&page=1&per_page=10 HTTP/1.1
Host: https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/projects?status=active&search_term=Zoho+Projects&page=1&per_page=10
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]/users/[USER_ID]/projects");
uriBuilder.addParameter("status", "active");
uriBuilder.addParameter("search_term", "Zoho Projects");
uriBuilder.addParameter("page", "1");
uriBuilder.addParameter("per_page", "10");
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]/users/[USER_ID]/projects';

const params = new URLSearchParams({
  'status': 'active',
  'search_term': 'Zoho Projects',
  'page': '1',
  'per_page': '10'
});

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));

status = "active"
search_term = "Zoho Projects"
page = "1"
per_page = "10"

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]/users/[USER_ID]/projects".toHttpUrl().newBuilder()
    urlBuilder.addQueryParameter("status", "active")
    urlBuilder.addQueryParameter("search_term", "Zoho Projects")
    urlBuilder.addQueryParameter("page", "1")
    urlBuilder.addQueryParameter("per_page", "10")
    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 *encodedStatus = [@"active" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *encodedSearch_term = [@"Zoho Projects" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *encodedPage = [@"1" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *encodedPer_page = [@"10" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *urlString = [NSString stringWithFormat:@"https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/projects?status=%@&search_term=%@&page=%@&per_page=%@", encodedStatus, encodedSearch_term, encodedPage, encodedPer_page];
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_status = Uri.pct_encode "active" in
  let enc_search_term = Uri.pct_encode "Zoho Projects" in
  let enc_page = Uri.pct_encode "1" in
  let enc_per_page = Uri.pct_encode "10" in
  let uri = Uri.of_string ("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/projects" ^ "?status=" ^ enc_status ^ "&search_term=" ^ enc_search_term ^ "&page=" ^ enc_page ^ "&per_page=" ^ enc_per_page) 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 = @{
    status = "active"
    search_term = "Zoho Projects"
    page = "1"
    per_page = "10"
}
$queryString = ($params.GetEnumerator() | ForEach-Object { "$($_.Key)=$([System.Uri]::EscapeDataString($_.Value))" }) -join "&"
$url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/projects" + "?" + $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]/users/[USER_ID]/projects"

params <- list(
  status = "active",
  search_term = "Zoho Projects",
  page = "1",
  per_page = "10"
)

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]/users/[USER_ID]/projects")!
components.queryItems = [
    URLQueryItem(name: "status", value: "active"),
    URLQueryItem(name: "search_term", value: "Zoho Projects"),
    URLQueryItem(name: "page", value: "1"),
    URLQueryItem(name: "per_page", value: "10")
]
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

status : "active" search_term : "Zoho Projects" page : "1" per_page : "10"

Sample Response

200{ "projects" : [ { "number" : 253, "is_owner" : false, "name" : "deal 2", "is_strict_project" : false, "id" : "103368000001263005", "status" : "active", "group" : { "prefix" : "", "name" : "zp.projset.ungroupproj", "id" : "103368000000025001", "is_default" : true, "type" : "public" } } ], "page_info" : { "per_page" : "100", "has_next_page" : "false", "page" : "1" } }

Possible Errors

Get User License Details

Retrieve the license details of portal and client users in a specific portal. Use this API to access the current license usage and availability for users within a portal.

GET

/api/v3/portal/[PORTAL_ID]/users/license-details

OAuth Scope:

ZohoProjects.users.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).

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 GET \
'https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/license-details' \
-H 'Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa'

url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/license-details";
response = invokeUrl
[
    url: url
    type: GET
    connection: "projects"
];
info response;

const https = require('https');
const url = new URL('https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/license-details');

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]/users/license-details")

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
$url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/license-details";

$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]/users/license-details"

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

response = requests.get(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]/users/license-details");
        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_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.Get, "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/license-details");

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]/users/license-details");
        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_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}

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

(def response
  (client/get "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/license-details"
    {:headers {"Authorization" "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"}
     :as :json}))

(println (:body response))

package main

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

func main() {
    req, _ := http.NewRequest("GET", "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/license-details", 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))
}

GET https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/license-details HTTP/1.1
Host: https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/license-details
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]/users/license-details");
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]/users/license-details';

const options = {
  method: 'GET',
  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]/users/license-details")
    val conn = url.openConnection() as HttpURLConnection
    conn.requestMethod = "GET"
    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]/users/license-details"];
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 uri = Uri.of_string "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/license-details" 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"
}

$response = Invoke-RestMethod -Uri "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/license-details" -Method GET -Headers $headers

$response | ConvertTo-Json

library(httr)

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

response <- GET(
  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]/users/license-details")!
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 Response

200{ "lite_user" : { "used_count" : 5, "remaining_count" : 20, "total_count" : 25 }, "readonly_user" : { "used_count" : 0, "remaining_count" : 120, "total_count" : 120 }, "client_user" : { "used_count" : 0, "remaining_count" : 20, "total_count" : 20 }, "portal_user" : { "used_count" : 2, "remaining_count" : 18, "total_count" : 20 } }

Possible Errors

Add User

Add a new user to the Zoho Projects portal. Use this API to invite and grant access to a user within a portal.

POST

/api/v3/portal/[PORTAL_ID]/users

OAuth Scope:

ZohoProjects.users.CREATE

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

userdetails

JSONArray

required

Enter the details of the users to add to the portal.

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]/users' \
-H 'Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa' \
--form-string 'userdetails=[{"email_id":"mark@zylker.com","email_template":"-","role_id":"8000000000991","profile_id":"2223806000000022149","project_ids":["23806000074760021"],"bulk_projects":{"select_all":"false","selected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"unselected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"rateupdatedprojects":"-","costrateupdatedprojects":"-"},"rate":"55.00","cost_rate_per_hour":"200","revenue_budget":"14.00","cost_budget":"20.00","budget_threshold":"10.00","include_projects":"8000000005863","applyportalrate":"-","reporting_manager":"-","reporting_to":"8000000002411","hourly_budget":"5.00","hourly_budget_threshold":"3.00","business_hours_id":"-"}]'

url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users";
params = Map();
params.put("userdetails", [{"email_id":"mark@zylker.com","email_template":"-","role_id":"8000000000991","profile_id":"2223806000000022149","project_ids":["23806000074760021"],"bulk_projects":{"select_all":"false","selected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"unselected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"rateupdatedprojects":"-","costrateupdatedprojects":"-"},"rate":"55.00","cost_rate_per_hour":"200","revenue_budget":"14.00","cost_budget":"20.00","budget_threshold":"10.00","include_projects":"8000000005863","applyportalrate":"-","reporting_manager":"-","reporting_to":"8000000002411","hourly_budget":"5.00","hourly_budget_threshold":"3.00","business_hours_id":"-"}]);
response = invokeUrl
[
    url: url
    type: POST
    parameters: params
    connection: "projects"
];
info response;

const https = require('https');
const url = new URL('https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users');
url.searchParams.append('userdetails', '[{"email_id":"mark@zylker.com","email_template":"-","role_id":"8000000000991","profile_id":"2223806000000022149","project_ids":["23806000074760021"],"bulk_projects":{"select_all":"false","selected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"unselected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"rateupdatedprojects":"-","costrateupdatedprojects":"-"},"rate":"55.00","cost_rate_per_hour":"200","revenue_budget":"14.00","cost_budget":"20.00","budget_threshold":"10.00","include_projects":"8000000005863","applyportalrate":"-","reporting_manager":"-","reporting_to":"8000000002411","hourly_budget":"5.00","hourly_budget_threshold":"3.00","business_hours_id":"-"}]');

const options = {
  hostname: url.hostname,
  path: url.pathname + url.search,
  method: 'POST',
  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]/users")
params = {
  "userdetails" => "[{\"email_id\":\"mark@zylker.com\",\"email_template\":\"-\",\"role_id\":\"8000000000991\",\"profile_id\":\"2223806000000022149\",\"project_ids\":[\"23806000074760021\"],\"bulk_projects\":{\"select_all\":\"false\",\"selected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"unselected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"rateupdatedprojects\":\"-\",\"costrateupdatedprojects\":\"-\"},\"rate\":\"55.00\",\"cost_rate_per_hour\":\"200\",\"revenue_budget\":\"14.00\",\"cost_budget\":\"20.00\",\"budget_threshold\":\"10.00\",\"include_projects\":\"8000000005863\",\"applyportalrate\":\"-\",\"reporting_manager\":\"-\",\"reporting_to\":\"8000000002411\",\"hourly_budget\":\"5.00\",\"hourly_budget_threshold\":\"3.00\",\"business_hours_id\":\"-\"}]"
}
url.query = URI.encode_www_form(params)

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

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

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

<?php
$params = [
    'userdetails' => '[{"email_id":"mark@zylker.com","email_template":"-","role_id":"8000000000991","profile_id":"2223806000000022149","project_ids":["23806000074760021"],"bulk_projects":{"select_all":"false","selected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"unselected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"rateupdatedprojects":"-","costrateupdatedprojects":"-"},"rate":"55.00","cost_rate_per_hour":"200","revenue_budget":"14.00","cost_budget":"20.00","budget_threshold":"10.00","include_projects":"8000000005863","applyportalrate":"-","reporting_manager":"-","reporting_to":"8000000002411","hourly_budget":"5.00","hourly_budget_threshold":"3.00","business_hours_id":"-"}]',
];
$url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users" . "?" . http_build_query($params);

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => $url,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "POST",
  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]/users"

params = {
    "userdetails": "[{\"email_id\":\"mark@zylker.com\",\"email_template\":\"-\",\"role_id\":\"8000000000991\",\"profile_id\":\"2223806000000022149\",\"project_ids\":[\"23806000074760021\"],\"bulk_projects\":{\"select_all\":\"false\",\"selected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"unselected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"rateupdatedprojects\":\"-\",\"costrateupdatedprojects\":\"-\"},\"rate\":\"55.00\",\"cost_rate_per_hour\":\"200\",\"revenue_budget\":\"14.00\",\"cost_budget\":\"20.00\",\"budget_threshold\":\"10.00\",\"include_projects\":\"8000000005863\",\"applyportalrate\":\"-\",\"reporting_manager\":\"-\",\"reporting_to\":\"8000000002411\",\"hourly_budget\":\"5.00\",\"hourly_budget_threshold\":\"3.00\",\"business_hours_id\":\"-\"}]"
}

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

response = requests.post(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_userdetails = curl_easy_escape(curl, "[{\"email_id\":\"mark@zylker.com\",\"email_template\":\"-\",\"role_id\":\"8000000000991\",\"profile_id\":\"2223806000000022149\",\"project_ids\":[\"23806000074760021\"],\"bulk_projects\":{\"select_all\":\"false\",\"selected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"unselected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"rateupdatedprojects\":\"-\",\"costrateupdatedprojects\":\"-\"},\"rate\":\"55.00\",\"cost_rate_per_hour\":\"200\",\"revenue_budget\":\"14.00\",\"cost_budget\":\"20.00\",\"budget_threshold\":\"10.00\",\"include_projects\":\"8000000005863\",\"applyportalrate\":\"-\",\"reporting_manager\":\"-\",\"reporting_to\":\"8000000002411\",\"hourly_budget\":\"5.00\",\"hourly_budget_threshold\":\"3.00\",\"business_hours_id\":\"-\"}]", 0);
        char url[2048];
        snprintf(url, sizeof(url), "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users?userdetails=%s", enc_userdetails);

        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, "POST");

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

        curl_free(enc_userdetails);
        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["userdetails"] = "[{\"email_id\":\"mark@zylker.com\",\"email_template\":\"-\",\"role_id\":\"8000000000991\",\"profile_id\":\"2223806000000022149\",\"project_ids\":[\"23806000074760021\"],\"bulk_projects\":{\"select_all\":\"false\",\"selected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"unselected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"rateupdatedprojects\":\"-\",\"costrateupdatedprojects\":\"-\"},\"rate\":\"55.00\",\"cost_rate_per_hour\":\"200\",\"revenue_budget\":\"14.00\",\"cost_budget\":\"20.00\",\"budget_threshold\":\"10.00\",\"include_projects\":\"8000000005863\",\"applyportalrate\":\"-\",\"reporting_manager\":\"-\",\"reporting_to\":\"8000000002411\",\"hourly_budget\":\"5.00\",\"hourly_budget_threshold\":\"3.00\",\"business_hours_id\":\"-\"}]";
var uriBuilder = new UriBuilder("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users") { Query = query.ToString() };
var request = new HttpRequestMessage(HttpMethod.Post, 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_userdetails = curl_easy_escape(curl, "[{\"email_id\":\"mark@zylker.com\",\"email_template\":\"-\",\"role_id\":\"8000000000991\",\"profile_id\":\"2223806000000022149\",\"project_ids\":[\"23806000074760021\"],\"bulk_projects\":{\"select_all\":\"false\",\"selected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"unselected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"rateupdatedprojects\":\"-\",\"costrateupdatedprojects\":\"-\"},\"rate\":\"55.00\",\"cost_rate_per_hour\":\"200\",\"revenue_budget\":\"14.00\",\"cost_budget\":\"20.00\",\"budget_threshold\":\"10.00\",\"include_projects\":\"8000000005863\",\"applyportalrate\":\"-\",\"reporting_manager\":\"-\",\"reporting_to\":\"8000000002411\",\"hourly_budget\":\"5.00\",\"hourly_budget_threshold\":\"3.00\",\"business_hours_id\":\"-\"}]", 0);
        std::string url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users";
        url += "?userdetails=" + std::string(enc_userdetails);

        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, "POST");
        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_userdetails);
        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}

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

(let [enc-userdetails (java.net.URLEncoder/encode "[{\"email_id\":\"mark@zylker.com\",\"email_template\":\"-\",\"role_id\":\"8000000000991\",\"profile_id\":\"2223806000000022149\",\"project_ids\":[\"23806000074760021\"],\"bulk_projects\":{\"select_all\":\"false\",\"selected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"unselected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"rateupdatedprojects\":\"-\",\"costrateupdatedprojects\":\"-\"},\"rate\":\"55.00\",\"cost_rate_per_hour\":\"200\",\"revenue_budget\":\"14.00\",\"cost_budget\":\"20.00\",\"budget_threshold\":\"10.00\",\"include_projects\":\"8000000005863\",\"applyportalrate\":\"-\",\"reporting_manager\":\"-\",\"reporting_to\":\"8000000002411\",\"hourly_budget\":\"5.00\",\"hourly_budget_threshold\":\"3.00\",\"business_hours_id\":\"-\"}]" "UTF-8")
      url (str "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users" "?userdetails=" enc-userdetails)]
(def response
  (client/post 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("POST", "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users", nil)
    q := req.URL.Query()
    q.Add("userdetails", "[{\"email_id\":\"mark@zylker.com\",\"email_template\":\"-\",\"role_id\":\"8000000000991\",\"profile_id\":\"2223806000000022149\",\"project_ids\":[\"23806000074760021\"],\"bulk_projects\":{\"select_all\":\"false\",\"selected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"unselected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"rateupdatedprojects\":\"-\",\"costrateupdatedprojects\":\"-\"},\"rate\":\"55.00\",\"cost_rate_per_hour\":\"200\",\"revenue_budget\":\"14.00\",\"cost_budget\":\"20.00\",\"budget_threshold\":\"10.00\",\"include_projects\":\"8000000005863\",\"applyportalrate\":\"-\",\"reporting_manager\":\"-\",\"reporting_to\":\"8000000002411\",\"hourly_budget\":\"5.00\",\"hourly_budget_threshold\":\"3.00\",\"business_hours_id\":\"-\"}]")
    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))
}

POST https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users?userdetails=%5B%7B%22email_id%22%3A%22mark%40zylker.com%22%2C%22email_template%22%3A%22-%22%2C%22role_id%22%3A%228000000000991%22%2C%22profile_id%22%3A%222223806000000022149%22%2C%22project_ids%22%3A%5B%2223806000074760021%22%5D%2C%22bulk_projects%22%3A%7B%22select_all%22%3A%22false%22%2C%22selected%22%3A%7B%22group_ids%22%3A%5B%222380600000612345%22%5D%2C%22project_ids%22%3A%5B%2223806000074760021%22%5D%7D%2C%22unselected%22%3A%7B%22group_ids%22%3A%5B%222380600000612345%22%5D%2C%22project_ids%22%3A%5B%2223806000074760021%22%5D%7D%2C%22rateupdatedprojects%22%3A%22-%22%2C%22costrateupdatedprojects%22%3A%22-%22%7D%2C%22rate%22%3A%2255.00%22%2C%22cost_rate_per_hour%22%3A%22200%22%2C%22revenue_budget%22%3A%2214.00%22%2C%22cost_budget%22%3A%2220.00%22%2C%22budget_threshold%22%3A%2210.00%22%2C%22include_projects%22%3A%228000000005863%22%2C%22applyportalrate%22%3A%22-%22%2C%22reporting_manager%22%3A%22-%22%2C%22reporting_to%22%3A%228000000002411%22%2C%22hourly_budget%22%3A%225.00%22%2C%22hourly_budget_threshold%22%3A%223.00%22%2C%22business_hours_id%22%3A%22-%22%7D%5D HTTP/1.1
Host: https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users?userdetails=%5B%7B%22email_id%22%3A%22mark%40zylker.com%22%2C%22email_template%22%3A%22-%22%2C%22role_id%22%3A%228000000000991%22%2C%22profile_id%22%3A%222223806000000022149%22%2C%22project_ids%22%3A%5B%2223806000074760021%22%5D%2C%22bulk_projects%22%3A%7B%22select_all%22%3A%22false%22%2C%22selected%22%3A%7B%22group_ids%22%3A%5B%222380600000612345%22%5D%2C%22project_ids%22%3A%5B%2223806000074760021%22%5D%7D%2C%22unselected%22%3A%7B%22group_ids%22%3A%5B%222380600000612345%22%5D%2C%22project_ids%22%3A%5B%2223806000074760021%22%5D%7D%2C%22rateupdatedprojects%22%3A%22-%22%2C%22costrateupdatedprojects%22%3A%22-%22%7D%2C%22rate%22%3A%2255.00%22%2C%22cost_rate_per_hour%22%3A%22200%22%2C%22revenue_budget%22%3A%2214.00%22%2C%22cost_budget%22%3A%2220.00%22%2C%22budget_threshold%22%3A%2210.00%22%2C%22include_projects%22%3A%228000000005863%22%2C%22applyportalrate%22%3A%22-%22%2C%22reporting_manager%22%3A%22-%22%2C%22reporting_to%22%3A%228000000002411%22%2C%22hourly_budget%22%3A%225.00%22%2C%22hourly_budget_threshold%22%3A%223.00%22%2C%22business_hours_id%22%3A%22-%22%7D%5D
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]/users");
uriBuilder.addParameter("userdetails", "[{\"email_id\":\"mark@zylker.com\",\"email_template\":\"-\",\"role_id\":\"8000000000991\",\"profile_id\":\"2223806000000022149\",\"project_ids\":[\"23806000074760021\"],\"bulk_projects\":{\"select_all\":\"false\",\"selected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"unselected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"rateupdatedprojects\":\"-\",\"costrateupdatedprojects\":\"-\"},\"rate\":\"55.00\",\"cost_rate_per_hour\":\"200\",\"revenue_budget\":\"14.00\",\"cost_budget\":\"20.00\",\"budget_threshold\":\"10.00\",\"include_projects\":\"8000000005863\",\"applyportalrate\":\"-\",\"reporting_manager\":\"-\",\"reporting_to\":\"8000000002411\",\"hourly_budget\":\"5.00\",\"hourly_budget_threshold\":\"3.00\",\"business_hours_id\":\"-\"}]");
HttpUriRequest requestObj = new HttpPost(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]/users';

const params = new URLSearchParams({
  'userdetails': '[{"email_id":"mark@zylker.com","email_template":"-","role_id":"8000000000991","profile_id":"2223806000000022149","project_ids":["23806000074760021"],"bulk_projects":{"select_all":"false","selected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"unselected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"rateupdatedprojects":"-","costrateupdatedprojects":"-"},"rate":"55.00","cost_rate_per_hour":"200","revenue_budget":"14.00","cost_budget":"20.00","budget_threshold":"10.00","include_projects":"8000000005863","applyportalrate":"-","reporting_manager":"-","reporting_to":"8000000002411","hourly_budget":"5.00","hourly_budget_threshold":"3.00","business_hours_id":"-"}]'
});

const options = {
  method: 'POST',
  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));

userdetails = [{"email_id":"mark@zylker.com","email_template":"-","role_id":"8000000000991","profile_id":"2223806000000022149","project_ids":["23806000074760021"],"bulk_projects":{"select_all":"false","selected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"unselected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"rateupdatedprojects":"-","costrateupdatedprojects":"-"},"rate":"55.00","cost_rate_per_hour":"200","revenue_budget":"14.00","cost_budget":"20.00","budget_threshold":"10.00","include_projects":"8000000005863","applyportalrate":"-","reporting_manager":"-","reporting_to":"8000000002411","hourly_budget":"5.00","hourly_budget_threshold":"3.00","business_hours_id":"-"}]

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]/users".toHttpUrl().newBuilder()
    urlBuilder.addQueryParameter("userdetails", "[{\"email_id\":\"mark@zylker.com\",\"email_template\":\"-\",\"role_id\":\"8000000000991\",\"profile_id\":\"2223806000000022149\",\"project_ids\":[\"23806000074760021\"],\"bulk_projects\":{\"select_all\":\"false\",\"selected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"unselected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"rateupdatedprojects\":\"-\",\"costrateupdatedprojects\":\"-\"},\"rate\":\"55.00\",\"cost_rate_per_hour\":\"200\",\"revenue_budget\":\"14.00\",\"cost_budget\":\"20.00\",\"budget_threshold\":\"10.00\",\"include_projects\":\"8000000005863\",\"applyportalrate\":\"-\",\"reporting_manager\":\"-\",\"reporting_to\":\"8000000002411\",\"hourly_budget\":\"5.00\",\"hourly_budget_threshold\":\"3.00\",\"business_hours_id\":\"-\"}]")
    val url = URL(urlBuilder.build().toString())
    val conn = url.openConnection() as HttpURLConnection
    conn.requestMethod = "POST"
    conn.setRequestProperty("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa")

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

NSString *encodedUserdetails = [@"[{\"email_id\":\"mark@zylker.com\",\"email_template\":\"-\",\"role_id\":\"8000000000991\",\"profile_id\":\"2223806000000022149\",\"project_ids\":[\"23806000074760021\"],\"bulk_projects\":{\"select_all\":\"false\",\"selected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"unselected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"rateupdatedprojects\":\"-\",\"costrateupdatedprojects\":\"-\"},\"rate\":\"55.00\",\"cost_rate_per_hour\":\"200\",\"revenue_budget\":\"14.00\",\"cost_budget\":\"20.00\",\"budget_threshold\":\"10.00\",\"include_projects\":\"8000000005863\",\"applyportalrate\":\"-\",\"reporting_manager\":\"-\",\"reporting_to\":\"8000000002411\",\"hourly_budget\":\"5.00\",\"hourly_budget_threshold\":\"3.00\",\"business_hours_id\":\"-\"}]" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *urlString = [NSString stringWithFormat:@"https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users?userdetails=%@", encodedUserdetails];
NSURL *url = [NSURL URLWithString:urlString];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:url];
[request setHTTPMethod:@"POST"];
[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_userdetails = Uri.pct_encode "[{\"email_id\":\"mark@zylker.com\",\"email_template\":\"-\",\"role_id\":\"8000000000991\",\"profile_id\":\"2223806000000022149\",\"project_ids\":[\"23806000074760021\"],\"bulk_projects\":{\"select_all\":\"false\",\"selected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"unselected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"rateupdatedprojects\":\"-\",\"costrateupdatedprojects\":\"-\"},\"rate\":\"55.00\",\"cost_rate_per_hour\":\"200\",\"revenue_budget\":\"14.00\",\"cost_budget\":\"20.00\",\"budget_threshold\":\"10.00\",\"include_projects\":\"8000000005863\",\"applyportalrate\":\"-\",\"reporting_manager\":\"-\",\"reporting_to\":\"8000000002411\",\"hourly_budget\":\"5.00\",\"hourly_budget_threshold\":\"3.00\",\"business_hours_id\":\"-\"}]" in
  let uri = Uri.of_string ("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users" ^ "?userdetails=" ^ enc_userdetails) in
  let headers = Cohttp.Header.init ()
    |> fun h -> Cohttp.Header.add h "Authorization" "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
  in
  Lwt_main.run (
    Client.post ~headers uri >>= fun (_, body) ->
    Cohttp_lwt.Body.to_string body >|= fun s ->
    print_endline s)

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

$params = @{
    userdetails = "[{`"email_id`":`"mark@zylker.com`",`"email_template`":`"-`",`"role_id`":`"8000000000991`",`"profile_id`":`"2223806000000022149`",`"project_ids`":[`"23806000074760021`"],`"bulk_projects`":{`"select_all`":`"false`",`"selected`":{`"group_ids`":[`"2380600000612345`"],`"project_ids`":[`"23806000074760021`"]},`"unselected`":{`"group_ids`":[`"2380600000612345`"],`"project_ids`":[`"23806000074760021`"]},`"rateupdatedprojects`":`"-`",`"costrateupdatedprojects`":`"-`"},`"rate`":`"55.00`",`"cost_rate_per_hour`":`"200`",`"revenue_budget`":`"14.00`",`"cost_budget`":`"20.00`",`"budget_threshold`":`"10.00`",`"include_projects`":`"8000000005863`",`"applyportalrate`":`"-`",`"reporting_manager`":`"-`",`"reporting_to`":`"8000000002411`",`"hourly_budget`":`"5.00`",`"hourly_budget_threshold`":`"3.00`",`"business_hours_id`":`"-`"}]"
}
$queryString = ($params.GetEnumerator() | ForEach-Object { "$($_.Key)=$([System.Uri]::EscapeDataString($_.Value))" }) -join "&"
$url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users" + "?" + $queryString

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

$response | ConvertTo-Json

library(httr)

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

params <- list(
  userdetails = "[{\"email_id\":\"mark@zylker.com\",\"email_template\":\"-\",\"role_id\":\"8000000000991\",\"profile_id\":\"2223806000000022149\",\"project_ids\":[\"23806000074760021\"],\"bulk_projects\":{\"select_all\":\"false\",\"selected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"unselected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"rateupdatedprojects\":\"-\",\"costrateupdatedprojects\":\"-\"},\"rate\":\"55.00\",\"cost_rate_per_hour\":\"200\",\"revenue_budget\":\"14.00\",\"cost_budget\":\"20.00\",\"budget_threshold\":\"10.00\",\"include_projects\":\"8000000005863\",\"applyportalrate\":\"-\",\"reporting_manager\":\"-\",\"reporting_to\":\"8000000002411\",\"hourly_budget\":\"5.00\",\"hourly_budget_threshold\":\"3.00\",\"business_hours_id\":\"-\"}]"
)

response <- POST(
  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]/users")!
components.queryItems = [
    URLQueryItem(name: "userdetails", value: "[{\"email_id\":\"mark@zylker.com\",\"email_template\":\"-\",\"role_id\":\"8000000000991\",\"profile_id\":\"2223806000000022149\",\"project_ids\":[\"23806000074760021\"],\"bulk_projects\":{\"select_all\":\"false\",\"selected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"unselected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"rateupdatedprojects\":\"-\",\"costrateupdatedprojects\":\"-\"},\"rate\":\"55.00\",\"cost_rate_per_hour\":\"200\",\"revenue_budget\":\"14.00\",\"cost_budget\":\"20.00\",\"budget_threshold\":\"10.00\",\"include_projects\":\"8000000005863\",\"applyportalrate\":\"-\",\"reporting_manager\":\"-\",\"reporting_to\":\"8000000002411\",\"hourly_budget\":\"5.00\",\"hourly_budget_threshold\":\"3.00\",\"business_hours_id\":\"-\"}]")
]
let url = components.url!
var request = URLRequest(url: url)
request.httpMethod = "POST"
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

userdetails : [ { "email_id" : "mark@zylker.com", "email_template" : "-", "role_id" : "8000000000991", "profile_id" : "2223806000000022149", "project_ids" : [ "23806000074760021" ], "bulk_projects" : { "select_all" : "false", "selected" : { "group_ids" : [ "2380600000612345" ], "project_ids" : [ "23806000074760021" ] }, "unselected" : { "group_ids" : [ "2380600000612345" ], "project_ids" : [ "23806000074760021" ] }, "rateupdatedprojects" : "-", "costrateupdatedprojects" : "-" }, "rate" : "55.00", "cost_rate_per_hour" : "200", "revenue_budget" : "14.00", "cost_budget" : "20.00", "budget_threshold" : "10.00", "include_projects" : "8000000005863", "applyportalrate" : "-", "reporting_manager" : "-", "reporting_to" : "8000000002411", "hourly_budget" : "5.00", "hourly_budget_threshold" : "3.00", "business_hours_id" : "-" } ]

Sample Response

201{ "is_upgrade" : "false", "emailvszpuid" : { "monica.hemsworth@zylker.com" : "7000044352064" }, "existing_users_list" : "[]", "active_user_count" : "10", "email_with_null_zuid" : [ "\"monica.hemsworth@zylker.com\"" ], "deactivated_Users" : "[]", "trouble_shoot" : "https://zoho.com/projects/help/add-project-users.html#troubleshoot-tips", "new_Users" : "[]", "success_emailId" : [ "\"monica.hemsworth@zylker.com\"" ], "users" : [ { "is_viewer_follower" : false, "profile_type" : 6, "role" : "Manager", "is_user_closed" : false, "loginname" : "0", "active" : 1, "reporting_to" : "zp.general.none", "REPORTING_TO" : { "zpuid" : "7000000002623", "full_name" : "zp.general.none", "email" : "Any User", "zuid" : "-1" }, "is_resend_invite" : false, "role_name" : "Manager", "profile_name" : "Manager", "zpuid" : "7000044352064", "last_updated_time" : 0, "role_id" : "7000000000991", "profile_id" : "7000000002347", "name" : "Monica Hemsworth", "is_user_confirmed" : false, "is_customized" : false, "is_group_user" : false, "id" : "0", "last_accessed_time" : "", "is_following" : false, "email" : "monica.hemsworth@zylker.com" } ], "is_portal_owner" : "true", "remaining_user_count" : "990", "curr_projid" : "0", "is_invoice_integ" : "false", "is_admin" : "true", "is_crmplus_plus" : "false", "user_count" : { "Contractor" : "1", "Employee" : "6", "jointadmin" : "1", "admin" : "1", "portalusers" : "10", "Manager" : "1" }, "existing_Users" : [ { "emailId" : "monica.hemsworth@zylker.com" } ], "in_active_user_count" : "0", "success_zpuid" : [ "\"7000044352064\"" ] }

Possible Errors

Add Client User

Add a new client user to the Zoho Projects portal. Use this API to invite and grant client-level access to a user within a portal.

POST

/api/v3/portal/[PORTAL_ID]/clientuser

OAuth Scope:

ZohoProjects.users.CREATE

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

userdetails

JSONArray

required

Enter the client user details.

force_add

boolean

Specify whether to convert existing contact users to client users.
Accepted valuess: True or False.

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]/clientuser' \
-H 'Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa' \
--form-string 'userdetails=[{"email_id":"mark@zylker.com","email_template":"-","profile_id":"2223806000000022149","company_name":"New Customer","customer_type":"-","company_id":"2223806000097701045","project_ids":["23806000074760021"],"bulk_projects":{"select_all":"false","selected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"unselected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"rateupdatedprojects":"-","costrateupdatedprojects":"-"},"rate":"55.00","include_projects":"8000000005863","cost_rate_per_hour":"200","revenue_budget":"14.00","cost_budget":"20.00","budget_threshold":"10.00","hourly_budget":"5.00","hourly_budget_threshold":"3.00"}]' \
--form-string 'force_add=true'

url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/clientuser";
params = Map();
params.put("userdetails", [{"email_id":"mark@zylker.com","email_template":"-","profile_id":"2223806000000022149","company_name":"New Customer","customer_type":"-","company_id":"2223806000097701045","project_ids":["23806000074760021"],"bulk_projects":{"select_all":"false","selected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"unselected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"rateupdatedprojects":"-","costrateupdatedprojects":"-"},"rate":"55.00","include_projects":"8000000005863","cost_rate_per_hour":"200","revenue_budget":"14.00","cost_budget":"20.00","budget_threshold":"10.00","hourly_budget":"5.00","hourly_budget_threshold":"3.00"}]);
params.put("force_add", "true");
response = invokeUrl
[
    url: url
    type: POST
    parameters: params
    connection: "projects"
];
info response;

const https = require('https');
const url = new URL('https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/clientuser');
url.searchParams.append('userdetails', '[{"email_id":"mark@zylker.com","email_template":"-","profile_id":"2223806000000022149","company_name":"New Customer","customer_type":"-","company_id":"2223806000097701045","project_ids":["23806000074760021"],"bulk_projects":{"select_all":"false","selected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"unselected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"rateupdatedprojects":"-","costrateupdatedprojects":"-"},"rate":"55.00","include_projects":"8000000005863","cost_rate_per_hour":"200","revenue_budget":"14.00","cost_budget":"20.00","budget_threshold":"10.00","hourly_budget":"5.00","hourly_budget_threshold":"3.00"}]');
url.searchParams.append('force_add', 'true');

const options = {
  hostname: url.hostname,
  path: url.pathname + url.search,
  method: 'POST',
  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]/clientuser")
params = {
  "userdetails" => "[{\"email_id\":\"mark@zylker.com\",\"email_template\":\"-\",\"profile_id\":\"2223806000000022149\",\"company_name\":\"New Customer\",\"customer_type\":\"-\",\"company_id\":\"2223806000097701045\",\"project_ids\":[\"23806000074760021\"],\"bulk_projects\":{\"select_all\":\"false\",\"selected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"unselected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"rateupdatedprojects\":\"-\",\"costrateupdatedprojects\":\"-\"},\"rate\":\"55.00\",\"include_projects\":\"8000000005863\",\"cost_rate_per_hour\":\"200\",\"revenue_budget\":\"14.00\",\"cost_budget\":\"20.00\",\"budget_threshold\":\"10.00\",\"hourly_budget\":\"5.00\",\"hourly_budget_threshold\":\"3.00\"}]",
  "force_add" => "true"
}
url.query = URI.encode_www_form(params)

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

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

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

<?php
$params = [
    'userdetails' => '[{"email_id":"mark@zylker.com","email_template":"-","profile_id":"2223806000000022149","company_name":"New Customer","customer_type":"-","company_id":"2223806000097701045","project_ids":["23806000074760021"],"bulk_projects":{"select_all":"false","selected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"unselected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"rateupdatedprojects":"-","costrateupdatedprojects":"-"},"rate":"55.00","include_projects":"8000000005863","cost_rate_per_hour":"200","revenue_budget":"14.00","cost_budget":"20.00","budget_threshold":"10.00","hourly_budget":"5.00","hourly_budget_threshold":"3.00"}]',
    'force_add' => 'true',
];
$url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/clientuser" . "?" . http_build_query($params);

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => $url,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "POST",
  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]/clientuser"

params = {
    "userdetails": "[{\"email_id\":\"mark@zylker.com\",\"email_template\":\"-\",\"profile_id\":\"2223806000000022149\",\"company_name\":\"New Customer\",\"customer_type\":\"-\",\"company_id\":\"2223806000097701045\",\"project_ids\":[\"23806000074760021\"],\"bulk_projects\":{\"select_all\":\"false\",\"selected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"unselected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"rateupdatedprojects\":\"-\",\"costrateupdatedprojects\":\"-\"},\"rate\":\"55.00\",\"include_projects\":\"8000000005863\",\"cost_rate_per_hour\":\"200\",\"revenue_budget\":\"14.00\",\"cost_budget\":\"20.00\",\"budget_threshold\":\"10.00\",\"hourly_budget\":\"5.00\",\"hourly_budget_threshold\":\"3.00\"}]",
    "force_add": "true"
}

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

response = requests.post(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_userdetails = curl_easy_escape(curl, "[{\"email_id\":\"mark@zylker.com\",\"email_template\":\"-\",\"profile_id\":\"2223806000000022149\",\"company_name\":\"New Customer\",\"customer_type\":\"-\",\"company_id\":\"2223806000097701045\",\"project_ids\":[\"23806000074760021\"],\"bulk_projects\":{\"select_all\":\"false\",\"selected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"unselected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"rateupdatedprojects\":\"-\",\"costrateupdatedprojects\":\"-\"},\"rate\":\"55.00\",\"include_projects\":\"8000000005863\",\"cost_rate_per_hour\":\"200\",\"revenue_budget\":\"14.00\",\"cost_budget\":\"20.00\",\"budget_threshold\":\"10.00\",\"hourly_budget\":\"5.00\",\"hourly_budget_threshold\":\"3.00\"}]", 0);
        char *enc_force_add = curl_easy_escape(curl, "true", 0);
        char url[2048];
        snprintf(url, sizeof(url), "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/clientuser?userdetails=%s&force_add=%s", enc_userdetails, enc_force_add);

        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, "POST");

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

        curl_free(enc_userdetails);
        curl_free(enc_force_add);
        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["userdetails"] = "[{\"email_id\":\"mark@zylker.com\",\"email_template\":\"-\",\"profile_id\":\"2223806000000022149\",\"company_name\":\"New Customer\",\"customer_type\":\"-\",\"company_id\":\"2223806000097701045\",\"project_ids\":[\"23806000074760021\"],\"bulk_projects\":{\"select_all\":\"false\",\"selected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"unselected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"rateupdatedprojects\":\"-\",\"costrateupdatedprojects\":\"-\"},\"rate\":\"55.00\",\"include_projects\":\"8000000005863\",\"cost_rate_per_hour\":\"200\",\"revenue_budget\":\"14.00\",\"cost_budget\":\"20.00\",\"budget_threshold\":\"10.00\",\"hourly_budget\":\"5.00\",\"hourly_budget_threshold\":\"3.00\"}]";
query["force_add"] = "true";
var uriBuilder = new UriBuilder("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/clientuser") { Query = query.ToString() };
var request = new HttpRequestMessage(HttpMethod.Post, 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_userdetails = curl_easy_escape(curl, "[{\"email_id\":\"mark@zylker.com\",\"email_template\":\"-\",\"profile_id\":\"2223806000000022149\",\"company_name\":\"New Customer\",\"customer_type\":\"-\",\"company_id\":\"2223806000097701045\",\"project_ids\":[\"23806000074760021\"],\"bulk_projects\":{\"select_all\":\"false\",\"selected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"unselected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"rateupdatedprojects\":\"-\",\"costrateupdatedprojects\":\"-\"},\"rate\":\"55.00\",\"include_projects\":\"8000000005863\",\"cost_rate_per_hour\":\"200\",\"revenue_budget\":\"14.00\",\"cost_budget\":\"20.00\",\"budget_threshold\":\"10.00\",\"hourly_budget\":\"5.00\",\"hourly_budget_threshold\":\"3.00\"}]", 0);
        char* enc_force_add = curl_easy_escape(curl, "true", 0);
        std::string url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/clientuser";
        url += "?userdetails=" + std::string(enc_userdetails);
        url += "&force_add=" + std::string(enc_force_add);

        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, "POST");
        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_userdetails);
        curl_free(enc_force_add);
        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}

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

(let [enc-userdetails (java.net.URLEncoder/encode "[{\"email_id\":\"mark@zylker.com\",\"email_template\":\"-\",\"profile_id\":\"2223806000000022149\",\"company_name\":\"New Customer\",\"customer_type\":\"-\",\"company_id\":\"2223806000097701045\",\"project_ids\":[\"23806000074760021\"],\"bulk_projects\":{\"select_all\":\"false\",\"selected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"unselected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"rateupdatedprojects\":\"-\",\"costrateupdatedprojects\":\"-\"},\"rate\":\"55.00\",\"include_projects\":\"8000000005863\",\"cost_rate_per_hour\":\"200\",\"revenue_budget\":\"14.00\",\"cost_budget\":\"20.00\",\"budget_threshold\":\"10.00\",\"hourly_budget\":\"5.00\",\"hourly_budget_threshold\":\"3.00\"}]" "UTF-8")
      enc-force_add (java.net.URLEncoder/encode "true" "UTF-8")
      url (str "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/clientuser" "?userdetails=" enc-userdetails "&force_add=" enc-force_add)]
(def response
  (client/post 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("POST", "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/clientuser", nil)
    q := req.URL.Query()
    q.Add("userdetails", "[{\"email_id\":\"mark@zylker.com\",\"email_template\":\"-\",\"profile_id\":\"2223806000000022149\",\"company_name\":\"New Customer\",\"customer_type\":\"-\",\"company_id\":\"2223806000097701045\",\"project_ids\":[\"23806000074760021\"],\"bulk_projects\":{\"select_all\":\"false\",\"selected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"unselected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"rateupdatedprojects\":\"-\",\"costrateupdatedprojects\":\"-\"},\"rate\":\"55.00\",\"include_projects\":\"8000000005863\",\"cost_rate_per_hour\":\"200\",\"revenue_budget\":\"14.00\",\"cost_budget\":\"20.00\",\"budget_threshold\":\"10.00\",\"hourly_budget\":\"5.00\",\"hourly_budget_threshold\":\"3.00\"}]")
    q.Add("force_add", "true")
    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))
}

POST https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/clientuser?userdetails=%5B%7B%22email_id%22%3A%22mark%40zylker.com%22%2C%22email_template%22%3A%22-%22%2C%22profile_id%22%3A%222223806000000022149%22%2C%22company_name%22%3A%22New+Customer%22%2C%22customer_type%22%3A%22-%22%2C%22company_id%22%3A%222223806000097701045%22%2C%22project_ids%22%3A%5B%2223806000074760021%22%5D%2C%22bulk_projects%22%3A%7B%22select_all%22%3A%22false%22%2C%22selected%22%3A%7B%22group_ids%22%3A%5B%222380600000612345%22%5D%2C%22project_ids%22%3A%5B%2223806000074760021%22%5D%7D%2C%22unselected%22%3A%7B%22group_ids%22%3A%5B%222380600000612345%22%5D%2C%22project_ids%22%3A%5B%2223806000074760021%22%5D%7D%2C%22rateupdatedprojects%22%3A%22-%22%2C%22costrateupdatedprojects%22%3A%22-%22%7D%2C%22rate%22%3A%2255.00%22%2C%22include_projects%22%3A%228000000005863%22%2C%22cost_rate_per_hour%22%3A%22200%22%2C%22revenue_budget%22%3A%2214.00%22%2C%22cost_budget%22%3A%2220.00%22%2C%22budget_threshold%22%3A%2210.00%22%2C%22hourly_budget%22%3A%225.00%22%2C%22hourly_budget_threshold%22%3A%223.00%22%7D%5D&force_add=true HTTP/1.1
Host: https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/clientuser?userdetails=%5B%7B%22email_id%22%3A%22mark%40zylker.com%22%2C%22email_template%22%3A%22-%22%2C%22profile_id%22%3A%222223806000000022149%22%2C%22company_name%22%3A%22New+Customer%22%2C%22customer_type%22%3A%22-%22%2C%22company_id%22%3A%222223806000097701045%22%2C%22project_ids%22%3A%5B%2223806000074760021%22%5D%2C%22bulk_projects%22%3A%7B%22select_all%22%3A%22false%22%2C%22selected%22%3A%7B%22group_ids%22%3A%5B%222380600000612345%22%5D%2C%22project_ids%22%3A%5B%2223806000074760021%22%5D%7D%2C%22unselected%22%3A%7B%22group_ids%22%3A%5B%222380600000612345%22%5D%2C%22project_ids%22%3A%5B%2223806000074760021%22%5D%7D%2C%22rateupdatedprojects%22%3A%22-%22%2C%22costrateupdatedprojects%22%3A%22-%22%7D%2C%22rate%22%3A%2255.00%22%2C%22include_projects%22%3A%228000000005863%22%2C%22cost_rate_per_hour%22%3A%22200%22%2C%22revenue_budget%22%3A%2214.00%22%2C%22cost_budget%22%3A%2220.00%22%2C%22budget_threshold%22%3A%2210.00%22%2C%22hourly_budget%22%3A%225.00%22%2C%22hourly_budget_threshold%22%3A%223.00%22%7D%5D&force_add=true
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]/clientuser");
uriBuilder.addParameter("userdetails", "[{\"email_id\":\"mark@zylker.com\",\"email_template\":\"-\",\"profile_id\":\"2223806000000022149\",\"company_name\":\"New Customer\",\"customer_type\":\"-\",\"company_id\":\"2223806000097701045\",\"project_ids\":[\"23806000074760021\"],\"bulk_projects\":{\"select_all\":\"false\",\"selected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"unselected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"rateupdatedprojects\":\"-\",\"costrateupdatedprojects\":\"-\"},\"rate\":\"55.00\",\"include_projects\":\"8000000005863\",\"cost_rate_per_hour\":\"200\",\"revenue_budget\":\"14.00\",\"cost_budget\":\"20.00\",\"budget_threshold\":\"10.00\",\"hourly_budget\":\"5.00\",\"hourly_budget_threshold\":\"3.00\"}]");
uriBuilder.addParameter("force_add", "true");
HttpUriRequest requestObj = new HttpPost(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]/clientuser';

const params = new URLSearchParams({
  'userdetails': '[{"email_id":"mark@zylker.com","email_template":"-","profile_id":"2223806000000022149","company_name":"New Customer","customer_type":"-","company_id":"2223806000097701045","project_ids":["23806000074760021"],"bulk_projects":{"select_all":"false","selected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"unselected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"rateupdatedprojects":"-","costrateupdatedprojects":"-"},"rate":"55.00","include_projects":"8000000005863","cost_rate_per_hour":"200","revenue_budget":"14.00","cost_budget":"20.00","budget_threshold":"10.00","hourly_budget":"5.00","hourly_budget_threshold":"3.00"}]',
  'force_add': 'true'
});

const options = {
  method: 'POST',
  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));

userdetails = [{"email_id":"mark@zylker.com","email_template":"-","profile_id":"2223806000000022149","company_name":"New Customer","customer_type":"-","company_id":"2223806000097701045","project_ids":["23806000074760021"],"bulk_projects":{"select_all":"false","selected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"unselected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"rateupdatedprojects":"-","costrateupdatedprojects":"-"},"rate":"55.00","include_projects":"8000000005863","cost_rate_per_hour":"200","revenue_budget":"14.00","cost_budget":"20.00","budget_threshold":"10.00","hourly_budget":"5.00","hourly_budget_threshold":"3.00"}]
force_add = "true"

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]/clientuser".toHttpUrl().newBuilder()
    urlBuilder.addQueryParameter("userdetails", "[{\"email_id\":\"mark@zylker.com\",\"email_template\":\"-\",\"profile_id\":\"2223806000000022149\",\"company_name\":\"New Customer\",\"customer_type\":\"-\",\"company_id\":\"2223806000097701045\",\"project_ids\":[\"23806000074760021\"],\"bulk_projects\":{\"select_all\":\"false\",\"selected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"unselected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"rateupdatedprojects\":\"-\",\"costrateupdatedprojects\":\"-\"},\"rate\":\"55.00\",\"include_projects\":\"8000000005863\",\"cost_rate_per_hour\":\"200\",\"revenue_budget\":\"14.00\",\"cost_budget\":\"20.00\",\"budget_threshold\":\"10.00\",\"hourly_budget\":\"5.00\",\"hourly_budget_threshold\":\"3.00\"}]")
    urlBuilder.addQueryParameter("force_add", "true")
    val url = URL(urlBuilder.build().toString())
    val conn = url.openConnection() as HttpURLConnection
    conn.requestMethod = "POST"
    conn.setRequestProperty("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa")

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

NSString *encodedUserdetails = [@"[{\"email_id\":\"mark@zylker.com\",\"email_template\":\"-\",\"profile_id\":\"2223806000000022149\",\"company_name\":\"New Customer\",\"customer_type\":\"-\",\"company_id\":\"2223806000097701045\",\"project_ids\":[\"23806000074760021\"],\"bulk_projects\":{\"select_all\":\"false\",\"selected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"unselected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"rateupdatedprojects\":\"-\",\"costrateupdatedprojects\":\"-\"},\"rate\":\"55.00\",\"include_projects\":\"8000000005863\",\"cost_rate_per_hour\":\"200\",\"revenue_budget\":\"14.00\",\"cost_budget\":\"20.00\",\"budget_threshold\":\"10.00\",\"hourly_budget\":\"5.00\",\"hourly_budget_threshold\":\"3.00\"}]" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *encodedForce_add = [@"true" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *urlString = [NSString stringWithFormat:@"https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/clientuser?userdetails=%@&force_add=%@", encodedUserdetails, encodedForce_add];
NSURL *url = [NSURL URLWithString:urlString];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:url];
[request setHTTPMethod:@"POST"];
[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_userdetails = Uri.pct_encode "[{\"email_id\":\"mark@zylker.com\",\"email_template\":\"-\",\"profile_id\":\"2223806000000022149\",\"company_name\":\"New Customer\",\"customer_type\":\"-\",\"company_id\":\"2223806000097701045\",\"project_ids\":[\"23806000074760021\"],\"bulk_projects\":{\"select_all\":\"false\",\"selected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"unselected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"rateupdatedprojects\":\"-\",\"costrateupdatedprojects\":\"-\"},\"rate\":\"55.00\",\"include_projects\":\"8000000005863\",\"cost_rate_per_hour\":\"200\",\"revenue_budget\":\"14.00\",\"cost_budget\":\"20.00\",\"budget_threshold\":\"10.00\",\"hourly_budget\":\"5.00\",\"hourly_budget_threshold\":\"3.00\"}]" in
  let enc_force_add = Uri.pct_encode "true" in
  let uri = Uri.of_string ("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/clientuser" ^ "?userdetails=" ^ enc_userdetails ^ "&force_add=" ^ enc_force_add) in
  let headers = Cohttp.Header.init ()
    |> fun h -> Cohttp.Header.add h "Authorization" "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
  in
  Lwt_main.run (
    Client.post ~headers uri >>= fun (_, body) ->
    Cohttp_lwt.Body.to_string body >|= fun s ->
    print_endline s)

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

$params = @{
    userdetails = "[{`"email_id`":`"mark@zylker.com`",`"email_template`":`"-`",`"profile_id`":`"2223806000000022149`",`"company_name`":`"New Customer`",`"customer_type`":`"-`",`"company_id`":`"2223806000097701045`",`"project_ids`":[`"23806000074760021`"],`"bulk_projects`":{`"select_all`":`"false`",`"selected`":{`"group_ids`":[`"2380600000612345`"],`"project_ids`":[`"23806000074760021`"]},`"unselected`":{`"group_ids`":[`"2380600000612345`"],`"project_ids`":[`"23806000074760021`"]},`"rateupdatedprojects`":`"-`",`"costrateupdatedprojects`":`"-`"},`"rate`":`"55.00`",`"include_projects`":`"8000000005863`",`"cost_rate_per_hour`":`"200`",`"revenue_budget`":`"14.00`",`"cost_budget`":`"20.00`",`"budget_threshold`":`"10.00`",`"hourly_budget`":`"5.00`",`"hourly_budget_threshold`":`"3.00`"}]"
    force_add = "true"
}
$queryString = ($params.GetEnumerator() | ForEach-Object { "$($_.Key)=$([System.Uri]::EscapeDataString($_.Value))" }) -join "&"
$url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/clientuser" + "?" + $queryString

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

$response | ConvertTo-Json

library(httr)

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

params <- list(
  userdetails = "[{\"email_id\":\"mark@zylker.com\",\"email_template\":\"-\",\"profile_id\":\"2223806000000022149\",\"company_name\":\"New Customer\",\"customer_type\":\"-\",\"company_id\":\"2223806000097701045\",\"project_ids\":[\"23806000074760021\"],\"bulk_projects\":{\"select_all\":\"false\",\"selected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"unselected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"rateupdatedprojects\":\"-\",\"costrateupdatedprojects\":\"-\"},\"rate\":\"55.00\",\"include_projects\":\"8000000005863\",\"cost_rate_per_hour\":\"200\",\"revenue_budget\":\"14.00\",\"cost_budget\":\"20.00\",\"budget_threshold\":\"10.00\",\"hourly_budget\":\"5.00\",\"hourly_budget_threshold\":\"3.00\"}]",
  force_add = "true"
)

response <- POST(
  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]/clientuser")!
components.queryItems = [
    URLQueryItem(name: "userdetails", value: "[{\"email_id\":\"mark@zylker.com\",\"email_template\":\"-\",\"profile_id\":\"2223806000000022149\",\"company_name\":\"New Customer\",\"customer_type\":\"-\",\"company_id\":\"2223806000097701045\",\"project_ids\":[\"23806000074760021\"],\"bulk_projects\":{\"select_all\":\"false\",\"selected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"unselected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"rateupdatedprojects\":\"-\",\"costrateupdatedprojects\":\"-\"},\"rate\":\"55.00\",\"include_projects\":\"8000000005863\",\"cost_rate_per_hour\":\"200\",\"revenue_budget\":\"14.00\",\"cost_budget\":\"20.00\",\"budget_threshold\":\"10.00\",\"hourly_budget\":\"5.00\",\"hourly_budget_threshold\":\"3.00\"}]"),
    URLQueryItem(name: "force_add", value: "true")
]
let url = components.url!
var request = URLRequest(url: url)
request.httpMethod = "POST"
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

userdetails : [ { "email_id" : "mark@zylker.com", "email_template" : "-", "profile_id" : "2223806000000022149", "company_name" : "New Customer", "customer_type" : "-", "company_id" : "2223806000097701045", "project_ids" : [ "23806000074760021" ], "bulk_projects" : { "select_all" : "false", "selected" : { "group_ids" : [ "2380600000612345" ], "project_ids" : [ "23806000074760021" ] }, "unselected" : { "group_ids" : [ "2380600000612345" ], "project_ids" : [ "23806000074760021" ] }, "rateupdatedprojects" : "-", "costrateupdatedprojects" : "-" }, "rate" : "55.00", "include_projects" : "8000000005863", "cost_rate_per_hour" : "200", "revenue_budget" : "14.00", "cost_budget" : "20.00", "budget_threshold" : "10.00", "hourly_budget" : "5.00", "hourly_budget_threshold" : "3.00" } ] force_add : "true"

Sample Response

201{ "is_upgrade" : "false", "emailvszpuid" : { "monica.hemsworth@zylker.com" : "103368000002484148" }, "existing_users_list" : "[]", "active_user_count" : "189", "email_with_null_zuid" : [ "\"monica.hemsworth@zylker.com\"" ], "trouble_shoot" : "https://zoho.com/projects/help/add-project-users.html#troubleshoot-tips", "success_emailId" : [ "\"monica.hemsworth@zylker.com\"" ], "Deactivated_Users" : "[]", "users" : [ { "is_active" : true, "profile_type" : 3, "is_user_closed" : false, "company_id" : "103368000000048925", "is_resend_invite" : false, "current_zpuid" : "103368000000048003", "profile_name" : "client", "zpuid" : "103368000002484148", "profile_id" : 103368000000079017, "company_name" : "Prime Minister", "name" : "Monica Hemsworth", "is_user_confirmed" : false, "id" : "2", "email" : "monica.hemsworth@zylker.com" } ], "is_portal_owner" : "true", "remaining_user_count" : "431", "is_invoice_integ" : "true", "is_admin" : "true", "is_crmplus_plus" : "false", "Existing_Users" : [ { "emailId" : "monica.hemsworth@zylker.com" } ], "user_count" : { "Contractor" : "82", "jointadmin" : "4", "New Profile" : "1", "admin" : "44", "portalusers" : "211", "Employee" : "20", "Manager" : "59", "Profile1" : "1" }, "in_active_user_count" : "22", "client_user_count" : "380", "success_zpuid" : [ "103368000002484148" ], "New_Users" : "[]" }

Possible Errors

Activate User

Activate a specific user in a portal. Use this API to restore a deactivated user's access to the portal.

POST

/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/activate

OAuth Scope:

ZohoProjects.users.UPDATE

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).

user_id

String

required
regex : [0-9]+

Identifier of an user. Obtained from the Get Users API - the "id" field in the response corresponds to user_id.

Query Parameters

Param Name

Data Type

Description

notify

String

required

Specify whether to notify the user about the activation.
Accepted values: true or false.

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]/users/[USER_ID]/activate' \
-H 'Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa' \
--form-string 'notify=true'

url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/activate";
params = Map();
params.put("notify", "true");
response = invokeUrl
[
    url: url
    type: POST
    parameters: params
    connection: "projects"
];
info response;

const https = require('https');
const url = new URL('https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/activate');
url.searchParams.append('notify', 'true');

const options = {
  hostname: url.hostname,
  path: url.pathname + url.search,
  method: 'POST',
  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]/users/[USER_ID]/activate")
params = {
  "notify" => "true"
}
url.query = URI.encode_www_form(params)

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

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

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

<?php
$params = [
    'notify' => 'true',
];
$url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/activate" . "?" . http_build_query($params);

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => $url,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "POST",
  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]/users/[USER_ID]/activate"

params = {
    "notify": "true"
}

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

response = requests.post(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_notify = curl_easy_escape(curl, "true", 0);
        char url[2048];
        snprintf(url, sizeof(url), "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/activate?notify=%s", enc_notify);

        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, "POST");

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

        curl_free(enc_notify);
        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["notify"] = "true";
var uriBuilder = new UriBuilder("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/activate") { Query = query.ToString() };
var request = new HttpRequestMessage(HttpMethod.Post, 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_notify = curl_easy_escape(curl, "true", 0);
        std::string url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/activate";
        url += "?notify=" + std::string(enc_notify);

        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, "POST");
        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_notify);
        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}

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

(let [enc-notify (java.net.URLEncoder/encode "true" "UTF-8")
      url (str "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/activate" "?notify=" enc-notify)]
(def response
  (client/post 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("POST", "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/activate", nil)
    q := req.URL.Query()
    q.Add("notify", "true")
    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))
}

POST https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/activate?notify=true HTTP/1.1
Host: https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/activate?notify=true
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]/users/[USER_ID]/activate");
uriBuilder.addParameter("notify", "true");
HttpUriRequest requestObj = new HttpPost(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]/users/[USER_ID]/activate';

const params = new URLSearchParams({
  'notify': 'true'
});

const options = {
  method: 'POST',
  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));

notify = "true"

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]/users/[USER_ID]/activate".toHttpUrl().newBuilder()
    urlBuilder.addQueryParameter("notify", "true")
    val url = URL(urlBuilder.build().toString())
    val conn = url.openConnection() as HttpURLConnection
    conn.requestMethod = "POST"
    conn.setRequestProperty("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa")

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

NSString *encodedNotify = [@"true" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *urlString = [NSString stringWithFormat:@"https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/activate?notify=%@", encodedNotify];
NSURL *url = [NSURL URLWithString:urlString];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:url];
[request setHTTPMethod:@"POST"];
[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_notify = Uri.pct_encode "true" in
  let uri = Uri.of_string ("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/activate" ^ "?notify=" ^ enc_notify) in
  let headers = Cohttp.Header.init ()
    |> fun h -> Cohttp.Header.add h "Authorization" "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
  in
  Lwt_main.run (
    Client.post ~headers uri >>= fun (_, body) ->
    Cohttp_lwt.Body.to_string body >|= fun s ->
    print_endline s)

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

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

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

$response | ConvertTo-Json

library(httr)

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

params <- list(
  notify = "true"
)

response <- POST(
  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]/users/[USER_ID]/activate")!
components.queryItems = [
    URLQueryItem(name: "notify", value: "true")
]
let url = components.url!
var request = URLRequest(url: url)
request.httpMethod = "POST"
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

notify : "true"

Sample Response

200{ "response" : "User Activated Successfully" }

Possible Errors

Deactivate User

Deactivate a specific user in a portal. Use this API to revoke a user's access to the portal without permanently removing their account.

POST

/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/deactivate

OAuth Scope:

ZohoProjects.users.UPDATE

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).

user_id

String

required
regex : [0-9]+

Identifier of an user. Obtained from the Get Users API - the "id" field in the response corresponds to user_id.

Query Parameters

Param Name

Data Type

Description

notify

String

required

Specify whether to notify the user about the deactivation.
Accepted values: True or False.

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]/users/[USER_ID]/deactivate' \
-H 'Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa' \
--form-string 'notify=true'

url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/deactivate";
params = Map();
params.put("notify", "true");
response = invokeUrl
[
    url: url
    type: POST
    parameters: params
    connection: "projects"
];
info response;

const https = require('https');
const url = new URL('https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/deactivate');
url.searchParams.append('notify', 'true');

const options = {
  hostname: url.hostname,
  path: url.pathname + url.search,
  method: 'POST',
  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]/users/[USER_ID]/deactivate")
params = {
  "notify" => "true"
}
url.query = URI.encode_www_form(params)

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

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

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

<?php
$params = [
    'notify' => 'true',
];
$url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/deactivate" . "?" . http_build_query($params);

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => $url,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "POST",
  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]/users/[USER_ID]/deactivate"

params = {
    "notify": "true"
}

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

response = requests.post(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_notify = curl_easy_escape(curl, "true", 0);
        char url[2048];
        snprintf(url, sizeof(url), "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/deactivate?notify=%s", enc_notify);

        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, "POST");

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

        curl_free(enc_notify);
        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["notify"] = "true";
var uriBuilder = new UriBuilder("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/deactivate") { Query = query.ToString() };
var request = new HttpRequestMessage(HttpMethod.Post, 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_notify = curl_easy_escape(curl, "true", 0);
        std::string url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/deactivate";
        url += "?notify=" + std::string(enc_notify);

        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, "POST");
        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_notify);
        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}

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

(let [enc-notify (java.net.URLEncoder/encode "true" "UTF-8")
      url (str "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/deactivate" "?notify=" enc-notify)]
(def response
  (client/post 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("POST", "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/deactivate", nil)
    q := req.URL.Query()
    q.Add("notify", "true")
    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))
}

POST https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/deactivate?notify=true HTTP/1.1
Host: https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/deactivate?notify=true
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]/users/[USER_ID]/deactivate");
uriBuilder.addParameter("notify", "true");
HttpUriRequest requestObj = new HttpPost(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]/users/[USER_ID]/deactivate';

const params = new URLSearchParams({
  'notify': 'true'
});

const options = {
  method: 'POST',
  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));

notify = "true"

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]/users/[USER_ID]/deactivate".toHttpUrl().newBuilder()
    urlBuilder.addQueryParameter("notify", "true")
    val url = URL(urlBuilder.build().toString())
    val conn = url.openConnection() as HttpURLConnection
    conn.requestMethod = "POST"
    conn.setRequestProperty("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa")

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

NSString *encodedNotify = [@"true" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *urlString = [NSString stringWithFormat:@"https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/deactivate?notify=%@", encodedNotify];
NSURL *url = [NSURL URLWithString:urlString];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:url];
[request setHTTPMethod:@"POST"];
[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_notify = Uri.pct_encode "true" in
  let uri = Uri.of_string ("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/deactivate" ^ "?notify=" ^ enc_notify) in
  let headers = Cohttp.Header.init ()
    |> fun h -> Cohttp.Header.add h "Authorization" "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
  in
  Lwt_main.run (
    Client.post ~headers uri >>= fun (_, body) ->
    Cohttp_lwt.Body.to_string body >|= fun s ->
    print_endline s)

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

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

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

$response | ConvertTo-Json

library(httr)

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

params <- list(
  notify = "true"
)

response <- POST(
  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]/users/[USER_ID]/deactivate")!
components.queryItems = [
    URLQueryItem(name: "notify", value: "true")
]
let url = components.url!
var request = URLRequest(url: url)
request.httpMethod = "POST"
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

notify : "true"

Sample Response

200{ "response" : "User Deactivated Successfully" }

Possible Errors

Activate Client User

Activate a specific client user in a portal. Use this API to restore a deactivated client user's access to the portal.

POST

/api/v3/portal/[PORTAL_ID]/client-users/[CLIENT-USER_ID]/activate

OAuth Scope:

ZohoProjects.users.UPDATE

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).

client-user_id

String

required

Identifier of a client user. Obtained from the Get All Portal Users, Client Users, and Contacts API - the "id" field in the response corresponds to client-user_id.

Query Parameters

Param Name

Data Type

Description

notify

String

required

Specify whether to notify the user about the activation.
Accepted values: True or False.

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]/client-users/[CLIENT-USER_ID]/activate' \
-H 'Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa' \
--form-string 'notify=true'

url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/client-users/[CLIENT-USER_ID]/activate";
params = Map();
params.put("notify", "true");
response = invokeUrl
[
    url: url
    type: POST
    parameters: params
    connection: "projects"
];
info response;

const https = require('https');
const url = new URL('https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/client-users/[CLIENT-USER_ID]/activate');
url.searchParams.append('notify', 'true');

const options = {
  hostname: url.hostname,
  path: url.pathname + url.search,
  method: 'POST',
  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]/client-users/[CLIENT-USER_ID]/activate")
params = {
  "notify" => "true"
}
url.query = URI.encode_www_form(params)

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

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

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

<?php
$params = [
    'notify' => 'true',
];
$url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/client-users/[CLIENT-USER_ID]/activate" . "?" . http_build_query($params);

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => $url,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "POST",
  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]/client-users/[CLIENT-USER_ID]/activate"

params = {
    "notify": "true"
}

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

response = requests.post(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_notify = curl_easy_escape(curl, "true", 0);
        char url[2048];
        snprintf(url, sizeof(url), "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/client-users/[CLIENT-USER_ID]/activate?notify=%s", enc_notify);

        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, "POST");

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

        curl_free(enc_notify);
        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["notify"] = "true";
var uriBuilder = new UriBuilder("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/client-users/[CLIENT-USER_ID]/activate") { Query = query.ToString() };
var request = new HttpRequestMessage(HttpMethod.Post, 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_notify = curl_easy_escape(curl, "true", 0);
        std::string url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/client-users/[CLIENT-USER_ID]/activate";
        url += "?notify=" + std::string(enc_notify);

        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, "POST");
        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_notify);
        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}

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

(let [enc-notify (java.net.URLEncoder/encode "true" "UTF-8")
      url (str "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/client-users/[CLIENT-USER_ID]/activate" "?notify=" enc-notify)]
(def response
  (client/post 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("POST", "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/client-users/[CLIENT-USER_ID]/activate", nil)
    q := req.URL.Query()
    q.Add("notify", "true")
    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))
}

POST https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/client-users/[CLIENT-USER_ID]/activate?notify=true HTTP/1.1
Host: https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/client-users/[CLIENT-USER_ID]/activate?notify=true
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]/client-users/[CLIENT-USER_ID]/activate");
uriBuilder.addParameter("notify", "true");
HttpUriRequest requestObj = new HttpPost(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]/client-users/[CLIENT-USER_ID]/activate';

const params = new URLSearchParams({
  'notify': 'true'
});

const options = {
  method: 'POST',
  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));

notify = "true"

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]/client-users/[CLIENT-USER_ID]/activate".toHttpUrl().newBuilder()
    urlBuilder.addQueryParameter("notify", "true")
    val url = URL(urlBuilder.build().toString())
    val conn = url.openConnection() as HttpURLConnection
    conn.requestMethod = "POST"
    conn.setRequestProperty("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa")

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

NSString *encodedNotify = [@"true" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *urlString = [NSString stringWithFormat:@"https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/client-users/[CLIENT-USER_ID]/activate?notify=%@", encodedNotify];
NSURL *url = [NSURL URLWithString:urlString];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:url];
[request setHTTPMethod:@"POST"];
[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_notify = Uri.pct_encode "true" in
  let uri = Uri.of_string ("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/client-users/[CLIENT-USER_ID]/activate" ^ "?notify=" ^ enc_notify) in
  let headers = Cohttp.Header.init ()
    |> fun h -> Cohttp.Header.add h "Authorization" "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
  in
  Lwt_main.run (
    Client.post ~headers uri >>= fun (_, body) ->
    Cohttp_lwt.Body.to_string body >|= fun s ->
    print_endline s)

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

$params = @{
    notify = "true"
}
$queryString = ($params.GetEnumerator() | ForEach-Object { "$($_.Key)=$([System.Uri]::EscapeDataString($_.Value))" }) -join "&"
$url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/client-users/[CLIENT-USER_ID]/activate" + "?" + $queryString

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

$response | ConvertTo-Json

library(httr)

url <- "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/client-users/[CLIENT-USER_ID]/activate"

params <- list(
  notify = "true"
)

response <- POST(
  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]/client-users/[CLIENT-USER_ID]/activate")!
components.queryItems = [
    URLQueryItem(name: "notify", value: "true")
]
let url = components.url!
var request = URLRequest(url: url)
request.httpMethod = "POST"
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

notify : "true"

Sample Response

200{ "response" : "User Activated Successfully" }

Possible Errors

Deactivate Client User

Deactivate a specific client user in a portal. Use this API to revoke a client user's access to the portal without permanently removing their account.

POST

/api/v3/portal/[PORTAL_ID]/client-users/[CLIENT-USER_ID]/deactivate

OAuth Scope:

ZohoProjects.users.UPDATE

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).

client-user_id

String

required

Identifier of a client user. Obtained from the Get All Portal Users, Client Users, and Contacts API - the "id" field in the response corresponds to client-user_id.

Query Parameters

Param Name

Data Type

Description

notify

String

required

Specify whether to notify the client user about the deactivation.
Accepted values: True or False.

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]/client-users/[CLIENT-USER_ID]/deactivate' \
-H 'Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa' \
--form-string 'notify=true'

url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/client-users/[CLIENT-USER_ID]/deactivate";
params = Map();
params.put("notify", "true");
response = invokeUrl
[
    url: url
    type: POST
    parameters: params
    connection: "projects"
];
info response;

const https = require('https');
const url = new URL('https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/client-users/[CLIENT-USER_ID]/deactivate');
url.searchParams.append('notify', 'true');

const options = {
  hostname: url.hostname,
  path: url.pathname + url.search,
  method: 'POST',
  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]/client-users/[CLIENT-USER_ID]/deactivate")
params = {
  "notify" => "true"
}
url.query = URI.encode_www_form(params)

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

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

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

<?php
$params = [
    'notify' => 'true',
];
$url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/client-users/[CLIENT-USER_ID]/deactivate" . "?" . http_build_query($params);

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => $url,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "POST",
  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]/client-users/[CLIENT-USER_ID]/deactivate"

params = {
    "notify": "true"
}

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

response = requests.post(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_notify = curl_easy_escape(curl, "true", 0);
        char url[2048];
        snprintf(url, sizeof(url), "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/client-users/[CLIENT-USER_ID]/deactivate?notify=%s", enc_notify);

        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, "POST");

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

        curl_free(enc_notify);
        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["notify"] = "true";
var uriBuilder = new UriBuilder("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/client-users/[CLIENT-USER_ID]/deactivate") { Query = query.ToString() };
var request = new HttpRequestMessage(HttpMethod.Post, 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_notify = curl_easy_escape(curl, "true", 0);
        std::string url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/client-users/[CLIENT-USER_ID]/deactivate";
        url += "?notify=" + std::string(enc_notify);

        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, "POST");
        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_notify);
        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}

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

(let [enc-notify (java.net.URLEncoder/encode "true" "UTF-8")
      url (str "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/client-users/[CLIENT-USER_ID]/deactivate" "?notify=" enc-notify)]
(def response
  (client/post 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("POST", "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/client-users/[CLIENT-USER_ID]/deactivate", nil)
    q := req.URL.Query()
    q.Add("notify", "true")
    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))
}

POST https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/client-users/[CLIENT-USER_ID]/deactivate?notify=true HTTP/1.1
Host: https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/client-users/[CLIENT-USER_ID]/deactivate?notify=true
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]/client-users/[CLIENT-USER_ID]/deactivate");
uriBuilder.addParameter("notify", "true");
HttpUriRequest requestObj = new HttpPost(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]/client-users/[CLIENT-USER_ID]/deactivate';

const params = new URLSearchParams({
  'notify': 'true'
});

const options = {
  method: 'POST',
  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));

notify = "true"

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]/client-users/[CLIENT-USER_ID]/deactivate".toHttpUrl().newBuilder()
    urlBuilder.addQueryParameter("notify", "true")
    val url = URL(urlBuilder.build().toString())
    val conn = url.openConnection() as HttpURLConnection
    conn.requestMethod = "POST"
    conn.setRequestProperty("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa")

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

NSString *encodedNotify = [@"true" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *urlString = [NSString stringWithFormat:@"https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/client-users/[CLIENT-USER_ID]/deactivate?notify=%@", encodedNotify];
NSURL *url = [NSURL URLWithString:urlString];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:url];
[request setHTTPMethod:@"POST"];
[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_notify = Uri.pct_encode "true" in
  let uri = Uri.of_string ("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/client-users/[CLIENT-USER_ID]/deactivate" ^ "?notify=" ^ enc_notify) in
  let headers = Cohttp.Header.init ()
    |> fun h -> Cohttp.Header.add h "Authorization" "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
  in
  Lwt_main.run (
    Client.post ~headers uri >>= fun (_, body) ->
    Cohttp_lwt.Body.to_string body >|= fun s ->
    print_endline s)

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

$params = @{
    notify = "true"
}
$queryString = ($params.GetEnumerator() | ForEach-Object { "$($_.Key)=$([System.Uri]::EscapeDataString($_.Value))" }) -join "&"
$url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/client-users/[CLIENT-USER_ID]/deactivate" + "?" + $queryString

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

$response | ConvertTo-Json

library(httr)

url <- "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/client-users/[CLIENT-USER_ID]/deactivate"

params <- list(
  notify = "true"
)

response <- POST(
  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]/client-users/[CLIENT-USER_ID]/deactivate")!
components.queryItems = [
    URLQueryItem(name: "notify", value: "true")
]
let url = components.url!
var request = URLRequest(url: url)
request.httpMethod = "POST"
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

notify : "true"

Sample Response

200{ "response" : "User Deactivated Successfully" }

Possible Errors

Update User (Deprecated)

This API is deprecated. Use Update User (v3.1) instead.

Update the user profile and rate in the Zoho Projects portal.

POST

/api/v3/portal/[PORTAL_ID]/users/[USER_ID]

OAuth Scope:

ZohoProjects.users.UPDATE

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).

user_id

String

required
regex : [0-9]+

Identifier of an user. Obtained from the Get Users API - the "id" field in the response corresponds to user_id.

Query Parameters

Param Name

Data Type

Description

companyrole

int

Enter the role ID of the user. You can obtain it from the Get Roles API (the "id" field in the response).

companyprofile

int

Enter the profile ID of the user. You can obtain it from the Get Profiles API (the "id" field in the response).

invoice

String

Enter the invoice rate, e.g., $30 per hour.

costrate

String

Enter the cost per hour, e.g., $15 per hour.

isapplyportalrate

boolean

Specify whether the user rate applies at the portal level.
Accepted values: true, false

bulkprojects

JSONObject

Enter the project details

reporting_manager

int

Specify the reporting manager.

reporting_to

int

Specify the reporting manager. You can obtain it from the Get Portal Users API (the "id" field in the response).

notify

boolean

Specify whether the user should be notified about updates.
Accepted values: true, false.

cost_effective_from_date

String

Date from which changes to Cost Per Hour should take effect.

business_hours_id

int

The business hours id of the user. You can obtain it from the Get Business Hours API (the "id" field in the response).

skillset

JSONObject

max length : 500000

Enter the skill association details for the user.

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]/users/[USER_ID]' \
-H 'Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa' \
--form-string 'companyrole=170876000004915003' \
--form-string 'companyprofile=170876000003941041' \
--form-string 'invoice=30.00' \
--form-string 'costrate=15.00' \
--form-string 'isapplyportalrate=false' \
--form-string 'bulkprojects={"select_all":"false","selected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"unselected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"rateupdatedprojects":"-","costrateupdatedprojects":"-"}' \
--form-string 'reporting_manager=8000000002411' \
--form-string 'reporting_to=8000000002411' \
--form-string 'notify=true' \
--form-string 'cost_effective_from_date=2024-08-21' \
--form-string 'business_hours_id=-' \
--form-string 'skillset={"add":[{"id":"-","level":"-"}],"remove":[{"id":"-"}]}'

url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]";
params = Map();
params.put("companyrole", "170876000004915003");
params.put("companyprofile", "170876000003941041");
params.put("invoice", "30.00");
params.put("costrate", "15.00");
params.put("isapplyportalrate", "false");
params.put("bulkprojects", {"select_all":"false","selected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"unselected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"rateupdatedprojects":"-","costrateupdatedprojects":"-"});
params.put("reporting_manager", "8000000002411");
params.put("reporting_to", "8000000002411");
params.put("notify", "true");
params.put("cost_effective_from_date", "2024-08-21");
params.put("business_hours_id", "-");
params.put("skillset", {"add":[{"id":"-","level":"-"}],"remove":[{"id":"-"}]});
response = invokeUrl
[
    url: url
    type: POST
    parameters: params
    connection: "projects"
];
info response;

const https = require('https');
const url = new URL('https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]');
url.searchParams.append('companyrole', '170876000004915003');
url.searchParams.append('companyprofile', '170876000003941041');
url.searchParams.append('invoice', '30.00');
url.searchParams.append('costrate', '15.00');
url.searchParams.append('isapplyportalrate', 'false');
url.searchParams.append('bulkprojects', '{"select_all":"false","selected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"unselected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"rateupdatedprojects":"-","costrateupdatedprojects":"-"}');
url.searchParams.append('reporting_manager', '8000000002411');
url.searchParams.append('reporting_to', '8000000002411');
url.searchParams.append('notify', 'true');
url.searchParams.append('cost_effective_from_date', '2024-08-21');
url.searchParams.append('business_hours_id', '-');
url.searchParams.append('skillset', '{"add":[{"id":"-","level":"-"}],"remove":[{"id":"-"}]}');

const options = {
  hostname: url.hostname,
  path: url.pathname + url.search,
  method: 'POST',
  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]/users/[USER_ID]")
params = {
  "companyrole" => "170876000004915003",
  "companyprofile" => "170876000003941041",
  "invoice" => "30.00",
  "costrate" => "15.00",
  "isapplyportalrate" => "false",
  "bulkprojects" => "{\"select_all\":\"false\",\"selected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"unselected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"rateupdatedprojects\":\"-\",\"costrateupdatedprojects\":\"-\"}",
  "reporting_manager" => "8000000002411",
  "reporting_to" => "8000000002411",
  "notify" => "true",
  "cost_effective_from_date" => "2024-08-21",
  "business_hours_id" => "-",
  "skillset" => "{\"add\":[{\"id\":\"-\",\"level\":\"-\"}],\"remove\":[{\"id\":\"-\"}]}"
}
url.query = URI.encode_www_form(params)

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

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

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

<?php
$params = [
    'companyrole' => '170876000004915003',
    'companyprofile' => '170876000003941041',
    'invoice' => '30.00',
    'costrate' => '15.00',
    'isapplyportalrate' => 'false',
    'bulkprojects' => '{"select_all":"false","selected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"unselected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"rateupdatedprojects":"-","costrateupdatedprojects":"-"}',
    'reporting_manager' => '8000000002411',
    'reporting_to' => '8000000002411',
    'notify' => 'true',
    'cost_effective_from_date' => '2024-08-21',
    'business_hours_id' => '-',
    'skillset' => '{"add":[{"id":"-","level":"-"}],"remove":[{"id":"-"}]}',
];
$url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]" . "?" . http_build_query($params);

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => $url,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "POST",
  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]/users/[USER_ID]"

params = {
    "companyrole": "170876000004915003",
    "companyprofile": "170876000003941041",
    "invoice": "30.00",
    "costrate": "15.00",
    "isapplyportalrate": "false",
    "bulkprojects": "{\"select_all\":\"false\",\"selected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"unselected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"rateupdatedprojects\":\"-\",\"costrateupdatedprojects\":\"-\"}",
    "reporting_manager": "8000000002411",
    "reporting_to": "8000000002411",
    "notify": "true",
    "cost_effective_from_date": "2024-08-21",
    "business_hours_id": "-",
    "skillset": "{\"add\":[{\"id\":\"-\",\"level\":\"-\"}],\"remove\":[{\"id\":\"-\"}]}"
}

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

response = requests.post(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_companyrole = curl_easy_escape(curl, "170876000004915003", 0);
        char *enc_companyprofile = curl_easy_escape(curl, "170876000003941041", 0);
        char *enc_invoice = curl_easy_escape(curl, "30.00", 0);
        char *enc_costrate = curl_easy_escape(curl, "15.00", 0);
        char *enc_isapplyportalrate = curl_easy_escape(curl, "false", 0);
        char *enc_bulkprojects = curl_easy_escape(curl, "{\"select_all\":\"false\",\"selected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"unselected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"rateupdatedprojects\":\"-\",\"costrateupdatedprojects\":\"-\"}", 0);
        char *enc_reporting_manager = curl_easy_escape(curl, "8000000002411", 0);
        char *enc_reporting_to = curl_easy_escape(curl, "8000000002411", 0);
        char *enc_notify = curl_easy_escape(curl, "true", 0);
        char *enc_cost_effective_from_date = curl_easy_escape(curl, "2024-08-21", 0);
        char *enc_business_hours_id = curl_easy_escape(curl, "-", 0);
        char *enc_skillset = curl_easy_escape(curl, "{\"add\":[{\"id\":\"-\",\"level\":\"-\"}],\"remove\":[{\"id\":\"-\"}]}", 0);
        char url[2048];
        snprintf(url, sizeof(url), "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]?companyrole=%s&companyprofile=%s&invoice=%s&costrate=%s&isapplyportalrate=%s&bulkprojects=%s&reporting_manager=%s&reporting_to=%s&notify=%s&cost_effective_from_date=%s&business_hours_id=%s&skillset=%s", enc_companyrole, enc_companyprofile, enc_invoice, enc_costrate, enc_isapplyportalrate, enc_bulkprojects, enc_reporting_manager, enc_reporting_to, enc_notify, enc_cost_effective_from_date, enc_business_hours_id, enc_skillset);

        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, "POST");

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

        curl_free(enc_companyrole);
        curl_free(enc_companyprofile);
        curl_free(enc_invoice);
        curl_free(enc_costrate);
        curl_free(enc_isapplyportalrate);
        curl_free(enc_bulkprojects);
        curl_free(enc_reporting_manager);
        curl_free(enc_reporting_to);
        curl_free(enc_notify);
        curl_free(enc_cost_effective_from_date);
        curl_free(enc_business_hours_id);
        curl_free(enc_skillset);
        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["companyrole"] = "170876000004915003";
query["companyprofile"] = "170876000003941041";
query["invoice"] = "30.00";
query["costrate"] = "15.00";
query["isapplyportalrate"] = "false";
query["bulkprojects"] = "{\"select_all\":\"false\",\"selected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"unselected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"rateupdatedprojects\":\"-\",\"costrateupdatedprojects\":\"-\"}";
query["reporting_manager"] = "8000000002411";
query["reporting_to"] = "8000000002411";
query["notify"] = "true";
query["cost_effective_from_date"] = "2024-08-21";
query["business_hours_id"] = "-";
query["skillset"] = "{\"add\":[{\"id\":\"-\",\"level\":\"-\"}],\"remove\":[{\"id\":\"-\"}]}";
var uriBuilder = new UriBuilder("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]") { Query = query.ToString() };
var request = new HttpRequestMessage(HttpMethod.Post, 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_companyrole = curl_easy_escape(curl, "170876000004915003", 0);
        char* enc_companyprofile = curl_easy_escape(curl, "170876000003941041", 0);
        char* enc_invoice = curl_easy_escape(curl, "30.00", 0);
        char* enc_costrate = curl_easy_escape(curl, "15.00", 0);
        char* enc_isapplyportalrate = curl_easy_escape(curl, "false", 0);
        char* enc_bulkprojects = curl_easy_escape(curl, "{\"select_all\":\"false\",\"selected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"unselected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"rateupdatedprojects\":\"-\",\"costrateupdatedprojects\":\"-\"}", 0);
        char* enc_reporting_manager = curl_easy_escape(curl, "8000000002411", 0);
        char* enc_reporting_to = curl_easy_escape(curl, "8000000002411", 0);
        char* enc_notify = curl_easy_escape(curl, "true", 0);
        char* enc_cost_effective_from_date = curl_easy_escape(curl, "2024-08-21", 0);
        char* enc_business_hours_id = curl_easy_escape(curl, "-", 0);
        char* enc_skillset = curl_easy_escape(curl, "{\"add\":[{\"id\":\"-\",\"level\":\"-\"}],\"remove\":[{\"id\":\"-\"}]}", 0);
        std::string url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]";
        url += "?companyrole=" + std::string(enc_companyrole);
        url += "&companyprofile=" + std::string(enc_companyprofile);
        url += "&invoice=" + std::string(enc_invoice);
        url += "&costrate=" + std::string(enc_costrate);
        url += "&isapplyportalrate=" + std::string(enc_isapplyportalrate);
        url += "&bulkprojects=" + std::string(enc_bulkprojects);
        url += "&reporting_manager=" + std::string(enc_reporting_manager);
        url += "&reporting_to=" + std::string(enc_reporting_to);
        url += "&notify=" + std::string(enc_notify);
        url += "&cost_effective_from_date=" + std::string(enc_cost_effective_from_date);
        url += "&business_hours_id=" + std::string(enc_business_hours_id);
        url += "&skillset=" + std::string(enc_skillset);

        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, "POST");
        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_companyrole);
        curl_free(enc_companyprofile);
        curl_free(enc_invoice);
        curl_free(enc_costrate);
        curl_free(enc_isapplyportalrate);
        curl_free(enc_bulkprojects);
        curl_free(enc_reporting_manager);
        curl_free(enc_reporting_to);
        curl_free(enc_notify);
        curl_free(enc_cost_effective_from_date);
        curl_free(enc_business_hours_id);
        curl_free(enc_skillset);
        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}

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

(let [enc-companyrole (java.net.URLEncoder/encode "170876000004915003" "UTF-8")
      enc-companyprofile (java.net.URLEncoder/encode "170876000003941041" "UTF-8")
      enc-invoice (java.net.URLEncoder/encode "30.00" "UTF-8")
      enc-costrate (java.net.URLEncoder/encode "15.00" "UTF-8")
      enc-isapplyportalrate (java.net.URLEncoder/encode "false" "UTF-8")
      enc-bulkprojects (java.net.URLEncoder/encode "{\"select_all\":\"false\",\"selected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"unselected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"rateupdatedprojects\":\"-\",\"costrateupdatedprojects\":\"-\"}" "UTF-8")
      enc-reporting_manager (java.net.URLEncoder/encode "8000000002411" "UTF-8")
      enc-reporting_to (java.net.URLEncoder/encode "8000000002411" "UTF-8")
      enc-notify (java.net.URLEncoder/encode "true" "UTF-8")
      enc-cost_effective_from_date (java.net.URLEncoder/encode "2024-08-21" "UTF-8")
      enc-business_hours_id (java.net.URLEncoder/encode "-" "UTF-8")
      enc-skillset (java.net.URLEncoder/encode "{\"add\":[{\"id\":\"-\",\"level\":\"-\"}],\"remove\":[{\"id\":\"-\"}]}" "UTF-8")
      url (str "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]" "?companyrole=" enc-companyrole "&companyprofile=" enc-companyprofile "&invoice=" enc-invoice "&costrate=" enc-costrate "&isapplyportalrate=" enc-isapplyportalrate "&bulkprojects=" enc-bulkprojects "&reporting_manager=" enc-reporting_manager "&reporting_to=" enc-reporting_to "&notify=" enc-notify "&cost_effective_from_date=" enc-cost_effective_from_date "&business_hours_id=" enc-business_hours_id "&skillset=" enc-skillset)]
(def response
  (client/post 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("POST", "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]", nil)
    q := req.URL.Query()
    q.Add("companyrole", "170876000004915003")
    q.Add("companyprofile", "170876000003941041")
    q.Add("invoice", "30.00")
    q.Add("costrate", "15.00")
    q.Add("isapplyportalrate", "false")
    q.Add("bulkprojects", "{\"select_all\":\"false\",\"selected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"unselected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"rateupdatedprojects\":\"-\",\"costrateupdatedprojects\":\"-\"}")
    q.Add("reporting_manager", "8000000002411")
    q.Add("reporting_to", "8000000002411")
    q.Add("notify", "true")
    q.Add("cost_effective_from_date", "2024-08-21")
    q.Add("business_hours_id", "-")
    q.Add("skillset", "{\"add\":[{\"id\":\"-\",\"level\":\"-\"}],\"remove\":[{\"id\":\"-\"}]}")
    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))
}

POST https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]?companyrole=170876000004915003&companyprofile=170876000003941041&invoice=30.00&costrate=15.00&isapplyportalrate=false&bulkprojects=%7B%22select_all%22%3A%22false%22%2C%22selected%22%3A%7B%22group_ids%22%3A%5B%222380600000612345%22%5D%2C%22project_ids%22%3A%5B%2223806000074760021%22%5D%7D%2C%22unselected%22%3A%7B%22group_ids%22%3A%5B%222380600000612345%22%5D%2C%22project_ids%22%3A%5B%2223806000074760021%22%5D%7D%2C%22rateupdatedprojects%22%3A%22-%22%2C%22costrateupdatedprojects%22%3A%22-%22%7D&reporting_manager=8000000002411&reporting_to=8000000002411&notify=true&cost_effective_from_date=2024-08-21&business_hours_id=-&skillset=%7B%22add%22%3A%5B%7B%22id%22%3A%22-%22%2C%22level%22%3A%22-%22%7D%5D%2C%22remove%22%3A%5B%7B%22id%22%3A%22-%22%7D%5D%7D HTTP/1.1
Host: https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]?companyrole=170876000004915003&companyprofile=170876000003941041&invoice=30.00&costrate=15.00&isapplyportalrate=false&bulkprojects=%7B%22select_all%22%3A%22false%22%2C%22selected%22%3A%7B%22group_ids%22%3A%5B%222380600000612345%22%5D%2C%22project_ids%22%3A%5B%2223806000074760021%22%5D%7D%2C%22unselected%22%3A%7B%22group_ids%22%3A%5B%222380600000612345%22%5D%2C%22project_ids%22%3A%5B%2223806000074760021%22%5D%7D%2C%22rateupdatedprojects%22%3A%22-%22%2C%22costrateupdatedprojects%22%3A%22-%22%7D&reporting_manager=8000000002411&reporting_to=8000000002411&notify=true&cost_effective_from_date=2024-08-21&business_hours_id=-&skillset=%7B%22add%22%3A%5B%7B%22id%22%3A%22-%22%2C%22level%22%3A%22-%22%7D%5D%2C%22remove%22%3A%5B%7B%22id%22%3A%22-%22%7D%5D%7D
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]/users/[USER_ID]");
uriBuilder.addParameter("companyrole", "170876000004915003");
uriBuilder.addParameter("companyprofile", "170876000003941041");
uriBuilder.addParameter("invoice", "30.00");
uriBuilder.addParameter("costrate", "15.00");
uriBuilder.addParameter("isapplyportalrate", "false");
uriBuilder.addParameter("bulkprojects", "{\"select_all\":\"false\",\"selected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"unselected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"rateupdatedprojects\":\"-\",\"costrateupdatedprojects\":\"-\"}");
uriBuilder.addParameter("reporting_manager", "8000000002411");
uriBuilder.addParameter("reporting_to", "8000000002411");
uriBuilder.addParameter("notify", "true");
uriBuilder.addParameter("cost_effective_from_date", "2024-08-21");
uriBuilder.addParameter("business_hours_id", "-");
uriBuilder.addParameter("skillset", "{\"add\":[{\"id\":\"-\",\"level\":\"-\"}],\"remove\":[{\"id\":\"-\"}]}");
HttpUriRequest requestObj = new HttpPost(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]/users/[USER_ID]';

const params = new URLSearchParams({
  'companyrole': '170876000004915003',
  'companyprofile': '170876000003941041',
  'invoice': '30.00',
  'costrate': '15.00',
  'isapplyportalrate': 'false',
  'bulkprojects': '{"select_all":"false","selected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"unselected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"rateupdatedprojects":"-","costrateupdatedprojects":"-"}',
  'reporting_manager': '8000000002411',
  'reporting_to': '8000000002411',
  'notify': 'true',
  'cost_effective_from_date': '2024-08-21',
  'business_hours_id': '-',
  'skillset': '{"add":[{"id":"-","level":"-"}],"remove":[{"id":"-"}]}'
});

const options = {
  method: 'POST',
  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));

companyrole = "170876000004915003"
companyprofile = "170876000003941041"
invoice = "30.00"
costrate = "15.00"
isapplyportalrate = "false"
bulkprojects = {"select_all":"false","selected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"unselected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"rateupdatedprojects":"-","costrateupdatedprojects":"-"}
reporting_manager = "8000000002411"
reporting_to = "8000000002411"
notify = "true"
cost_effective_from_date = "2024-08-21"
business_hours_id =  - 
skillset = {"add":[{"id":"-","level":"-"}],"remove":[{"id":"-"}]}

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]/users/[USER_ID]".toHttpUrl().newBuilder()
    urlBuilder.addQueryParameter("companyrole", "170876000004915003")
    urlBuilder.addQueryParameter("companyprofile", "170876000003941041")
    urlBuilder.addQueryParameter("invoice", "30.00")
    urlBuilder.addQueryParameter("costrate", "15.00")
    urlBuilder.addQueryParameter("isapplyportalrate", "false")
    urlBuilder.addQueryParameter("bulkprojects", "{\"select_all\":\"false\",\"selected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"unselected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"rateupdatedprojects\":\"-\",\"costrateupdatedprojects\":\"-\"}")
    urlBuilder.addQueryParameter("reporting_manager", "8000000002411")
    urlBuilder.addQueryParameter("reporting_to", "8000000002411")
    urlBuilder.addQueryParameter("notify", "true")
    urlBuilder.addQueryParameter("cost_effective_from_date", "2024-08-21")
    urlBuilder.addQueryParameter("business_hours_id", "-")
    urlBuilder.addQueryParameter("skillset", "{\"add\":[{\"id\":\"-\",\"level\":\"-\"}],\"remove\":[{\"id\":\"-\"}]}")
    val url = URL(urlBuilder.build().toString())
    val conn = url.openConnection() as HttpURLConnection
    conn.requestMethod = "POST"
    conn.setRequestProperty("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa")

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

NSString *encodedCompanyrole = [@"170876000004915003" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *encodedCompanyprofile = [@"170876000003941041" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *encodedInvoice = [@"30.00" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *encodedCostrate = [@"15.00" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *encodedIsapplyportalrate = [@"false" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *encodedBulkprojects = [@"{\"select_all\":\"false\",\"selected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"unselected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"rateupdatedprojects\":\"-\",\"costrateupdatedprojects\":\"-\"}" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *encodedReporting_manager = [@"8000000002411" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *encodedReporting_to = [@"8000000002411" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *encodedNotify = [@"true" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *encodedCost_effective_from_date = [@"2024-08-21" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *encodedBusiness_hours_id = [@"-" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *encodedSkillset = [@"{\"add\":[{\"id\":\"-\",\"level\":\"-\"}],\"remove\":[{\"id\":\"-\"}]}" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *urlString = [NSString stringWithFormat:@"https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]?companyrole=%@&companyprofile=%@&invoice=%@&costrate=%@&isapplyportalrate=%@&bulkprojects=%@&reporting_manager=%@&reporting_to=%@&notify=%@&cost_effective_from_date=%@&business_hours_id=%@&skillset=%@", encodedCompanyrole, encodedCompanyprofile, encodedInvoice, encodedCostrate, encodedIsapplyportalrate, encodedBulkprojects, encodedReporting_manager, encodedReporting_to, encodedNotify, encodedCost_effective_from_date, encodedBusiness_hours_id, encodedSkillset];
NSURL *url = [NSURL URLWithString:urlString];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:url];
[request setHTTPMethod:@"POST"];
[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_companyrole = Uri.pct_encode "170876000004915003" in
  let enc_companyprofile = Uri.pct_encode "170876000003941041" in
  let enc_invoice = Uri.pct_encode "30.00" in
  let enc_costrate = Uri.pct_encode "15.00" in
  let enc_isapplyportalrate = Uri.pct_encode "false" in
  let enc_bulkprojects = Uri.pct_encode "{\"select_all\":\"false\",\"selected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"unselected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"rateupdatedprojects\":\"-\",\"costrateupdatedprojects\":\"-\"}" in
  let enc_reporting_manager = Uri.pct_encode "8000000002411" in
  let enc_reporting_to = Uri.pct_encode "8000000002411" in
  let enc_notify = Uri.pct_encode "true" in
  let enc_cost_effective_from_date = Uri.pct_encode "2024-08-21" in
  let enc_business_hours_id = Uri.pct_encode "-" in
  let enc_skillset = Uri.pct_encode "{\"add\":[{\"id\":\"-\",\"level\":\"-\"}],\"remove\":[{\"id\":\"-\"}]}" in
  let uri = Uri.of_string ("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]" ^ "?companyrole=" ^ enc_companyrole ^ "&companyprofile=" ^ enc_companyprofile ^ "&invoice=" ^ enc_invoice ^ "&costrate=" ^ enc_costrate ^ "&isapplyportalrate=" ^ enc_isapplyportalrate ^ "&bulkprojects=" ^ enc_bulkprojects ^ "&reporting_manager=" ^ enc_reporting_manager ^ "&reporting_to=" ^ enc_reporting_to ^ "&notify=" ^ enc_notify ^ "&cost_effective_from_date=" ^ enc_cost_effective_from_date ^ "&business_hours_id=" ^ enc_business_hours_id ^ "&skillset=" ^ enc_skillset) in
  let headers = Cohttp.Header.init ()
    |> fun h -> Cohttp.Header.add h "Authorization" "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
  in
  Lwt_main.run (
    Client.post ~headers uri >>= fun (_, body) ->
    Cohttp_lwt.Body.to_string body >|= fun s ->
    print_endline s)

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

$params = @{
    companyrole = "170876000004915003"
    companyprofile = "170876000003941041"
    invoice = "30.00"
    costrate = "15.00"
    isapplyportalrate = "false"
    bulkprojects = "{`"select_all`":`"false`",`"selected`":{`"group_ids`":[`"2380600000612345`"],`"project_ids`":[`"23806000074760021`"]},`"unselected`":{`"group_ids`":[`"2380600000612345`"],`"project_ids`":[`"23806000074760021`"]},`"rateupdatedprojects`":`"-`",`"costrateupdatedprojects`":`"-`"}"
    reporting_manager = "8000000002411"
    reporting_to = "8000000002411"
    notify = "true"
    cost_effective_from_date = "2024-08-21"
    business_hours_id = "-"
    skillset = "{`"add`":[{`"id`":`"-`",`"level`":`"-`"}],`"remove`":[{`"id`":`"-`"}]}"
}
$queryString = ($params.GetEnumerator() | ForEach-Object { "$($_.Key)=$([System.Uri]::EscapeDataString($_.Value))" }) -join "&"
$url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]" + "?" + $queryString

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

$response | ConvertTo-Json

library(httr)

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

params <- list(
  companyrole = "170876000004915003",
  companyprofile = "170876000003941041",
  invoice = "30.00",
  costrate = "15.00",
  isapplyportalrate = "false",
  bulkprojects = "{\"select_all\":\"false\",\"selected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"unselected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"rateupdatedprojects\":\"-\",\"costrateupdatedprojects\":\"-\"}",
  reporting_manager = "8000000002411",
  reporting_to = "8000000002411",
  notify = "true",
  cost_effective_from_date = "2024-08-21",
  business_hours_id = "-",
  skillset = "{\"add\":[{\"id\":\"-\",\"level\":\"-\"}],\"remove\":[{\"id\":\"-\"}]}"
)

response <- POST(
  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]/users/[USER_ID]")!
components.queryItems = [
    URLQueryItem(name: "companyrole", value: "170876000004915003"),
    URLQueryItem(name: "companyprofile", value: "170876000003941041"),
    URLQueryItem(name: "invoice", value: "30.00"),
    URLQueryItem(name: "costrate", value: "15.00"),
    URLQueryItem(name: "isapplyportalrate", value: "false"),
    URLQueryItem(name: "bulkprojects", value: "{\"select_all\":\"false\",\"selected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"unselected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"rateupdatedprojects\":\"-\",\"costrateupdatedprojects\":\"-\"}"),
    URLQueryItem(name: "reporting_manager", value: "8000000002411"),
    URLQueryItem(name: "reporting_to", value: "8000000002411"),
    URLQueryItem(name: "notify", value: "true"),
    URLQueryItem(name: "cost_effective_from_date", value: "2024-08-21"),
    URLQueryItem(name: "business_hours_id", value: "-"),
    URLQueryItem(name: "skillset", value: "{\"add\":[{\"id\":\"-\",\"level\":\"-\"}],\"remove\":[{\"id\":\"-\"}]}")
]
let url = components.url!
var request = URLRequest(url: url)
request.httpMethod = "POST"
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

companyrole : "170876000004915003" companyprofile : "170876000003941041" invoice : "30.00" costrate : "15.00" isapplyportalrate : "false" bulkprojects : { "select_all" : "false", "selected" : { "group_ids" : [ "2380600000612345" ], "project_ids" : [ "23806000074760021" ] }, "unselected" : { "group_ids" : [ "2380600000612345" ], "project_ids" : [ "23806000074760021" ] }, "rateupdatedprojects" : "-", "costrateupdatedprojects" : "-" } reporting_manager : "8000000002411" reporting_to : "8000000002411" notify : "true" cost_effective_from_date : "2024-08-21" business_hours_id : - skillset : { "add" : [ { "id" : "-", "level" : "-" } ], "remove" : [ { "id" : "-" } ] }

Sample Response

200{ "CURR_PROJID" : "0", "ISOFFICEUSER" : "false", "CURR_USERZUID" : "66295825", "CURR_USERZPUID" : "103368000000048003", "USERLIST" : [ { "ISRESENDINVITE" : false, "PROFILE_ID" : "103368000000048364", "DISPLAYNAME" : "Monica", "ZPUID" : "103368000002484141", "reporting_to" : "Monica Hemsworth", "REPORTING_TO" : { "zpuid" : "103368000000048003", "full_name" : "Monica Hemsworth", "email" : "monica.hemsworth@zylker.com", "zuid" : "66295825" }, "INVOICE" : "0.00", "EMAIL" : "monica.hemsworth@zylker.com", "ISACTIVE" : true, "ZPRole" : "Administrator", "reporting_to_zpuid" : "103368000000048003", "COST_PER_HOUR" : "100.00", "PROFILE_NAME" : "Contractor", "last_updated_time" : 1715326760885, "role_id" : "103368000000048005", "ISUSERCLOSED" : false, "PROFILETYPE" : 8, "LOGINNAME" : 69014231 } ], "ACTIVEUSERCOUNT" : "189", "CURRENCY_CODE" : "?", "ISINVINTEG" : "true", "INACTIVEUSERCOUNT" : "22", "REMAININGUSERCOUNT" : "431", "SUBORDINATE_USER_COUNT" : "177", "ISPORTALOWNER" : "true", "ISADMIN" : "true", "USERCNT" : { "Contractor" : "82", "jointadmin" : "4", "New Profile" : "1", "admin" : "44", "portalusers" : "211", "Employeeu" : "20", "Manager" : "59", "Profile1" : "1" }, "CURR_ROLE" : "admin", "REMAININGREADONLYUSERCOUNT" : "405", "ISUPGRADE" : "false", "ISCRMPLUSPORTAL" : "false", "ISDEMOUSER" : "false", "DIRECT_USER_COUNT" : "177" }

Possible Errors

Get User Details (Deprecated)

This API is deprecated. Use Get User Details (v3.1) instead.

Retrieve the details of a specific user in a portal. Use this API to access the full profile and information of a user within a portal.

GET

/api/v3/portal/[PORTAL_ID]/users/[USER_ID]

OAuth Scope:

ZohoProjects.users.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).

user_id

String

required
regex : [0-9]+

Identifier of an user. Obtained from the Get Users API - the "id" field in the response corresponds to user_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 GET \
'https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]' \
-H 'Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa'

url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]";
response = invokeUrl
[
    url: url
    type: GET
    connection: "projects"
];
info response;

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

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]/users/[USER_ID]")

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
$url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]";

$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]/users/[USER_ID]"

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

response = requests.get(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]/users/[USER_ID]");
        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_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.Get, "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_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]/users/[USER_ID]");
        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_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}

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

(def response
  (client/get "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]"
    {:headers {"Authorization" "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"}
     :as :json}))

(println (:body response))

package main

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

func main() {
    req, _ := http.NewRequest("GET", "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_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))
}

GET https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID] HTTP/1.1
Host: https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_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]/users/[USER_ID]");
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]/users/[USER_ID]';

const options = {
  method: 'GET',
  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]/users/[USER_ID]")
    val conn = url.openConnection() as HttpURLConnection
    conn.requestMethod = "GET"
    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]/users/[USER_ID]"];
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 uri = Uri.of_string "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_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"
}

$response = Invoke-RestMethod -Uri "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]" -Method GET -Headers $headers

$response | ConvertTo-Json

library(httr)

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

response <- GET(
  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]/users/[USER_ID]")!
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 Response

200{ "updated_time" : "2024-05-10T07:39:15.862Z", "added_time" : "2024-05-10T07:39:14.876Z", "is_active" : "true", "role" : { "name" : "Administrator", "id" : "103368000000048005", "type" : "1" }, "deactivated_by" : "Monica Hemsworth", "time_of_request" : "1969-12-31T23:59:59.999Z", "is_confirmed" : "false", "profile" : { "name" : "Contractor", "id" : "103368000000048364", "type" : "8", "is_default" : "true" }, "last_name" : "Hemsworth", "reporting_to" : { "full_name" : "Monica Hemsworth", "last_name" : "Hemsworth", "id" : "103368000000048003", "first_name" : "Monica", "zuid" : "66295825" }, "display_name" : "Monica", "zuid" : "69014231", "full_name" : "Monica Hemsworth", "user_type" : "1", "id" : "103368000002484141", "invoice" : "0.000", "first_name" : "Monica", "email" : "monica.hemsworth@zylker.com", "status" : "1", "budget" : { "rate_per_hour" : "0.000", "cost_per_hour" : "0.000", "type" : "none" } }

Possible Errors

Delete User

Remove a specific user from a portal. Use this API to permanently revoke a user's access to a portal.

DELETE

/api/v3/portal/[PORTAL_ID]/users/[USER_ID]

OAuth Scope:

ZohoProjects.users.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).

user_id

String

required
regex : [0-9]+

Identifier of an user. Obtained from the Get Users API - the "id" field in the response corresponds to user_id.

Query Parameters

Param Name

Data Type

Description

notify

String

required

Specify whether to notify the user.
Accepted values: true,false

reporting_manager

int

Enter the reporting manager of the user.

reporting_to

int

Enter the reporting manager of the user. You can obtain it from the Get Portal Users API (the "id" field in the response).

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 DELETE \
'https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]?notify=true&reporting_manager=8000000002411&reporting_to=8000000002411' \
-H 'Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa'

url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]";
params = Map();
params.put("notify", "true");
params.put("reporting_manager", "8000000002411");
params.put("reporting_to", "8000000002411");
response = invokeUrl
[
    url: url
    type: DELETE
    parameters: params
    connection: "projects"
];
info response;

const https = require('https');
const url = new URL('https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]');
url.searchParams.append('notify', 'true');
url.searchParams.append('reporting_manager', '8000000002411');
url.searchParams.append('reporting_to', '8000000002411');

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]/users/[USER_ID]")
params = {
  "notify" => "true",
  "reporting_manager" => "8000000002411",
  "reporting_to" => "8000000002411"
}
url.query = URI.encode_www_form(params)

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
$params = [
    'notify' => 'true',
    'reporting_manager' => '8000000002411',
    'reporting_to' => '8000000002411',
];
$url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]" . "?" . http_build_query($params);

$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]/users/[USER_ID]"

params = {
    "notify": "true",
    "reporting_manager": "8000000002411",
    "reporting_to": "8000000002411"
}

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

response = requests.delete(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_notify = curl_easy_escape(curl, "true", 0);
        char *enc_reporting_manager = curl_easy_escape(curl, "8000000002411", 0);
        char *enc_reporting_to = curl_easy_escape(curl, "8000000002411", 0);
        char url[2048];
        snprintf(url, sizeof(url), "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]?notify=%s&reporting_manager=%s&reporting_to=%s", enc_notify, enc_reporting_manager, enc_reporting_to);

        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, "DELETE");

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

        curl_free(enc_notify);
        curl_free(enc_reporting_manager);
        curl_free(enc_reporting_to);
        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["notify"] = "true";
query["reporting_manager"] = "8000000002411";
query["reporting_to"] = "8000000002411";
var uriBuilder = new UriBuilder("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]") { Query = query.ToString() };
var request = new HttpRequestMessage(HttpMethod.Delete, 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_notify = curl_easy_escape(curl, "true", 0);
        char* enc_reporting_manager = curl_easy_escape(curl, "8000000002411", 0);
        char* enc_reporting_to = curl_easy_escape(curl, "8000000002411", 0);
        std::string url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]";
        url += "?notify=" + std::string(enc_notify);
        url += "&reporting_manager=" + std::string(enc_reporting_manager);
        url += "&reporting_to=" + std::string(enc_reporting_to);

        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, "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_free(enc_notify);
        curl_free(enc_reporting_manager);
        curl_free(enc_reporting_to);
        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}

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

(let [enc-notify (java.net.URLEncoder/encode "true" "UTF-8")
      enc-reporting_manager (java.net.URLEncoder/encode "8000000002411" "UTF-8")
      enc-reporting_to (java.net.URLEncoder/encode "8000000002411" "UTF-8")
      url (str "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]" "?notify=" enc-notify "&reporting_manager=" enc-reporting_manager "&reporting_to=" enc-reporting_to)]
(def response
  (client/delete 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("DELETE", "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]", nil)
    q := req.URL.Query()
    q.Add("notify", "true")
    q.Add("reporting_manager", "8000000002411")
    q.Add("reporting_to", "8000000002411")
    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))
}

DELETE https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]?notify=true&reporting_manager=8000000002411&reporting_to=8000000002411 HTTP/1.1
Host: https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]?notify=true&reporting_manager=8000000002411&reporting_to=8000000002411
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]/users/[USER_ID]");
uriBuilder.addParameter("notify", "true");
uriBuilder.addParameter("reporting_manager", "8000000002411");
uriBuilder.addParameter("reporting_to", "8000000002411");
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]/users/[USER_ID]';

const params = new URLSearchParams({
  'notify': 'true',
  'reporting_manager': '8000000002411',
  'reporting_to': '8000000002411'
});

const options = {
  method: 'DELETE',
  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));

notify = "true"
reporting_manager = "8000000002411"
reporting_to = "8000000002411"

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]/users/[USER_ID]".toHttpUrl().newBuilder()
    urlBuilder.addQueryParameter("notify", "true")
    urlBuilder.addQueryParameter("reporting_manager", "8000000002411")
    urlBuilder.addQueryParameter("reporting_to", "8000000002411")
    val url = URL(urlBuilder.build().toString())
    val conn = url.openConnection() as HttpURLConnection
    conn.requestMethod = "DELETE"
    conn.setRequestProperty("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa")

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

NSString *encodedNotify = [@"true" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *encodedReporting_manager = [@"8000000002411" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *encodedReporting_to = [@"8000000002411" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *urlString = [NSString stringWithFormat:@"https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]?notify=%@&reporting_manager=%@&reporting_to=%@", encodedNotify, encodedReporting_manager, encodedReporting_to];
NSURL *url = [NSURL URLWithString:urlString];
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 enc_notify = Uri.pct_encode "true" in
  let enc_reporting_manager = Uri.pct_encode "8000000002411" in
  let enc_reporting_to = Uri.pct_encode "8000000002411" in
  let uri = Uri.of_string ("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]" ^ "?notify=" ^ enc_notify ^ "&reporting_manager=" ^ enc_reporting_manager ^ "&reporting_to=" ^ enc_reporting_to) 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"
}

$params = @{
    notify = "true"
    reporting_manager = "8000000002411"
    reporting_to = "8000000002411"
}
$queryString = ($params.GetEnumerator() | ForEach-Object { "$($_.Key)=$([System.Uri]::EscapeDataString($_.Value))" }) -join "&"
$url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]" + "?" + $queryString

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

$response | ConvertTo-Json

library(httr)

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

params <- list(
  notify = "true",
  reporting_manager = "8000000002411",
  reporting_to = "8000000002411"
)

response <- DELETE(
  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]/users/[USER_ID]")!
components.queryItems = [
    URLQueryItem(name: "notify", value: "true"),
    URLQueryItem(name: "reporting_manager", value: "8000000002411"),
    URLQueryItem(name: "reporting_to", value: "8000000002411")
]
let url = components.url!
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 Input

notify : "true" reporting_manager : "8000000002411" reporting_to : "8000000002411"

Sample Response

204 No Content

Possible Errors

Get All Portal Users, Client Users, and Contacts

Retrieve all users, client users, and contacts from the Zoho Projects portal.

GET

/api/v3.1/portal/[PORTAL_ID]/users

OAuth Scope:

ZohoProjects.users.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

type

String

Enter the user type.
Accepted values are portal_user,client_user,client_contact

view_type

String

Enter the view type.
Accepted values are active,inactive,active_read_only,inactive_read_only,subordinates_active,direct_reporters_active,activate_user_request,sandboxdevelopers,inactive_lite_user,active_lite_user

page

int

default : 1

Enter the page number.

per_page

int

default : 100

Enter the number of entries to be displayed per page.

filter

JSONObject

Enter the filter criteria.

sort_by

String

Enter the sort criteria. Accepted values: ASC(field_name) or DESC(field_name). Available fields: first_name, last_name, portal_profile, role, rate_per_hour, cost_rate_per_hour, business_hours, added_time, updated_time, last_accessed_on, and the api_name of a custom field.

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.1/portal/[PORTAL_ID]/users?type=portal_user&view_type=active&page=1&per_page=10&filter=%7B%22criteria%22%3A%5B%7B%22module%22%3A%22-%22%2C%22field_name%22%3A%22name%22%2C%22module_name%22%3A%22task%22%2C%22criteria_condition%22%3A%22contains%22%2C%22value%22%3A%5B%22Monica%22%5D%7D%5D%2C%22pattern%22%3A%221%22%7D&sort_by=ASC%28first_name%29' \
-H 'Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa'

url = "https://projects.zoho.com/api/v3.1/portal/[PORTAL_ID]/users";
filter_value = {"criteria":[{"module":"-","field_name":"name","module_name":"task","criteria_condition":"contains","value":["Monica"]}],"pattern":"1"};
params = Map();
params.put("type", "portal_user");
params.put("view_type", "active");
params.put("page", "1");
params.put("per_page", "10");
params.put("filter", filter_value);
params.put("sort_by", "ASC(first_name)");
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.1/portal/[PORTAL_ID]/users');
url.searchParams.append('type', 'portal_user');
url.searchParams.append('view_type', 'active');
url.searchParams.append('page', '1');
url.searchParams.append('per_page', '10');
url.searchParams.append('filter', '{"criteria":[{"module":"-","field_name":"name","module_name":"task","criteria_condition":"contains","value":["Monica"]}],"pattern":"1"}');
url.searchParams.append('sort_by', 'ASC(first_name)');

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.1/portal/[PORTAL_ID]/users")
params = {
  "type" => "portal_user",
  "view_type" => "active",
  "page" => "1",
  "per_page" => "10",
  "filter" => "{\"criteria\":[{\"module\":\"-\",\"field_name\":\"name\",\"module_name\":\"task\",\"criteria_condition\":\"contains\",\"value\":[\"Monica\"]}],\"pattern\":\"1\"}",
  "sort_by" => "ASC(first_name)"
}
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 = [
    'type' => 'portal_user',
    'view_type' => 'active',
    'page' => '1',
    'per_page' => '10',
    'filter' => '{"criteria":[{"module":"-","field_name":"name","module_name":"task","criteria_condition":"contains","value":["Monica"]}],"pattern":"1"}',
    'sort_by' => 'ASC(first_name)',
];
$url = "https://projects.zoho.com/api/v3.1/portal/[PORTAL_ID]/users" . "?" . 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.1/portal/[PORTAL_ID]/users"

params = {
    "type": "portal_user",
    "view_type": "active",
    "page": "1",
    "per_page": "10",
    "filter": "{\"criteria\":[{\"module\":\"-\",\"field_name\":\"name\",\"module_name\":\"task\",\"criteria_condition\":\"contains\",\"value\":[\"Monica\"]}],\"pattern\":\"1\"}",
    "sort_by": "ASC(first_name)"
}

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_type = curl_easy_escape(curl, "portal_user", 0);
        char *enc_view_type = curl_easy_escape(curl, "active", 0);
        char *enc_page = curl_easy_escape(curl, "1", 0);
        char *enc_per_page = curl_easy_escape(curl, "10", 0);
        char *enc_filter = curl_easy_escape(curl, "{\"criteria\":[{\"module\":\"-\",\"field_name\":\"name\",\"module_name\":\"task\",\"criteria_condition\":\"contains\",\"value\":[\"Monica\"]}],\"pattern\":\"1\"}", 0);
        char *enc_sort_by = curl_easy_escape(curl, "ASC(first_name)", 0);
        char url[2048];
        snprintf(url, sizeof(url), "https://projects.zoho.com/api/v3.1/portal/[PORTAL_ID]/users?type=%s&view_type=%s&page=%s&per_page=%s&filter=%s&sort_by=%s", enc_type, enc_view_type, enc_page, enc_per_page, enc_filter, enc_sort_by);

        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_type);
        curl_free(enc_view_type);
        curl_free(enc_page);
        curl_free(enc_per_page);
        curl_free(enc_filter);
        curl_free(enc_sort_by);
        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["type"] = "portal_user";
query["view_type"] = "active";
query["page"] = "1";
query["per_page"] = "10";
query["filter"] = "{\"criteria\":[{\"module\":\"-\",\"field_name\":\"name\",\"module_name\":\"task\",\"criteria_condition\":\"contains\",\"value\":[\"Monica\"]}],\"pattern\":\"1\"}";
query["sort_by"] = "ASC(first_name)";
var uriBuilder = new UriBuilder("https://projects.zoho.com/api/v3.1/portal/[PORTAL_ID]/users") { 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_type = curl_easy_escape(curl, "portal_user", 0);
        char* enc_view_type = curl_easy_escape(curl, "active", 0);
        char* enc_page = curl_easy_escape(curl, "1", 0);
        char* enc_per_page = curl_easy_escape(curl, "10", 0);
        char* enc_filter = curl_easy_escape(curl, "{\"criteria\":[{\"module\":\"-\",\"field_name\":\"name\",\"module_name\":\"task\",\"criteria_condition\":\"contains\",\"value\":[\"Monica\"]}],\"pattern\":\"1\"}", 0);
        char* enc_sort_by = curl_easy_escape(curl, "ASC(first_name)", 0);
        std::string url = "https://projects.zoho.com/api/v3.1/portal/[PORTAL_ID]/users";
        url += "?type=" + std::string(enc_type);
        url += "&view_type=" + std::string(enc_view_type);
        url += "&page=" + std::string(enc_page);
        url += "&per_page=" + std::string(enc_per_page);
        url += "&filter=" + std::string(enc_filter);
        url += "&sort_by=" + std::string(enc_sort_by);

        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_type);
        curl_free(enc_view_type);
        curl_free(enc_page);
        curl_free(enc_per_page);
        curl_free(enc_filter);
        curl_free(enc_sort_by);
        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}

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

(let [enc-type (java.net.URLEncoder/encode "portal_user" "UTF-8")
      enc-view_type (java.net.URLEncoder/encode "active" "UTF-8")
      enc-page (java.net.URLEncoder/encode "1" "UTF-8")
      enc-per_page (java.net.URLEncoder/encode "10" "UTF-8")
      enc-filter (java.net.URLEncoder/encode "{\"criteria\":[{\"module\":\"-\",\"field_name\":\"name\",\"module_name\":\"task\",\"criteria_condition\":\"contains\",\"value\":[\"Monica\"]}],\"pattern\":\"1\"}" "UTF-8")
      enc-sort_by (java.net.URLEncoder/encode "ASC(first_name)" "UTF-8")
      url (str "https://projects.zoho.com/api/v3.1/portal/[PORTAL_ID]/users" "?type=" enc-type "&view_type=" enc-view_type "&page=" enc-page "&per_page=" enc-per_page "&filter=" enc-filter "&sort_by=" enc-sort_by)]
(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.1/portal/[PORTAL_ID]/users", nil)
    q := req.URL.Query()
    q.Add("type", "portal_user")
    q.Add("view_type", "active")
    q.Add("page", "1")
    q.Add("per_page", "10")
    q.Add("filter", "{\"criteria\":[{\"module\":\"-\",\"field_name\":\"name\",\"module_name\":\"task\",\"criteria_condition\":\"contains\",\"value\":[\"Monica\"]}],\"pattern\":\"1\"}")
    q.Add("sort_by", "ASC(first_name)")
    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.1/portal/[PORTAL_ID]/users?type=portal_user&view_type=active&page=1&per_page=10&filter=%7B%22criteria%22%3A%5B%7B%22module%22%3A%22-%22%2C%22field_name%22%3A%22name%22%2C%22module_name%22%3A%22task%22%2C%22criteria_condition%22%3A%22contains%22%2C%22value%22%3A%5B%22Monica%22%5D%7D%5D%2C%22pattern%22%3A%221%22%7D&sort_by=ASC%28first_name%29 HTTP/1.1
Host: https://projects.zoho.com/api/v3.1/portal/[PORTAL_ID]/users?type=portal_user&view_type=active&page=1&per_page=10&filter=%7B%22criteria%22%3A%5B%7B%22module%22%3A%22-%22%2C%22field_name%22%3A%22name%22%2C%22module_name%22%3A%22task%22%2C%22criteria_condition%22%3A%22contains%22%2C%22value%22%3A%5B%22Monica%22%5D%7D%5D%2C%22pattern%22%3A%221%22%7D&sort_by=ASC%28first_name%29
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.1/portal/[PORTAL_ID]/users");
uriBuilder.addParameter("type", "portal_user");
uriBuilder.addParameter("view_type", "active");
uriBuilder.addParameter("page", "1");
uriBuilder.addParameter("per_page", "10");
uriBuilder.addParameter("filter", "{\"criteria\":[{\"module\":\"-\",\"field_name\":\"name\",\"module_name\":\"task\",\"criteria_condition\":\"contains\",\"value\":[\"Monica\"]}],\"pattern\":\"1\"}");
uriBuilder.addParameter("sort_by", "ASC(first_name)");
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.1/portal/[PORTAL_ID]/users';

const params = new URLSearchParams({
  'type': 'portal_user',
  'view_type': 'active',
  'page': '1',
  'per_page': '10',
  'filter': '{"criteria":[{"module":"-","field_name":"name","module_name":"task","criteria_condition":"contains","value":["Monica"]}],"pattern":"1"}',
  'sort_by': 'ASC(first_name)'
});

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));

type = "portal_user"
view_type = "active"
page = "1"
per_page = "10"
filter = {"criteria":[{"module":"-","field_name":"name","module_name":"task","criteria_condition":"contains","value":["Monica"]}],"pattern":"1"}
sort_by = "ASC(first_name)"

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

fun main() {
    val urlBuilder = "https://projects.zoho.com/api/v3.1/portal/[PORTAL_ID]/users".toHttpUrl().newBuilder()
    urlBuilder.addQueryParameter("type", "portal_user")
    urlBuilder.addQueryParameter("view_type", "active")
    urlBuilder.addQueryParameter("page", "1")
    urlBuilder.addQueryParameter("per_page", "10")
    urlBuilder.addQueryParameter("filter", "{\"criteria\":[{\"module\":\"-\",\"field_name\":\"name\",\"module_name\":\"task\",\"criteria_condition\":\"contains\",\"value\":[\"Monica\"]}],\"pattern\":\"1\"}")
    urlBuilder.addQueryParameter("sort_by", "ASC(first_name)")
    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 *encodedType = [@"portal_user" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *encodedView_type = [@"active" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *encodedPage = [@"1" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *encodedPer_page = [@"10" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *encodedFilter = [@"{\"criteria\":[{\"module\":\"-\",\"field_name\":\"name\",\"module_name\":\"task\",\"criteria_condition\":\"contains\",\"value\":[\"Monica\"]}],\"pattern\":\"1\"}" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *encodedSort_by = [@"ASC(first_name)" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *urlString = [NSString stringWithFormat:@"https://projects.zoho.com/api/v3.1/portal/[PORTAL_ID]/users?type=%@&view_type=%@&page=%@&per_page=%@&filter=%@&sort_by=%@", encodedType, encodedView_type, encodedPage, encodedPer_page, encodedFilter, encodedSort_by];
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_type = Uri.pct_encode "portal_user" in
  let enc_view_type = Uri.pct_encode "active" in
  let enc_page = Uri.pct_encode "1" in
  let enc_per_page = Uri.pct_encode "10" in
  let enc_filter = Uri.pct_encode "{\"criteria\":[{\"module\":\"-\",\"field_name\":\"name\",\"module_name\":\"task\",\"criteria_condition\":\"contains\",\"value\":[\"Monica\"]}],\"pattern\":\"1\"}" in
  let enc_sort_by = Uri.pct_encode "ASC(first_name)" in
  let uri = Uri.of_string ("https://projects.zoho.com/api/v3.1/portal/[PORTAL_ID]/users" ^ "?type=" ^ enc_type ^ "&view_type=" ^ enc_view_type ^ "&page=" ^ enc_page ^ "&per_page=" ^ enc_per_page ^ "&filter=" ^ enc_filter ^ "&sort_by=" ^ enc_sort_by) 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 = @{
    type = "portal_user"
    view_type = "active"
    page = "1"
    per_page = "10"
    filter = "{`"criteria`":[{`"module`":`"-`",`"field_name`":`"name`",`"module_name`":`"task`",`"criteria_condition`":`"contains`",`"value`":[`"Monica`"]}],`"pattern`":`"1`"}"
    sort_by = "ASC(first_name)"
}
$queryString = ($params.GetEnumerator() | ForEach-Object { "$($_.Key)=$([System.Uri]::EscapeDataString($_.Value))" }) -join "&"
$url = "https://projects.zoho.com/api/v3.1/portal/[PORTAL_ID]/users" + "?" + $queryString

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

$response | ConvertTo-Json

library(httr)

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

params <- list(
  type = "portal_user",
  view_type = "active",
  page = "1",
  per_page = "10",
  filter = "{\"criteria\":[{\"module\":\"-\",\"field_name\":\"name\",\"module_name\":\"task\",\"criteria_condition\":\"contains\",\"value\":[\"Monica\"]}],\"pattern\":\"1\"}",
  sort_by = "ASC(first_name)"
)

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.1/portal/[PORTAL_ID]/users")!
components.queryItems = [
    URLQueryItem(name: "type", value: "portal_user"),
    URLQueryItem(name: "view_type", value: "active"),
    URLQueryItem(name: "page", value: "1"),
    URLQueryItem(name: "per_page", value: "10"),
    URLQueryItem(name: "filter", value: "{\"criteria\":[{\"module\":\"-\",\"field_name\":\"name\",\"module_name\":\"task\",\"criteria_condition\":\"contains\",\"value\":[\"Monica\"]}],\"pattern\":\"1\"}"),
    URLQueryItem(name: "sort_by", value: "ASC(first_name)")
]
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

type : "portal_user" view_type : "active" page : "1" per_page : "10" filter : { "criteria" : [ { "module" : "-", "field_name" : "name", "module_name" : "task", "criteria_condition" : "contains", "value" : [ "Monica" ] } ], "pattern" : "1" } sort_by : "ASC(first_name)"

Sample Response

200{ "page_info" : { "per_page" : 50, "has_next_page" : false, "count" : 1, "page" : 1 }, "users" : [ { "business_hours" : { "name" : "Standard Business Hours", "id" : "4000000006095" }, "updated_time" : "2025-11-27T12:14:38.609Z", "role" : { "name" : "Administrator", "id" : "4000000002963", "type" : 1 }, "added_time" : "2025-11-27T12:14:38.609Z", "is_confirmed" : true, "last_name" : "Cavendish", "reporting_to" : { "full_name" : "Monica Hemsworth", "last_name" : "Hemsworth", "id" : "4000000548001", "first_name" : "Monica", "zuid" : "66295825" }, "zuid" : "45524228", "last_accessed_on" : "2026-06-12T11:43:18.605Z", "is_resend_invite" : false, "full_name" : "Katya Cavendish", "user_type" : "portal_user", "portal_profile" : { "name" : "Portal Owner", "id" : "4000000003455", "type" : "1", "is_default" : true }, "id" : "4000000002961", "first_name" : "Katya", "email" : "katya.cavendish@zylker.com", "status" : "active", "budget" : { "rate_per_hour" : { "amount" : 0, "formatted_amount" : "$ 0.00", "currency_code" : "USD", "currency_id" : "4000000082030" }, "cost_rate_per_hour" : { "amount" : 0, "formatted_amount" : "$ 0.00", "currency_code" : "USD", "currency_id" : "4000000082030" } } } ] }

Possible Errors

Get User Details (v3.1)

Retrieve details of a user from the Zoho Projects portal. The user_id segment accepts the user's ZPUID or email address.

GET

/api/v3.1/portal/[PORTAL_ID]/users/[USER_ID]

OAuth Scope:

ZohoProjects.users.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).

user_id

String

required
regex : [0-9]+

Identifier of an user. Obtained from the Get Users API - the "id" field in the response corresponds to user_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 GET \
'https://projects.zoho.com/api/v3.1/portal/[PORTAL_ID]/users/[USER_ID]' \
-H 'Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa'

url = "https://projects.zoho.com/api/v3.1/portal/[PORTAL_ID]/users/[USER_ID]";
response = invokeUrl
[
    url: url
    type: GET
    connection: "projects"
];
info response;

const https = require('https');
const url = new URL('https://projects.zoho.com/api/v3.1/portal/[PORTAL_ID]/users/[USER_ID]');

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.1/portal/[PORTAL_ID]/users/[USER_ID]")

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
$url = "https://projects.zoho.com/api/v3.1/portal/[PORTAL_ID]/users/[USER_ID]";

$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.1/portal/[PORTAL_ID]/users/[USER_ID]"

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

response = requests.get(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.1/portal/[PORTAL_ID]/users/[USER_ID]");
        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_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.Get, "https://projects.zoho.com/api/v3.1/portal/[PORTAL_ID]/users/[USER_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.1/portal/[PORTAL_ID]/users/[USER_ID]");
        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_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}

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

(def response
  (client/get "https://projects.zoho.com/api/v3.1/portal/[PORTAL_ID]/users/[USER_ID]"
    {:headers {"Authorization" "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"}
     :as :json}))

(println (:body response))

package main

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

func main() {
    req, _ := http.NewRequest("GET", "https://projects.zoho.com/api/v3.1/portal/[PORTAL_ID]/users/[USER_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))
}

GET https://projects.zoho.com/api/v3.1/portal/[PORTAL_ID]/users/[USER_ID] HTTP/1.1
Host: https://projects.zoho.com/api/v3.1/portal/[PORTAL_ID]/users/[USER_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.1/portal/[PORTAL_ID]/users/[USER_ID]");
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.1/portal/[PORTAL_ID]/users/[USER_ID]';

const options = {
  method: 'GET',
  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.1/portal/[PORTAL_ID]/users/[USER_ID]")
    val conn = url.openConnection() as HttpURLConnection
    conn.requestMethod = "GET"
    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.1/portal/[PORTAL_ID]/users/[USER_ID]"];
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 uri = Uri.of_string "https://projects.zoho.com/api/v3.1/portal/[PORTAL_ID]/users/[USER_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"
}

$response = Invoke-RestMethod -Uri "https://projects.zoho.com/api/v3.1/portal/[PORTAL_ID]/users/[USER_ID]" -Method GET -Headers $headers

$response | ConvertTo-Json

library(httr)

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

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

content(response, "text")

import Foundation

let url = URL(string: "https://projects.zoho.com/api/v3.1/portal/[PORTAL_ID]/users/[USER_ID]")!
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 Response

200{ "id" : "4000000549001", "zuid" : "31396112", "first_name" : "Monica", "last_name" : "Hemsworth", "full_name" : "Monica Hemsworth", "email" : "monica.hemsworth@zylker.com", "user_type" : "portal_user", "is_confirmed" : true, "status" : "active", "portal_profile" : { "id" : "4000000336001", "name" : "Custom Employee", "is_default" : false }, "role" : { "id" : "4000000002149", "name" : "Employee" }, "reporting_to" : { "full_name" : "Cole Anderson", "last_name" : "Anderson", "id" : "4000000548001", "first_name" : "Cole", "zuid" : "66295825" }, "business_hours" : { "id" : "4000000893039", "name" : "Standard Business Hour" }, "added_time" : "2025-03-05T06:36:04.454Z", "updated_time" : "2025-05-06T11:40:23.557Z", "last_accessed_on" : "2026-01-14T13:12:47.262Z", "budget" : { "cost_rate_per_hour" : { "currency_code" : "USD", "formatted_amount" : "$0.00", "currency_id" : "460000000000097", "amount" : 0.0 } }, "is_resend_invite" : false }

Possible Errors

Get User Audit Log

Retrieve audit details of a user from the Zoho Projects portal. The user_id segment accepts the user's ZPUID or email address.

GET

/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/audit-logs

OAuth Scope:

ZohoProjects.users.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).

user_id

String

required
regex : [0-9]+

Identifier of an user. Obtained from the Get Users API - the "id" field in the response corresponds to user_id.

Query Parameters

Param Name

Data Type

Description

next_token

String

max length : 500

Enter the token to fetch the next set of audit log entries. The token is returned as next_token in the previous response.

filter

JSONObject

Enter the filter criteria.

page

int

default : 1

Enter the page number.

per_page

int

limit : 1-200
default : 100

Enter the number of entries to be displayed per page.

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]/users/[USER_ID]/audit-logs?next_token=eJxLtDK0qi62srBUsgYADmkC1A&filter=%7B%22criteria%22%3A%5B%7B%22field_name%22%3A%22portal_profile%22%2C%22criteria_condition%22%3A%22is%22%2C%22value%22%3A%5B%221752587000000097269%22%5D%7D%5D%2C%22pattern%22%3A%221%22%7D&page=1&per_page=10' \
-H 'Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa'

url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/audit-logs";
filter_value = {"criteria":[{"field_name":"portal_profile","criteria_condition":"is","value":["1752587000000097269"]}],"pattern":"1"};
params = Map();
params.put("next_token", "eJxLtDK0qi62srBUsgYADmkC1A");
params.put("filter", filter_value);
params.put("page", "1");
params.put("per_page", "10");
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]/users/[USER_ID]/audit-logs');
url.searchParams.append('next_token', 'eJxLtDK0qi62srBUsgYADmkC1A');
url.searchParams.append('filter', '{"criteria":[{"field_name":"portal_profile","criteria_condition":"is","value":["1752587000000097269"]}],"pattern":"1"}');
url.searchParams.append('page', '1');
url.searchParams.append('per_page', '10');

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]/users/[USER_ID]/audit-logs")
params = {
  "next_token" => "eJxLtDK0qi62srBUsgYADmkC1A",
  "filter" => "{\"criteria\":[{\"field_name\":\"portal_profile\",\"criteria_condition\":\"is\",\"value\":[\"1752587000000097269\"]}],\"pattern\":\"1\"}",
  "page" => "1",
  "per_page" => "10"
}
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 = [
    'next_token' => 'eJxLtDK0qi62srBUsgYADmkC1A',
    'filter' => '{"criteria":[{"field_name":"portal_profile","criteria_condition":"is","value":["1752587000000097269"]}],"pattern":"1"}',
    'page' => '1',
    'per_page' => '10',
];
$url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/audit-logs" . "?" . 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]/users/[USER_ID]/audit-logs"

params = {
    "next_token": "eJxLtDK0qi62srBUsgYADmkC1A",
    "filter": "{\"criteria\":[{\"field_name\":\"portal_profile\",\"criteria_condition\":\"is\",\"value\":[\"1752587000000097269\"]}],\"pattern\":\"1\"}",
    "page": "1",
    "per_page": "10"
}

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_next_token = curl_easy_escape(curl, "eJxLtDK0qi62srBUsgYADmkC1A", 0);
        char *enc_filter = curl_easy_escape(curl, "{\"criteria\":[{\"field_name\":\"portal_profile\",\"criteria_condition\":\"is\",\"value\":[\"1752587000000097269\"]}],\"pattern\":\"1\"}", 0);
        char *enc_page = curl_easy_escape(curl, "1", 0);
        char *enc_per_page = curl_easy_escape(curl, "10", 0);
        char url[2048];
        snprintf(url, sizeof(url), "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/audit-logs?next_token=%s&filter=%s&page=%s&per_page=%s", enc_next_token, enc_filter, enc_page, enc_per_page);

        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_next_token);
        curl_free(enc_filter);
        curl_free(enc_page);
        curl_free(enc_per_page);
        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["next_token"] = "eJxLtDK0qi62srBUsgYADmkC1A";
query["filter"] = "{\"criteria\":[{\"field_name\":\"portal_profile\",\"criteria_condition\":\"is\",\"value\":[\"1752587000000097269\"]}],\"pattern\":\"1\"}";
query["page"] = "1";
query["per_page"] = "10";
var uriBuilder = new UriBuilder("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/audit-logs") { 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_next_token = curl_easy_escape(curl, "eJxLtDK0qi62srBUsgYADmkC1A", 0);
        char* enc_filter = curl_easy_escape(curl, "{\"criteria\":[{\"field_name\":\"portal_profile\",\"criteria_condition\":\"is\",\"value\":[\"1752587000000097269\"]}],\"pattern\":\"1\"}", 0);
        char* enc_page = curl_easy_escape(curl, "1", 0);
        char* enc_per_page = curl_easy_escape(curl, "10", 0);
        std::string url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/audit-logs";
        url += "?next_token=" + std::string(enc_next_token);
        url += "&filter=" + std::string(enc_filter);
        url += "&page=" + std::string(enc_page);
        url += "&per_page=" + std::string(enc_per_page);

        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_next_token);
        curl_free(enc_filter);
        curl_free(enc_page);
        curl_free(enc_per_page);
        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}

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

(let [enc-next_token (java.net.URLEncoder/encode "eJxLtDK0qi62srBUsgYADmkC1A" "UTF-8")
      enc-filter (java.net.URLEncoder/encode "{\"criteria\":[{\"field_name\":\"portal_profile\",\"criteria_condition\":\"is\",\"value\":[\"1752587000000097269\"]}],\"pattern\":\"1\"}" "UTF-8")
      enc-page (java.net.URLEncoder/encode "1" "UTF-8")
      enc-per_page (java.net.URLEncoder/encode "10" "UTF-8")
      url (str "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/audit-logs" "?next_token=" enc-next_token "&filter=" enc-filter "&page=" enc-page "&per_page=" enc-per_page)]
(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]/users/[USER_ID]/audit-logs", nil)
    q := req.URL.Query()
    q.Add("next_token", "eJxLtDK0qi62srBUsgYADmkC1A")
    q.Add("filter", "{\"criteria\":[{\"field_name\":\"portal_profile\",\"criteria_condition\":\"is\",\"value\":[\"1752587000000097269\"]}],\"pattern\":\"1\"}")
    q.Add("page", "1")
    q.Add("per_page", "10")
    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]/users/[USER_ID]/audit-logs?next_token=eJxLtDK0qi62srBUsgYADmkC1A&filter=%7B%22criteria%22%3A%5B%7B%22field_name%22%3A%22portal_profile%22%2C%22criteria_condition%22%3A%22is%22%2C%22value%22%3A%5B%221752587000000097269%22%5D%7D%5D%2C%22pattern%22%3A%221%22%7D&page=1&per_page=10 HTTP/1.1
Host: https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/audit-logs?next_token=eJxLtDK0qi62srBUsgYADmkC1A&filter=%7B%22criteria%22%3A%5B%7B%22field_name%22%3A%22portal_profile%22%2C%22criteria_condition%22%3A%22is%22%2C%22value%22%3A%5B%221752587000000097269%22%5D%7D%5D%2C%22pattern%22%3A%221%22%7D&page=1&per_page=10
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]/users/[USER_ID]/audit-logs");
uriBuilder.addParameter("next_token", "eJxLtDK0qi62srBUsgYADmkC1A");
uriBuilder.addParameter("filter", "{\"criteria\":[{\"field_name\":\"portal_profile\",\"criteria_condition\":\"is\",\"value\":[\"1752587000000097269\"]}],\"pattern\":\"1\"}");
uriBuilder.addParameter("page", "1");
uriBuilder.addParameter("per_page", "10");
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]/users/[USER_ID]/audit-logs';

const params = new URLSearchParams({
  'next_token': 'eJxLtDK0qi62srBUsgYADmkC1A',
  'filter': '{"criteria":[{"field_name":"portal_profile","criteria_condition":"is","value":["1752587000000097269"]}],"pattern":"1"}',
  'page': '1',
  'per_page': '10'
});

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));

next_token = "eJxLtDK0qi62srBUsgYADmkC1A"
filter = {"criteria":[{"field_name":"portal_profile","criteria_condition":"is","value":["1752587000000097269"]}],"pattern":"1"}
page = "1"
per_page = "10"

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]/users/[USER_ID]/audit-logs".toHttpUrl().newBuilder()
    urlBuilder.addQueryParameter("next_token", "eJxLtDK0qi62srBUsgYADmkC1A")
    urlBuilder.addQueryParameter("filter", "{\"criteria\":[{\"field_name\":\"portal_profile\",\"criteria_condition\":\"is\",\"value\":[\"1752587000000097269\"]}],\"pattern\":\"1\"}")
    urlBuilder.addQueryParameter("page", "1")
    urlBuilder.addQueryParameter("per_page", "10")
    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 *encodedNext_token = [@"eJxLtDK0qi62srBUsgYADmkC1A" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *encodedFilter = [@"{\"criteria\":[{\"field_name\":\"portal_profile\",\"criteria_condition\":\"is\",\"value\":[\"1752587000000097269\"]}],\"pattern\":\"1\"}" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *encodedPage = [@"1" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *encodedPer_page = [@"10" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *urlString = [NSString stringWithFormat:@"https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/audit-logs?next_token=%@&filter=%@&page=%@&per_page=%@", encodedNext_token, encodedFilter, encodedPage, encodedPer_page];
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_next_token = Uri.pct_encode "eJxLtDK0qi62srBUsgYADmkC1A" in
  let enc_filter = Uri.pct_encode "{\"criteria\":[{\"field_name\":\"portal_profile\",\"criteria_condition\":\"is\",\"value\":[\"1752587000000097269\"]}],\"pattern\":\"1\"}" in
  let enc_page = Uri.pct_encode "1" in
  let enc_per_page = Uri.pct_encode "10" in
  let uri = Uri.of_string ("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/audit-logs" ^ "?next_token=" ^ enc_next_token ^ "&filter=" ^ enc_filter ^ "&page=" ^ enc_page ^ "&per_page=" ^ enc_per_page) 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 = @{
    next_token = "eJxLtDK0qi62srBUsgYADmkC1A"
    filter = "{`"criteria`":[{`"field_name`":`"portal_profile`",`"criteria_condition`":`"is`",`"value`":[`"1752587000000097269`"]}],`"pattern`":`"1`"}"
    page = "1"
    per_page = "10"
}
$queryString = ($params.GetEnumerator() | ForEach-Object { "$($_.Key)=$([System.Uri]::EscapeDataString($_.Value))" }) -join "&"
$url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/audit-logs" + "?" + $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]/users/[USER_ID]/audit-logs"

params <- list(
  next_token = "eJxLtDK0qi62srBUsgYADmkC1A",
  filter = "{\"criteria\":[{\"field_name\":\"portal_profile\",\"criteria_condition\":\"is\",\"value\":[\"1752587000000097269\"]}],\"pattern\":\"1\"}",
  page = "1",
  per_page = "10"
)

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]/users/[USER_ID]/audit-logs")!
components.queryItems = [
    URLQueryItem(name: "next_token", value: "eJxLtDK0qi62srBUsgYADmkC1A"),
    URLQueryItem(name: "filter", value: "{\"criteria\":[{\"field_name\":\"portal_profile\",\"criteria_condition\":\"is\",\"value\":[\"1752587000000097269\"]}],\"pattern\":\"1\"}"),
    URLQueryItem(name: "page", value: "1"),
    URLQueryItem(name: "per_page", value: "10")
]
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

next_token : "eJxLtDK0qi62srBUsgYADmkC1A" filter : { "criteria" : [ { "field_name" : "portal_profile", "criteria_condition" : "is", "value" : [ "1752587000000097269" ] } ], "pattern" : "1" } page : "1" per_page : "10"

Sample Response

200{ "audit_logs" : [ { "action_time" : "2026-03-03T06:31:10.026Z", "id" : "4000001015004", "performed_by" : { "zpuid" : "4000000002143", "zuid" : "18891770", "first_name" : "Monica", "last_name" : "Hemsworth", "full_name" : "Monica Hemsworth", "email" : "monica.hemsworth@zylker.com" }, "activity" : "user", "field_name" : "profile", "module" : "user", "action" : "update", "project" : { "id" : "4000000012345", "name" : "Sample Project" }, "audit_scope" : "company", "changes" : [ { "cfid" : "4000001005015", "is_encrypted" : false, "old_value" : "Manager", "display_name" : "Portal Profile", "new_value" : "Employee" } ] } ], "next_token" : "eJxLtDK0qi62srBUsgYADmkC1A" }

Get User's Teams Details

Retrieve the details of the teams associated with a user.

GET

/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/teams

OAuth Scope:

ZohoProjects.users.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).

user_id

String

required
regex : [0-9]+

Identifier of an user. Obtained from the Get Users API - the "id" field in the response corresponds to user_id.

Query Parameters

Param Name

Data Type

Description

page

int

default : 1

Enter the page number.

per_page

int

default : 50

Enter the number of entries to be displayed per page.

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]/users/[USER_ID]/teams?page=1&per_page=10' \
-H 'Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa'

url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/teams";
params = Map();
params.put("page", "1");
params.put("per_page", "10");
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]/users/[USER_ID]/teams');
url.searchParams.append('page', '1');
url.searchParams.append('per_page', '10');

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]/users/[USER_ID]/teams")
params = {
  "page" => "1",
  "per_page" => "10"
}
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 = [
    'page' => '1',
    'per_page' => '10',
];
$url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/teams" . "?" . 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]/users/[USER_ID]/teams"

params = {
    "page": "1",
    "per_page": "10"
}

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_page = curl_easy_escape(curl, "1", 0);
        char *enc_per_page = curl_easy_escape(curl, "10", 0);
        char url[2048];
        snprintf(url, sizeof(url), "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/teams?page=%s&per_page=%s", enc_page, enc_per_page);

        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_page);
        curl_free(enc_per_page);
        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["page"] = "1";
query["per_page"] = "10";
var uriBuilder = new UriBuilder("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/teams") { 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_page = curl_easy_escape(curl, "1", 0);
        char* enc_per_page = curl_easy_escape(curl, "10", 0);
        std::string url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/teams";
        url += "?page=" + std::string(enc_page);
        url += "&per_page=" + std::string(enc_per_page);

        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_page);
        curl_free(enc_per_page);
        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}

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

(let [enc-page (java.net.URLEncoder/encode "1" "UTF-8")
      enc-per_page (java.net.URLEncoder/encode "10" "UTF-8")
      url (str "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/teams" "?page=" enc-page "&per_page=" enc-per_page)]
(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]/users/[USER_ID]/teams", nil)
    q := req.URL.Query()
    q.Add("page", "1")
    q.Add("per_page", "10")
    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]/users/[USER_ID]/teams?page=1&per_page=10 HTTP/1.1
Host: https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/teams?page=1&per_page=10
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]/users/[USER_ID]/teams");
uriBuilder.addParameter("page", "1");
uriBuilder.addParameter("per_page", "10");
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]/users/[USER_ID]/teams';

const params = new URLSearchParams({
  'page': '1',
  'per_page': '10'
});

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));

page = "1"
per_page = "10"

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]/users/[USER_ID]/teams".toHttpUrl().newBuilder()
    urlBuilder.addQueryParameter("page", "1")
    urlBuilder.addQueryParameter("per_page", "10")
    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 *encodedPage = [@"1" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *encodedPer_page = [@"10" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *urlString = [NSString stringWithFormat:@"https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/teams?page=%@&per_page=%@", encodedPage, encodedPer_page];
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_page = Uri.pct_encode "1" in
  let enc_per_page = Uri.pct_encode "10" in
  let uri = Uri.of_string ("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/teams" ^ "?page=" ^ enc_page ^ "&per_page=" ^ enc_per_page) 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 = @{
    page = "1"
    per_page = "10"
}
$queryString = ($params.GetEnumerator() | ForEach-Object { "$($_.Key)=$([System.Uri]::EscapeDataString($_.Value))" }) -join "&"
$url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/users/[USER_ID]/teams" + "?" + $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]/users/[USER_ID]/teams"

params <- list(
  page = "1",
  per_page = "10"
)

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]/users/[USER_ID]/teams")!
components.queryItems = [
    URLQueryItem(name: "page", value: "1"),
    URLQueryItem(name: "per_page", value: "10")
]
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

page : "1" per_page : "10"

Sample Response

200{ "teams" : [ { "name" : "Testing Team", "id" : "4000000015029" }, { "name" : "Security Team", "id" : "4000000015071" } ] }

Update User (v3.1)

Modify the details of an existing user in the Zoho Projects portal. The user_id segment accepts the user's ZPUID or email address.

PATCH

/api/v3.1/portal/[PORTAL_ID]/users/[USER_ID]

OAuth Scope:

ZohoProjects.users.UPDATE

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).

user_id

String

required
regex : [0-9]+

Identifier of an user. Obtained from the Get Users API - the "id" field in the response corresponds to user_id.

Body Parameters

Param Name

Data Type

Description

portal_profile

JSONObject

Enter the profile details.

role

JSONObject

Enter the role details.

reporting_to

JSONObject

Enter the reporting manager details.

business_hours

JSONObject

Enter the business hours details.

bulk_projects

JSONObject

max length : 200000

Enter the project details

budget

JSONObject

Enter the budget details.

apply_portal_rate

boolean

Specify whether the user rate applies at the portal level.
Accepted values: true, false

notify

boolean

Specify whether the user should be notified about updates.
Accepted values: true, false.

skills

JSONArray

max length : 500000

Enter the skill association details for the user.

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.1/portal/[PORTAL_ID]/users/[USER_ID]' \
-H 'Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa' \
-H 'Content-Type: application/json' \
-d '{"portal_profile":{"id":"23806000006123455432"},"role":{"id":"23806000006123455432"},"reporting_to":{"id":"23806000006123455432"},"business_hours":{"id":"23806000006123455432"},"bulk_projects":{"select_all":false,"selected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"unselected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"rateupdatedprojects":{"23806000074760021":"20"},"costrateupdatedprojects":{"23806000074760021":"15"}},"budget":{"rate_per_hour":{"amount":945.25},"cost_rate_per_hour":{"amount":510.75},"cost_effective_from_date":"2024-08-21"},"apply_portal_rate":false,"notify":true,"skills":[{"add":[{"id":"8000000123001","level":"intermediate"}],"remove":[{"id":"8000000123002"}]}]}'

url = "https://projects.zoho.com/api/v3.1/portal/[PORTAL_ID]/users/[USER_ID]";
params = Map();
params.put("portal_profile", {"id":"23806000006123455432"});
params.put("role", {"id":"23806000006123455432"});
params.put("reporting_to", {"id":"23806000006123455432"});
params.put("business_hours", {"id":"23806000006123455432"});
params.put("bulk_projects", {"select_all":false,"selected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"unselected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"rateupdatedprojects":{"23806000074760021":"20"},"costrateupdatedprojects":{"23806000074760021":"15"}});
params.put("budget", {"rate_per_hour":{"amount":945.25},"cost_rate_per_hour":{"amount":510.75},"cost_effective_from_date":"2024-08-21"});
params.put("apply_portal_rate", false);
params.put("notify", true);
params.put("skills", [{"add":[{"id":"8000000123001","level":"intermediate"}],"remove":[{"id":"8000000123002"}]}]);
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.1/portal/[PORTAL_ID]/users/[USER_ID]');

const payload = JSON.stringify({"portal_profile":{"id":"23806000006123455432"},"role":{"id":"23806000006123455432"},"reporting_to":{"id":"23806000006123455432"},"business_hours":{"id":"23806000006123455432"},"bulk_projects":{"select_all":false,"selected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"unselected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"rateupdatedprojects":{"23806000074760021":"20"},"costrateupdatedprojects":{"23806000074760021":"15"}},"budget":{"rate_per_hour":{"amount":945.25},"cost_rate_per_hour":{"amount":510.75},"cost_effective_from_date":"2024-08-21"},"apply_portal_rate":false,"notify":true,"skills":[{"add":[{"id":"8000000123001","level":"intermediate"}],"remove":[{"id":"8000000123002"}]}]});

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.1/portal/[PORTAL_ID]/users/[USER_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 = '{"portal_profile":{"id":"23806000006123455432"},"role":{"id":"23806000006123455432"},"reporting_to":{"id":"23806000006123455432"},"business_hours":{"id":"23806000006123455432"},"bulk_projects":{"select_all":false,"selected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"unselected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"rateupdatedprojects":{"23806000074760021":"20"},"costrateupdatedprojects":{"23806000074760021":"15"}},"budget":{"rate_per_hour":{"amount":945.25},"cost_rate_per_hour":{"amount":510.75},"cost_effective_from_date":"2024-08-21"},"apply_portal_rate":false,"notify":true,"skills":[{"add":[{"id":"8000000123001","level":"intermediate"}],"remove":[{"id":"8000000123002"}]}]}'

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

<?php
$url = "https://projects.zoho.com/api/v3.1/portal/[PORTAL_ID]/users/[USER_ID]";

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => $url,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => '{"portal_profile":{"id":"23806000006123455432"},"role":{"id":"23806000006123455432"},"reporting_to":{"id":"23806000006123455432"},"business_hours":{"id":"23806000006123455432"},"bulk_projects":{"select_all":false,"selected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"unselected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"rateupdatedprojects":{"23806000074760021":"20"},"costrateupdatedprojects":{"23806000074760021":"15"}},"budget":{"rate_per_hour":{"amount":945.25},"cost_rate_per_hour":{"amount":510.75},"cost_effective_from_date":"2024-08-21"},"apply_portal_rate":false,"notify":true,"skills":[{"add":[{"id":"8000000123001","level":"intermediate"}],"remove":[{"id":"8000000123002"}]}]}',
  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.1/portal/[PORTAL_ID]/users/[USER_ID]"

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

payload = '{"portal_profile":{"id":"23806000006123455432"},"role":{"id":"23806000006123455432"},"reporting_to":{"id":"23806000006123455432"},"business_hours":{"id":"23806000006123455432"},"bulk_projects":{"select_all":false,"selected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"unselected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"rateupdatedprojects":{"23806000074760021":"20"},"costrateupdatedprojects":{"23806000074760021":"15"}},"budget":{"rate_per_hour":{"amount":945.25},"cost_rate_per_hour":{"amount":510.75},"cost_effective_from_date":"2024-08-21"},"apply_portal_rate":false,"notify":true,"skills":[{"add":[{"id":"8000000123001","level":"intermediate"}],"remove":[{"id":"8000000123002"}]}]}'

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.1/portal/[PORTAL_ID]/users/[USER_ID]");
        curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
        curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "PATCH");
        curl_easy_setopt(curl, CURLOPT_POSTFIELDS, "{\"portal_profile\":{\"id\":\"23806000006123455432\"},\"role\":{\"id\":\"23806000006123455432\"},\"reporting_to\":{\"id\":\"23806000006123455432\"},\"business_hours\":{\"id\":\"23806000006123455432\"},\"bulk_projects\":{\"select_all\":false,\"selected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"unselected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"rateupdatedprojects\":{\"23806000074760021\":\"20\"},\"costrateupdatedprojects\":{\"23806000074760021\":\"15\"}},\"budget\":{\"rate_per_hour\":{\"amount\":945.25},\"cost_rate_per_hour\":{\"amount\":510.75},\"cost_effective_from_date\":\"2024-08-21\"},\"apply_portal_rate\":false,\"notify\":true,\"skills\":[{\"add\":[{\"id\":\"8000000123001\",\"level\":\"intermediate\"}],\"remove\":[{\"id\":\"8000000123002\"}]}]}");

        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.1/portal/[PORTAL_ID]/users/[USER_ID]");
request.Content = new StringContent(
    @"{""portal_profile"":{""id"":""23806000006123455432""},""role"":{""id"":""23806000006123455432""},""reporting_to"":{""id"":""23806000006123455432""},""business_hours"":{""id"":""23806000006123455432""},""bulk_projects"":{""select_all"":false,""selected"":{""group_ids"":[""2380600000612345""],""project_ids"":[""23806000074760021""]},""unselected"":{""group_ids"":[""2380600000612345""],""project_ids"":[""23806000074760021""]},""rateupdatedprojects"":{""23806000074760021"":""20""},""costrateupdatedprojects"":{""23806000074760021"":""15""}},""budget"":{""rate_per_hour"":{""amount"":945.25},""cost_rate_per_hour"":{""amount"":510.75},""cost_effective_from_date"":""2024-08-21""},""apply_portal_rate"":false,""notify"":true,""skills"":[{""add"":[{""id"":""8000000123001"",""level"":""intermediate""}],""remove"":[{""id"":""8000000123002""}]}]}",
    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.1/portal/[PORTAL_ID]/users/[USER_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, "{\"portal_profile\":{\"id\":\"23806000006123455432\"},\"role\":{\"id\":\"23806000006123455432\"},\"reporting_to\":{\"id\":\"23806000006123455432\"},\"business_hours\":{\"id\":\"23806000006123455432\"},\"bulk_projects\":{\"select_all\":false,\"selected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"unselected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"rateupdatedprojects\":{\"23806000074760021\":\"20\"},\"costrateupdatedprojects\":{\"23806000074760021\":\"15\"}},\"budget\":{\"rate_per_hour\":{\"amount\":945.25},\"cost_rate_per_hour\":{\"amount\":510.75},\"cost_effective_from_date\":\"2024-08-21\"},\"apply_portal_rate\":false,\"notify\":true,\"skills\":[{\"add\":[{\"id\":\"8000000123001\",\"level\":\"intermediate\"}],\"remove\":[{\"id\":\"8000000123002\"}]}]}");

        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.1/portal/[PORTAL_ID]/users/[USER_ID]"
    {:headers {"Authorization" "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
                "Content-Type" "application/json"}
     :body "{\"portal_profile\":{\"id\":\"23806000006123455432\"},\"role\":{\"id\":\"23806000006123455432\"},\"reporting_to\":{\"id\":\"23806000006123455432\"},\"business_hours\":{\"id\":\"23806000006123455432\"},\"bulk_projects\":{\"select_all\":false,\"selected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"unselected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"rateupdatedprojects\":{\"23806000074760021\":\"20\"},\"costrateupdatedprojects\":{\"23806000074760021\":\"15\"}},\"budget\":{\"rate_per_hour\":{\"amount\":945.25},\"cost_rate_per_hour\":{\"amount\":510.75},\"cost_effective_from_date\":\"2024-08-21\"},\"apply_portal_rate\":false,\"notify\":true,\"skills\":[{\"add\":[{\"id\":\"8000000123001\",\"level\":\"intermediate\"}],\"remove\":[{\"id\":\"8000000123002\"}]}]}"
     :as :json}))

(println (:body response))

package main

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

func main() {
    payload := strings.NewReader("{\"portal_profile\":{\"id\":\"23806000006123455432\"},\"role\":{\"id\":\"23806000006123455432\"},\"reporting_to\":{\"id\":\"23806000006123455432\"},\"business_hours\":{\"id\":\"23806000006123455432\"},\"bulk_projects\":{\"select_all\":false,\"selected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"unselected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"rateupdatedprojects\":{\"23806000074760021\":\"20\"},\"costrateupdatedprojects\":{\"23806000074760021\":\"15\"}},\"budget\":{\"rate_per_hour\":{\"amount\":945.25},\"cost_rate_per_hour\":{\"amount\":510.75},\"cost_effective_from_date\":\"2024-08-21\"},\"apply_portal_rate\":false,\"notify\":true,\"skills\":[{\"add\":[{\"id\":\"8000000123001\",\"level\":\"intermediate\"}],\"remove\":[{\"id\":\"8000000123002\"}]}]}")
    req, _ := http.NewRequest("PATCH", "https://projects.zoho.com/api/v3.1/portal/[PORTAL_ID]/users/[USER_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.1/portal/[PORTAL_ID]/users/[USER_ID] HTTP/1.1
Host: https://projects.zoho.com/api/v3.1/portal/[PORTAL_ID]/users/[USER_ID]
Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa
Content-Type: application/json

{"portal_profile":{"id":"23806000006123455432"},"role":{"id":"23806000006123455432"},"reporting_to":{"id":"23806000006123455432"},"business_hours":{"id":"23806000006123455432"},"bulk_projects":{"select_all":false,"selected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"unselected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"rateupdatedprojects":{"23806000074760021":"20"},"costrateupdatedprojects":{"23806000074760021":"15"}},"budget":{"rate_per_hour":{"amount":945.25},"cost_rate_per_hour":{"amount":510.75},"cost_effective_from_date":"2024-08-21"},"apply_portal_rate":false,"notify":true,"skills":[{"add":[{"id":"8000000123001","level":"intermediate"}],"remove":[{"id":"8000000123002"}]}]}

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.1/portal/[PORTAL_ID]/users/[USER_ID]");
HttpUriRequest requestObj = new HttpPatch(uriBuilder.build());
requestObj.addHeader("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");

HttpEntityEnclosingRequestBase requestBase = (HttpEntityEnclosingRequestBase) requestObj;
String requestBody = "{\"portal_profile\":{\"id\":\"23806000006123455432\"},\"role\":{\"id\":\"23806000006123455432\"},\"reporting_to\":{\"id\":\"23806000006123455432\"},\"business_hours\":{\"id\":\"23806000006123455432\"},\"bulk_projects\":{\"select_all\":false,\"selected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"unselected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"rateupdatedprojects\":{\"23806000074760021\":\"20\"},\"costrateupdatedprojects\":{\"23806000074760021\":\"15\"}},\"budget\":{\"rate_per_hour\":{\"amount\":945.25},\"cost_rate_per_hour\":{\"amount\":510.75},\"cost_effective_from_date\":\"2024-08-21\"},\"apply_portal_rate\":false,\"notify\":true,\"skills\":[{\"add\":[{\"id\":\"8000000123001\",\"level\":\"intermediate\"}],\"remove\":[{\"id\":\"8000000123002\"}]}]}";
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.1/portal/[PORTAL_ID]/users/[USER_ID]';

const options = {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({"portal_profile":{"id":"23806000006123455432"},"role":{"id":"23806000006123455432"},"reporting_to":{"id":"23806000006123455432"},"business_hours":{"id":"23806000006123455432"},"bulk_projects":{"select_all":false,"selected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"unselected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"rateupdatedprojects":{"23806000074760021":"20"},"costrateupdatedprojects":{"23806000074760021":"15"}},"budget":{"rate_per_hour":{"amount":945.25},"cost_rate_per_hour":{"amount":510.75},"cost_effective_from_date":"2024-08-21"},"apply_portal_rate":false,"notify":true,"skills":[{"add":[{"id":"8000000123001","level":"intermediate"}],"remove":[{"id":"8000000123002"}]}]})
};

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

{"portal_profile":{"id":"23806000006123455432"},"role":{"id":"23806000006123455432"},"reporting_to":{"id":"23806000006123455432"},"business_hours":{"id":"23806000006123455432"},"bulk_projects":{"select_all":false,"selected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"unselected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"rateupdatedprojects":{"23806000074760021":"20"},"costrateupdatedprojects":{"23806000074760021":"15"}},"budget":{"rate_per_hour":{"amount":945.25},"cost_rate_per_hour":{"amount":510.75},"cost_effective_from_date":"2024-08-21"},"apply_portal_rate":false,"notify":true,"skills":[{"add":[{"id":"8000000123001","level":"intermediate"}],"remove":[{"id":"8000000123002"}]}]}

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

fun main() {
    val url = URL("https://projects.zoho.com/api/v3.1/portal/[PORTAL_ID]/users/[USER_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("""{"portal_profile":{"id":"23806000006123455432"},"role":{"id":"23806000006123455432"},"reporting_to":{"id":"23806000006123455432"},"business_hours":{"id":"23806000006123455432"},"bulk_projects":{"select_all":false,"selected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"unselected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"rateupdatedprojects":{"23806000074760021":"20"},"costrateupdatedprojects":{"23806000074760021":"15"}},"budget":{"rate_per_hour":{"amount":945.25},"cost_rate_per_hour":{"amount":510.75},"cost_effective_from_date":"2024-08-21"},"apply_portal_rate":false,"notify":true,"skills":[{"add":[{"id":"8000000123001","level":"intermediate"}],"remove":[{"id":"8000000123002"}]}]}""") }

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

NSURL *url = [NSURL URLWithString:@"https://projects.zoho.com/api/v3.1/portal/[PORTAL_ID]/users/[USER_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 = [@"{\"portal_profile\":{\"id\":\"23806000006123455432\"},\"role\":{\"id\":\"23806000006123455432\"},\"reporting_to\":{\"id\":\"23806000006123455432\"},\"business_hours\":{\"id\":\"23806000006123455432\"},\"bulk_projects\":{\"select_all\":false,\"selected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"unselected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"rateupdatedprojects\":{\"23806000074760021\":\"20\"},\"costrateupdatedprojects\":{\"23806000074760021\":\"15\"}},\"budget\":{\"rate_per_hour\":{\"amount\":945.25},\"cost_rate_per_hour\":{\"amount\":510.75},\"cost_effective_from_date\":\"2024-08-21\"},\"apply_portal_rate\":false,\"notify\":true,\"skills\":[{\"add\":[{\"id\":\"8000000123001\",\"level\":\"intermediate\"}],\"remove\":[{\"id\":\"8000000123002\"}]}]}" 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.1/portal/[PORTAL_ID]/users/[USER_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|{"portal_profile":{"id":"23806000006123455432"},"role":{"id":"23806000006123455432"},"reporting_to":{"id":"23806000006123455432"},"business_hours":{"id":"23806000006123455432"},"bulk_projects":{"select_all":false,"selected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"unselected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"rateupdatedprojects":{"23806000074760021":"20"},"costrateupdatedprojects":{"23806000074760021":"15"}},"budget":{"rate_per_hour":{"amount":945.25},"cost_rate_per_hour":{"amount":510.75},"cost_effective_from_date":"2024-08-21"},"apply_portal_rate":false,"notify":true,"skills":[{"add":[{"id":"8000000123001","level":"intermediate"}],"remove":[{"id":"8000000123002"}]}]}|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 = @'
{"portal_profile":{"id":"23806000006123455432"},"role":{"id":"23806000006123455432"},"reporting_to":{"id":"23806000006123455432"},"business_hours":{"id":"23806000006123455432"},"bulk_projects":{"select_all":false,"selected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"unselected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"rateupdatedprojects":{"23806000074760021":"20"},"costrateupdatedprojects":{"23806000074760021":"15"}},"budget":{"rate_per_hour":{"amount":945.25},"cost_rate_per_hour":{"amount":510.75},"cost_effective_from_date":"2024-08-21"},"apply_portal_rate":false,"notify":true,"skills":[{"add":[{"id":"8000000123001","level":"intermediate"}],"remove":[{"id":"8000000123002"}]}]}
'@

$response = Invoke-RestMethod -Uri "https://projects.zoho.com/api/v3.1/portal/[PORTAL_ID]/users/[USER_ID]" -Method PATCH -Headers $headers -Body $body

$response | ConvertTo-Json

library(httr)

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

response <- PATCH(
  url,
  add_headers(Authorization = "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"),
  content_type_json(),
  body = "{\"portal_profile\":{\"id\":\"23806000006123455432\"},\"role\":{\"id\":\"23806000006123455432\"},\"reporting_to\":{\"id\":\"23806000006123455432\"},\"business_hours\":{\"id\":\"23806000006123455432\"},\"bulk_projects\":{\"select_all\":false,\"selected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"unselected\":{\"group_ids\":[\"2380600000612345\"],\"project_ids\":[\"23806000074760021\"]},\"rateupdatedprojects\":{\"23806000074760021\":\"20\"},\"costrateupdatedprojects\":{\"23806000074760021\":\"15\"}},\"budget\":{\"rate_per_hour\":{\"amount\":945.25},\"cost_rate_per_hour\":{\"amount\":510.75},\"cost_effective_from_date\":\"2024-08-21\"},\"apply_portal_rate\":false,\"notify\":true,\"skills\":[{\"add\":[{\"id\":\"8000000123001\",\"level\":\"intermediate\"}],\"remove\":[{\"id\":\"8000000123002\"}]}]}"
)

content(response, "text")

import Foundation

let url = URL(string: "https://projects.zoho.com/api/v3.1/portal/[PORTAL_ID]/users/[USER_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 = """
{"portal_profile":{"id":"23806000006123455432"},"role":{"id":"23806000006123455432"},"reporting_to":{"id":"23806000006123455432"},"business_hours":{"id":"23806000006123455432"},"bulk_projects":{"select_all":false,"selected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"unselected":{"group_ids":["2380600000612345"],"project_ids":["23806000074760021"]},"rateupdatedprojects":{"23806000074760021":"20"},"costrateupdatedprojects":{"23806000074760021":"15"}},"budget":{"rate_per_hour":{"amount":945.25},"cost_rate_per_hour":{"amount":510.75},"cost_effective_from_date":"2024-08-21"},"apply_portal_rate":false,"notify":true,"skills":[{"add":[{"id":"8000000123001","level":"intermediate"}],"remove":[{"id":"8000000123002"}]}]}
""".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

{ "portal_profile" : { "id" : "23806000006123455432" }, "role" : { "id" : "23806000006123455432" }, "reporting_to" : { "id" : "23806000006123455432" }, "business_hours" : { "id" : "23806000006123455432" }, "bulk_projects" : { "select_all" : false, "selected" : { "group_ids" : [ "2380600000612345" ], "project_ids" : [ "23806000074760021" ] }, "unselected" : { "group_ids" : [ "2380600000612345" ], "project_ids" : [ "23806000074760021" ] }, "rateupdatedprojects" : { "23806000074760021" : "20" }, "costrateupdatedprojects" : { "23806000074760021" : "15" } }, "budget" : { "rate_per_hour" : { "amount" : 945.25 }, "cost_rate_per_hour" : { "amount" : 510.75 }, "cost_effective_from_date" : "2024-08-21" }, "apply_portal_rate" : false, "notify" : true, "skills" : [ { "add" : [ { "id" : "8000000123001", "level" : "intermediate" } ], "remove" : [ { "id" : "8000000123002" } ] } ] }

Sample Response

204 No Content

Possible Errors

Update Users

Modify the details of existing users in the Zoho Projects portal.

POST

/api/v3.1/portal/[PORTAL_ID]/users

OAuth Scope:

ZohoProjects.users.UPDATE

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

users

JSONArray

required

Enter the user 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.1/portal/[PORTAL_ID]/users' \
-H 'Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa' \
--form-string 'users=[{"id":"23806000006123455432","portal_profile":{"id":"23806000006123455432"},"role":{"id":"23806000006123455432"},"reporting_to":{"id":"23806000006123455432"},"business_hours":{"id":"23806000006123455432"},"budget":{"rate_per_hour":{"amount":"-"},"cost_rate_per_hour":{"amount":"-"},"cost_effective_from_date":"2024-08-21"}}]'

url = "https://projects.zoho.com/api/v3.1/portal/[PORTAL_ID]/users";
params = Map();
params.put("users", [{"id":"23806000006123455432","portal_profile":{"id":"23806000006123455432"},"role":{"id":"23806000006123455432"},"reporting_to":{"id":"23806000006123455432"},"business_hours":{"id":"23806000006123455432"},"budget":{"rate_per_hour":{"amount":"-"},"cost_rate_per_hour":{"amount":"-"},"cost_effective_from_date":"2024-08-21"}}]);
response = invokeUrl
[
    url: url
    type: POST
    parameters: params
    connection: "projects"
];
info response;

const https = require('https');
const url = new URL('https://projects.zoho.com/api/v3.1/portal/[PORTAL_ID]/users');
url.searchParams.append('users', '[{"id":"23806000006123455432","portal_profile":{"id":"23806000006123455432"},"role":{"id":"23806000006123455432"},"reporting_to":{"id":"23806000006123455432"},"business_hours":{"id":"23806000006123455432"},"budget":{"rate_per_hour":{"amount":"-"},"cost_rate_per_hour":{"amount":"-"},"cost_effective_from_date":"2024-08-21"}}]');

const options = {
  hostname: url.hostname,
  path: url.pathname + url.search,
  method: 'POST',
  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.1/portal/[PORTAL_ID]/users")
params = {
  "users" => "[{\"id\":\"23806000006123455432\",\"portal_profile\":{\"id\":\"23806000006123455432\"},\"role\":{\"id\":\"23806000006123455432\"},\"reporting_to\":{\"id\":\"23806000006123455432\"},\"business_hours\":{\"id\":\"23806000006123455432\"},\"budget\":{\"rate_per_hour\":{\"amount\":\"-\"},\"cost_rate_per_hour\":{\"amount\":\"-\"},\"cost_effective_from_date\":\"2024-08-21\"}}]"
}
url.query = URI.encode_www_form(params)

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

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

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

<?php
$params = [
    'users' => '[{"id":"23806000006123455432","portal_profile":{"id":"23806000006123455432"},"role":{"id":"23806000006123455432"},"reporting_to":{"id":"23806000006123455432"},"business_hours":{"id":"23806000006123455432"},"budget":{"rate_per_hour":{"amount":"-"},"cost_rate_per_hour":{"amount":"-"},"cost_effective_from_date":"2024-08-21"}}]',
];
$url = "https://projects.zoho.com/api/v3.1/portal/[PORTAL_ID]/users" . "?" . http_build_query($params);

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => $url,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "POST",
  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.1/portal/[PORTAL_ID]/users"

params = {
    "users": "[{\"id\":\"23806000006123455432\",\"portal_profile\":{\"id\":\"23806000006123455432\"},\"role\":{\"id\":\"23806000006123455432\"},\"reporting_to\":{\"id\":\"23806000006123455432\"},\"business_hours\":{\"id\":\"23806000006123455432\"},\"budget\":{\"rate_per_hour\":{\"amount\":\"-\"},\"cost_rate_per_hour\":{\"amount\":\"-\"},\"cost_effective_from_date\":\"2024-08-21\"}}]"
}

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

response = requests.post(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_users = curl_easy_escape(curl, "[{\"id\":\"23806000006123455432\",\"portal_profile\":{\"id\":\"23806000006123455432\"},\"role\":{\"id\":\"23806000006123455432\"},\"reporting_to\":{\"id\":\"23806000006123455432\"},\"business_hours\":{\"id\":\"23806000006123455432\"},\"budget\":{\"rate_per_hour\":{\"amount\":\"-\"},\"cost_rate_per_hour\":{\"amount\":\"-\"},\"cost_effective_from_date\":\"2024-08-21\"}}]", 0);
        char url[2048];
        snprintf(url, sizeof(url), "https://projects.zoho.com/api/v3.1/portal/[PORTAL_ID]/users?users=%s", enc_users);

        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, "POST");

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

        curl_free(enc_users);
        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["users"] = "[{\"id\":\"23806000006123455432\",\"portal_profile\":{\"id\":\"23806000006123455432\"},\"role\":{\"id\":\"23806000006123455432\"},\"reporting_to\":{\"id\":\"23806000006123455432\"},\"business_hours\":{\"id\":\"23806000006123455432\"},\"budget\":{\"rate_per_hour\":{\"amount\":\"-\"},\"cost_rate_per_hour\":{\"amount\":\"-\"},\"cost_effective_from_date\":\"2024-08-21\"}}]";
var uriBuilder = new UriBuilder("https://projects.zoho.com/api/v3.1/portal/[PORTAL_ID]/users") { Query = query.ToString() };
var request = new HttpRequestMessage(HttpMethod.Post, 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_users = curl_easy_escape(curl, "[{\"id\":\"23806000006123455432\",\"portal_profile\":{\"id\":\"23806000006123455432\"},\"role\":{\"id\":\"23806000006123455432\"},\"reporting_to\":{\"id\":\"23806000006123455432\"},\"business_hours\":{\"id\":\"23806000006123455432\"},\"budget\":{\"rate_per_hour\":{\"amount\":\"-\"},\"cost_rate_per_hour\":{\"amount\":\"-\"},\"cost_effective_from_date\":\"2024-08-21\"}}]", 0);
        std::string url = "https://projects.zoho.com/api/v3.1/portal/[PORTAL_ID]/users";
        url += "?users=" + std::string(enc_users);

        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, "POST");
        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_users);
        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}

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

(let [enc-users (java.net.URLEncoder/encode "[{\"id\":\"23806000006123455432\",\"portal_profile\":{\"id\":\"23806000006123455432\"},\"role\":{\"id\":\"23806000006123455432\"},\"reporting_to\":{\"id\":\"23806000006123455432\"},\"business_hours\":{\"id\":\"23806000006123455432\"},\"budget\":{\"rate_per_hour\":{\"amount\":\"-\"},\"cost_rate_per_hour\":{\"amount\":\"-\"},\"cost_effective_from_date\":\"2024-08-21\"}}]" "UTF-8")
      url (str "https://projects.zoho.com/api/v3.1/portal/[PORTAL_ID]/users" "?users=" enc-users)]
(def response
  (client/post 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("POST", "https://projects.zoho.com/api/v3.1/portal/[PORTAL_ID]/users", nil)
    q := req.URL.Query()
    q.Add("users", "[{\"id\":\"23806000006123455432\",\"portal_profile\":{\"id\":\"23806000006123455432\"},\"role\":{\"id\":\"23806000006123455432\"},\"reporting_to\":{\"id\":\"23806000006123455432\"},\"business_hours\":{\"id\":\"23806000006123455432\"},\"budget\":{\"rate_per_hour\":{\"amount\":\"-\"},\"cost_rate_per_hour\":{\"amount\":\"-\"},\"cost_effective_from_date\":\"2024-08-21\"}}]")
    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))
}

POST https://projects.zoho.com/api/v3.1/portal/[PORTAL_ID]/users?users=%5B%7B%22id%22%3A%2223806000006123455432%22%2C%22portal_profile%22%3A%7B%22id%22%3A%2223806000006123455432%22%7D%2C%22role%22%3A%7B%22id%22%3A%2223806000006123455432%22%7D%2C%22reporting_to%22%3A%7B%22id%22%3A%2223806000006123455432%22%7D%2C%22business_hours%22%3A%7B%22id%22%3A%2223806000006123455432%22%7D%2C%22budget%22%3A%7B%22rate_per_hour%22%3A%7B%22amount%22%3A%22-%22%7D%2C%22cost_rate_per_hour%22%3A%7B%22amount%22%3A%22-%22%7D%2C%22cost_effective_from_date%22%3A%222024-08-21%22%7D%7D%5D HTTP/1.1
Host: https://projects.zoho.com/api/v3.1/portal/[PORTAL_ID]/users?users=%5B%7B%22id%22%3A%2223806000006123455432%22%2C%22portal_profile%22%3A%7B%22id%22%3A%2223806000006123455432%22%7D%2C%22role%22%3A%7B%22id%22%3A%2223806000006123455432%22%7D%2C%22reporting_to%22%3A%7B%22id%22%3A%2223806000006123455432%22%7D%2C%22business_hours%22%3A%7B%22id%22%3A%2223806000006123455432%22%7D%2C%22budget%22%3A%7B%22rate_per_hour%22%3A%7B%22amount%22%3A%22-%22%7D%2C%22cost_rate_per_hour%22%3A%7B%22amount%22%3A%22-%22%7D%2C%22cost_effective_from_date%22%3A%222024-08-21%22%7D%7D%5D
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.1/portal/[PORTAL_ID]/users");
uriBuilder.addParameter("users", "[{\"id\":\"23806000006123455432\",\"portal_profile\":{\"id\":\"23806000006123455432\"},\"role\":{\"id\":\"23806000006123455432\"},\"reporting_to\":{\"id\":\"23806000006123455432\"},\"business_hours\":{\"id\":\"23806000006123455432\"},\"budget\":{\"rate_per_hour\":{\"amount\":\"-\"},\"cost_rate_per_hour\":{\"amount\":\"-\"},\"cost_effective_from_date\":\"2024-08-21\"}}]");
HttpUriRequest requestObj = new HttpPost(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.1/portal/[PORTAL_ID]/users';

const params = new URLSearchParams({
  'users': '[{"id":"23806000006123455432","portal_profile":{"id":"23806000006123455432"},"role":{"id":"23806000006123455432"},"reporting_to":{"id":"23806000006123455432"},"business_hours":{"id":"23806000006123455432"},"budget":{"rate_per_hour":{"amount":"-"},"cost_rate_per_hour":{"amount":"-"},"cost_effective_from_date":"2024-08-21"}}]'
});

const options = {
  method: 'POST',
  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));

users = [{"id":"23806000006123455432","portal_profile":{"id":"23806000006123455432"},"role":{"id":"23806000006123455432"},"reporting_to":{"id":"23806000006123455432"},"business_hours":{"id":"23806000006123455432"},"budget":{"rate_per_hour":{"amount":"-"},"cost_rate_per_hour":{"amount":"-"},"cost_effective_from_date":"2024-08-21"}}]

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

fun main() {
    val urlBuilder = "https://projects.zoho.com/api/v3.1/portal/[PORTAL_ID]/users".toHttpUrl().newBuilder()
    urlBuilder.addQueryParameter("users", "[{\"id\":\"23806000006123455432\",\"portal_profile\":{\"id\":\"23806000006123455432\"},\"role\":{\"id\":\"23806000006123455432\"},\"reporting_to\":{\"id\":\"23806000006123455432\"},\"business_hours\":{\"id\":\"23806000006123455432\"},\"budget\":{\"rate_per_hour\":{\"amount\":\"-\"},\"cost_rate_per_hour\":{\"amount\":\"-\"},\"cost_effective_from_date\":\"2024-08-21\"}}]")
    val url = URL(urlBuilder.build().toString())
    val conn = url.openConnection() as HttpURLConnection
    conn.requestMethod = "POST"
    conn.setRequestProperty("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa")

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

NSString *encodedUsers = [@"[{\"id\":\"23806000006123455432\",\"portal_profile\":{\"id\":\"23806000006123455432\"},\"role\":{\"id\":\"23806000006123455432\"},\"reporting_to\":{\"id\":\"23806000006123455432\"},\"business_hours\":{\"id\":\"23806000006123455432\"},\"budget\":{\"rate_per_hour\":{\"amount\":\"-\"},\"cost_rate_per_hour\":{\"amount\":\"-\"},\"cost_effective_from_date\":\"2024-08-21\"}}]" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *urlString = [NSString stringWithFormat:@"https://projects.zoho.com/api/v3.1/portal/[PORTAL_ID]/users?users=%@", encodedUsers];
NSURL *url = [NSURL URLWithString:urlString];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:url];
[request setHTTPMethod:@"POST"];
[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_users = Uri.pct_encode "[{\"id\":\"23806000006123455432\",\"portal_profile\":{\"id\":\"23806000006123455432\"},\"role\":{\"id\":\"23806000006123455432\"},\"reporting_to\":{\"id\":\"23806000006123455432\"},\"business_hours\":{\"id\":\"23806000006123455432\"},\"budget\":{\"rate_per_hour\":{\"amount\":\"-\"},\"cost_rate_per_hour\":{\"amount\":\"-\"},\"cost_effective_from_date\":\"2024-08-21\"}}]" in
  let uri = Uri.of_string ("https://projects.zoho.com/api/v3.1/portal/[PORTAL_ID]/users" ^ "?users=" ^ enc_users) in
  let headers = Cohttp.Header.init ()
    |> fun h -> Cohttp.Header.add h "Authorization" "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
  in
  Lwt_main.run (
    Client.post ~headers uri >>= fun (_, body) ->
    Cohttp_lwt.Body.to_string body >|= fun s ->
    print_endline s)

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

$params = @{
    users = "[{`"id`":`"23806000006123455432`",`"portal_profile`":{`"id`":`"23806000006123455432`"},`"role`":{`"id`":`"23806000006123455432`"},`"reporting_to`":{`"id`":`"23806000006123455432`"},`"business_hours`":{`"id`":`"23806000006123455432`"},`"budget`":{`"rate_per_hour`":{`"amount`":`"-`"},`"cost_rate_per_hour`":{`"amount`":`"-`"},`"cost_effective_from_date`":`"2024-08-21`"}}]"
}
$queryString = ($params.GetEnumerator() | ForEach-Object { "$($_.Key)=$([System.Uri]::EscapeDataString($_.Value))" }) -join "&"
$url = "https://projects.zoho.com/api/v3.1/portal/[PORTAL_ID]/users" + "?" + $queryString

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

$response | ConvertTo-Json

library(httr)

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

params <- list(
  users = "[{\"id\":\"23806000006123455432\",\"portal_profile\":{\"id\":\"23806000006123455432\"},\"role\":{\"id\":\"23806000006123455432\"},\"reporting_to\":{\"id\":\"23806000006123455432\"},\"business_hours\":{\"id\":\"23806000006123455432\"},\"budget\":{\"rate_per_hour\":{\"amount\":\"-\"},\"cost_rate_per_hour\":{\"amount\":\"-\"},\"cost_effective_from_date\":\"2024-08-21\"}}]"
)

response <- POST(
  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.1/portal/[PORTAL_ID]/users")!
components.queryItems = [
    URLQueryItem(name: "users", value: "[{\"id\":\"23806000006123455432\",\"portal_profile\":{\"id\":\"23806000006123455432\"},\"role\":{\"id\":\"23806000006123455432\"},\"reporting_to\":{\"id\":\"23806000006123455432\"},\"business_hours\":{\"id\":\"23806000006123455432\"},\"budget\":{\"rate_per_hour\":{\"amount\":\"-\"},\"cost_rate_per_hour\":{\"amount\":\"-\"},\"cost_effective_from_date\":\"2024-08-21\"}}]")
]
let url = components.url!
var request = URLRequest(url: url)
request.httpMethod = "POST"
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

users : [ { "id" : "23806000006123455432", "portal_profile" : { "id" : "23806000006123455432" }, "role" : { "id" : "23806000006123455432" }, "reporting_to" : { "id" : "23806000006123455432" }, "business_hours" : { "id" : "23806000006123455432" }, "budget" : { "rate_per_hour" : { "amount" : "-" }, "cost_rate_per_hour" : { "amount" : "-" }, "cost_effective_from_date" : "2024-08-21" } } ]

Sample Response

200{ }