Zoho Projects API Documentation
Text copied
File not found

Record Export

This module covers operations related to record export within Zoho Projects. Use this API to create, retrieve, update, or delete a Custom Module export, and to toggle a scheduled export on or off.

Create Portal Export

Create a Custom Module export in the Zoho Projects portal. Use this API to export records immediately, or to set up a recurring export by passing schedule_info.

Pass project_id to scope the export to a single project. Omit it to export across the whole portal.

POST

/api/v3/portal/[PORTAL_ID]/module/[MODULE_ID]/export

OAuth Scope:

ZohoProjects.portals.CREATE

Path Parameters

Param Name
Data Type
Description

Body Parameters

Param Name
Data Type
Description

Request Example

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]/module/1752587000000097269/export' \
-H 'Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa' \
-H 'Content-Type: application/json' \
-d '{"file_format":"xlsx","selected_fields":["name","status"],"project_id":1752587000000097269,"filter":{"pattern":"1","criteria":[{"field_name":"status","condition":"is","value":["1752587000000097269"]}]},"schedule_info":{"name":"Weekly Record Export","schedule_datetime":"2026-02-14T10:10:00.000Z","repetative_type":4,"time_span":1,"days_of_week":["1"],"skip_type":1,"mail_to_user":{"zpuid":["27000000007031"]}},"access_code":"SampleAccessCode","scheduler_status":true}'

url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export";
params = Map();
params.put("file_format", "xlsx");
params.put("selected_fields", ["name","status"]);
params.put("project_id", 1752587000000097269);
params.put("filter", {"pattern":"1","criteria":[{"field_name":"status","condition":"is","value":["1752587000000097269"]}]});
params.put("schedule_info", {"name":"Weekly Record Export","schedule_datetime":"2026-02-14T10:10:00.000Z","repetative_type":4,"time_span":1,"days_of_week":["1"],"skip_type":1,"mail_to_user":{"zpuid":["27000000007031"]}});
params.put("access_code", "SampleAccessCode");
params.put("scheduler_status", true);
response = invokeUrl
[
    url: url
    type: POST
    parameters: params.toString()
    connection: "projects"
];
info response;
const https = require('https');
const url = new URL('https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export');

const payload = JSON.stringify({"file_format":"xlsx","selected_fields":["name","status"],"project_id":1752587000000097269,"filter":{"pattern":"1","criteria":[{"field_name":"status","condition":"is","value":["1752587000000097269"]}]},"schedule_info":{"name":"Weekly Record Export","schedule_datetime":"2026-02-14T10:10:00.000Z","repetative_type":4,"time_span":1,"days_of_week":["1"],"skip_type":1,"mail_to_user":{"zpuid":["27000000007031"]}},"access_code":"SampleAccessCode","scheduler_status":true});

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

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

req.on('error', (err) => { console.error(err); });
req.write(payload);
req.end();
require 'net/http'
require 'uri'
require 'json'

url = URI("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
request["Content-Type"] = "application/json"
request.body = '{"file_format":"xlsx","selected_fields":["name","status"],"project_id":1752587000000097269,"filter":{"pattern":"1","criteria":[{"field_name":"status","condition":"is","value":["1752587000000097269"]}]},"schedule_info":{"name":"Weekly Record Export","schedule_datetime":"2026-02-14T10:10:00.000Z","repetative_type":4,"time_span":1,"days_of_week":["1"],"skip_type":1,"mail_to_user":{"zpuid":["27000000007031"]}},"access_code":"SampleAccessCode","scheduler_status":true}'

response = http.request(request)
puts response.read_body
<?php
$url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export";

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => $url,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => '{"file_format":"xlsx","selected_fields":["name","status"],"project_id":1752587000000097269,"filter":{"pattern":"1","criteria":[{"field_name":"status","condition":"is","value":["1752587000000097269"]}]},"schedule_info":{"name":"Weekly Record Export","schedule_datetime":"2026-02-14T10:10:00.000Z","repetative_type":4,"time_span":1,"days_of_week":["1"],"skip_type":1,"mail_to_user":{"zpuid":["27000000007031"]}},"access_code":"SampleAccessCode","scheduler_status":true}',
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa",
    "Content-Type: application/json"
  ],
]);

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

echo $response;
import requests

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

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

payload = '{"file_format":"xlsx","selected_fields":["name","status"],"project_id":1752587000000097269,"filter":{"pattern":"1","criteria":[{"field_name":"status","condition":"is","value":["1752587000000097269"]}]},"schedule_info":{"name":"Weekly Record Export","schedule_datetime":"2026-02-14T10:10:00.000Z","repetative_type":4,"time_span":1,"days_of_week":["1"],"skip_type":1,"mail_to_user":{"zpuid":["27000000007031"]}},"access_code":"SampleAccessCode","scheduler_status":true}'

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

print(response.json())
#include <stdio.h>
#include <string.h>
#include <curl/curl.h>

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

        curl_easy_setopt(curl, CURLOPT_URL, "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export");
        curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
        curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "POST");
        curl_easy_setopt(curl, CURLOPT_POSTFIELDS, "{\"file_format\":\"xlsx\",\"selected_fields\":[\"name\",\"status\"],\"project_id\":1752587000000097269,\"filter\":{\"pattern\":\"1\",\"criteria\":[{\"field_name\":\"status\",\"condition\":\"is\",\"value\":[\"1752587000000097269\"]}]},\"schedule_info\":{\"name\":\"Weekly Record Export\",\"schedule_datetime\":\"2026-02-14T10:10:00.000Z\",\"repetative_type\":4,\"time_span\":1,\"days_of_week\":[\"1\"],\"skip_type\":1,\"mail_to_user\":{\"zpuid\":[\"27000000007031\"]}},\"access_code\":\"SampleAccessCode\",\"scheduler_status\":true}");

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

        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}
using System.Net.Http;
using System.Text;
using System.Web;

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

var request = new HttpRequestMessage(HttpMethod.Post, "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export");
request.Content = new StringContent(
    @"{""file_format"":""xlsx"",""selected_fields"":[""name"",""status""],""project_id"":1752587000000097269,""filter"":{""pattern"":""1"",""criteria"":[{""field_name"":""status"",""condition"":""is"",""value"":[""1752587000000097269""]}]},""schedule_info"":{""name"":""Weekly Record Export"",""schedule_datetime"":""2026-02-14T10:10:00.000Z"",""repetative_type"":4,""time_span"":1,""days_of_week"":[""1""],""skip_type"":1,""mail_to_user"":{""zpuid"":[""27000000007031""]}},""access_code"":""SampleAccessCode"",""scheduler_status"":true}",
    Encoding.UTF8,
    "application/json"
);

var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
#include <iostream>
#include <string>
#include <curl/curl.h>

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

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

        curl_easy_setopt(curl, CURLOPT_URL, "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export");
        curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
        curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "POST");
        curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, WriteCallback);
        curl_easy_setopt(curl, CURLOPT_WRITEDATA, &response);
        curl_easy_setopt(curl, CURLOPT_POSTFIELDS, "{\"file_format\":\"xlsx\",\"selected_fields\":[\"name\",\"status\"],\"project_id\":1752587000000097269,\"filter\":{\"pattern\":\"1\",\"criteria\":[{\"field_name\":\"status\",\"condition\":\"is\",\"value\":[\"1752587000000097269\"]}]},\"schedule_info\":{\"name\":\"Weekly Record Export\",\"schedule_datetime\":\"2026-02-14T10:10:00.000Z\",\"repetative_type\":4,\"time_span\":1,\"days_of_week\":[\"1\"],\"skip_type\":1,\"mail_to_user\":{\"zpuid\":[\"27000000007031\"]}},\"access_code\":\"SampleAccessCode\",\"scheduler_status\":true}");

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

        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}
(require '[clj-http.client :as client])

(def response
  (client/post "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export"
    {:headers {"Authorization" "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
                "Content-Type" "application/json"}
     :body "{\"file_format\":\"xlsx\",\"selected_fields\":[\"name\",\"status\"],\"project_id\":1752587000000097269,\"filter\":{\"pattern\":\"1\",\"criteria\":[{\"field_name\":\"status\",\"condition\":\"is\",\"value\":[\"1752587000000097269\"]}]},\"schedule_info\":{\"name\":\"Weekly Record Export\",\"schedule_datetime\":\"2026-02-14T10:10:00.000Z\",\"repetative_type\":4,\"time_span\":1,\"days_of_week\":[\"1\"],\"skip_type\":1,\"mail_to_user\":{\"zpuid\":[\"27000000007031\"]}},\"access_code\":\"SampleAccessCode\",\"scheduler_status\":true}"
     :as :json}))

(println (:body response))
package main

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

func main() {
    payload := strings.NewReader("{\"file_format\":\"xlsx\",\"selected_fields\":[\"name\",\"status\"],\"project_id\":1752587000000097269,\"filter\":{\"pattern\":\"1\",\"criteria\":[{\"field_name\":\"status\",\"condition\":\"is\",\"value\":[\"1752587000000097269\"]}]},\"schedule_info\":{\"name\":\"Weekly Record Export\",\"schedule_datetime\":\"2026-02-14T10:10:00.000Z\",\"repetative_type\":4,\"time_span\":1,\"days_of_week\":[\"1\"],\"skip_type\":1,\"mail_to_user\":{\"zpuid\":[\"27000000007031\"]}},\"access_code\":\"SampleAccessCode\",\"scheduler_status\":true}")
    req, _ := http.NewRequest("POST", "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export", payload)
    req.Header.Add("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa")
    req.Header.Add("Content-Type", "application/json")

    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}
POST https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export HTTP/1.1
Host: https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export
Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa
Content-Type: application/json

{"file_format":"xlsx","selected_fields":["name","status"],"project_id":1752587000000097269,"filter":{"pattern":"1","criteria":[{"field_name":"status","condition":"is","value":["1752587000000097269"]}]},"schedule_info":{"name":"Weekly Record Export","schedule_datetime":"2026-02-14T10:10:00.000Z","repetative_type":4,"time_span":1,"days_of_week":["1"],"skip_type":1,"mail_to_user":{"zpuid":["27000000007031"]}},"access_code":"SampleAccessCode","scheduler_status":true}
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]/module/1752587000000097269/export");
HttpUriRequest requestObj = new HttpPost(uriBuilder.build());
requestObj.addHeader("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");

HttpEntityEnclosingRequestBase requestBase = (HttpEntityEnclosingRequestBase) requestObj;
String requestBody = "{\"file_format\":\"xlsx\",\"selected_fields\":[\"name\",\"status\"],\"project_id\":1752587000000097269,\"filter\":{\"pattern\":\"1\",\"criteria\":[{\"field_name\":\"status\",\"condition\":\"is\",\"value\":[\"1752587000000097269\"]}]},\"schedule_info\":{\"name\":\"Weekly Record Export\",\"schedule_datetime\":\"2026-02-14T10:10:00.000Z\",\"repetative_type\":4,\"time_span\":1,\"days_of_week\":[\"1\"],\"skip_type\":1,\"mail_to_user\":{\"zpuid\":[\"27000000007031\"]}},\"access_code\":\"SampleAccessCode\",\"scheduler_status\":true}";
requestBase.setEntity(new StringEntity(requestBody, HTTP.UTF_8));

HttpResponse response = httpclient.execute(requestObj);

HttpEntity responseEntity = response.getEntity();
Object responseObject = EntityUtils.toString(responseEntity);
String responseString = responseObject.toString();
const url = 'https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export';

const options = {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({"file_format":"xlsx","selected_fields":["name","status"],"project_id":1752587000000097269,"filter":{"pattern":"1","criteria":[{"field_name":"status","condition":"is","value":["1752587000000097269"]}]},"schedule_info":{"name":"Weekly Record Export","schedule_datetime":"2026-02-14T10:10:00.000Z","repetative_type":4,"time_span":1,"days_of_week":["1"],"skip_type":1,"mail_to_user":{"zpuid":["27000000007031"]}},"access_code":"SampleAccessCode","scheduler_status":true})
};

fetch(url, options)
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error(error));
{"file_format":"xlsx","selected_fields":["name","status"],"project_id":1752587000000097269,"filter":{"pattern":"1","criteria":[{"field_name":"status","condition":"is","value":["1752587000000097269"]}]},"schedule_info":{"name":"Weekly Record Export","schedule_datetime":"2026-02-14T10:10:00.000Z","repetative_type":4,"time_span":1,"days_of_week":["1"],"skip_type":1,"mail_to_user":{"zpuid":["27000000007031"]}},"access_code":"SampleAccessCode","scheduler_status":true}
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]/module/1752587000000097269/export")
    val conn = url.openConnection() as HttpURLConnection
    conn.requestMethod = "POST"
    conn.setRequestProperty("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa")
    conn.setRequestProperty("Content-Type", "application/json")
    conn.doOutput = true
    conn.outputStream.bufferedWriter().use { it.write("""{"file_format":"xlsx","selected_fields":["name","status"],"project_id":1752587000000097269,"filter":{"pattern":"1","criteria":[{"field_name":"status","condition":"is","value":["1752587000000097269"]}]},"schedule_info":{"name":"Weekly Record Export","schedule_datetime":"2026-02-14T10:10:00.000Z","repetative_type":4,"time_span":1,"days_of_week":["1"],"skip_type":1,"mail_to_user":{"zpuid":["27000000007031"]}},"access_code":"SampleAccessCode","scheduler_status":true}""") }

    val response = conn.inputStream.bufferedReader().readText()
    println(response)
}
NSURL *url = [NSURL URLWithString:@"https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export"];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:url];
[request setHTTPMethod:@"POST"];
[request setValue:@"Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa" forHTTPHeaderField:@"Authorization"];
[request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
NSData *body = [@"{\"file_format\":\"xlsx\",\"selected_fields\":[\"name\",\"status\"],\"project_id\":1752587000000097269,\"filter\":{\"pattern\":\"1\",\"criteria\":[{\"field_name\":\"status\",\"condition\":\"is\",\"value\":[\"1752587000000097269\"]}]},\"schedule_info\":{\"name\":\"Weekly Record Export\",\"schedule_datetime\":\"2026-02-14T10:10:00.000Z\",\"repetative_type\":4,\"time_span\":1,\"days_of_week\":[\"1\"],\"skip_type\":1,\"mail_to_user\":{\"zpuid\":[\"27000000007031\"]}},\"access_code\":\"SampleAccessCode\",\"scheduler_status\":true}" dataUsingEncoding:NSUTF8StringEncoding];
[request setHTTPBody:body];

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

let () =
  let uri = Uri.of_string "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export" 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|{"file_format":"xlsx","selected_fields":["name","status"],"project_id":1752587000000097269,"filter":{"pattern":"1","criteria":[{"field_name":"status","condition":"is","value":["1752587000000097269"]}]},"schedule_info":{"name":"Weekly Record Export","schedule_datetime":"2026-02-14T10:10:00.000Z","repetative_type":4,"time_span":1,"days_of_week":["1"],"skip_type":1,"mail_to_user":{"zpuid":["27000000007031"]}},"access_code":"SampleAccessCode","scheduler_status":true}|json} in
  Lwt_main.run (
    Client.post ~headers ~body uri >>= fun (_, body) ->
    Cohttp_lwt.Body.to_string body >|= fun s ->
    print_endline s)
$headers = @{
    "Authorization" = "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
    "Content-Type" = "application/json"
}

$body = @'
{"file_format":"xlsx","selected_fields":["name","status"],"project_id":1752587000000097269,"filter":{"pattern":"1","criteria":[{"field_name":"status","condition":"is","value":["1752587000000097269"]}]},"schedule_info":{"name":"Weekly Record Export","schedule_datetime":"2026-02-14T10:10:00.000Z","repetative_type":4,"time_span":1,"days_of_week":["1"],"skip_type":1,"mail_to_user":{"zpuid":["27000000007031"]}},"access_code":"SampleAccessCode","scheduler_status":true}
'@

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

$response | ConvertTo-Json
library(httr)

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

response <- POST(
  url,
  add_headers(Authorization = "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"),
  content_type_json(),
  body = "{\"file_format\":\"xlsx\",\"selected_fields\":[\"name\",\"status\"],\"project_id\":1752587000000097269,\"filter\":{\"pattern\":\"1\",\"criteria\":[{\"field_name\":\"status\",\"condition\":\"is\",\"value\":[\"1752587000000097269\"]}]},\"schedule_info\":{\"name\":\"Weekly Record Export\",\"schedule_datetime\":\"2026-02-14T10:10:00.000Z\",\"repetative_type\":4,\"time_span\":1,\"days_of_week\":[\"1\"],\"skip_type\":1,\"mail_to_user\":{\"zpuid\":[\"27000000007031\"]}},\"access_code\":\"SampleAccessCode\",\"scheduler_status\":true}"
)

content(response, "text")
import Foundation

let url = URL(string: "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export")!
var request = URLRequest(url: url)
request.httpMethod = "POST"
request.setValue("Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa", forHTTPHeaderField: "Authorization")
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
request.httpBody = """
{"file_format":"xlsx","selected_fields":["name","status"],"project_id":1752587000000097269,"filter":{"pattern":"1","criteria":[{"field_name":"status","condition":"is","value":["1752587000000097269"]}]},"schedule_info":{"name":"Weekly Record Export","schedule_datetime":"2026-02-14T10:10:00.000Z","repetative_type":4,"time_span":1,"days_of_week":["1"],"skip_type":1,"mail_to_user":{"zpuid":["27000000007031"]}},"access_code":"SampleAccessCode","scheduler_status":true}
""".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
{ "file_format" : "xlsx", "selected_fields" : [ "name", "status" ], "project_id" : 1752587000000097269, "filter" : { "pattern" : "1", "criteria" : [ { "field_name" : "status", "condition" : "is", "value" : [ "1752587000000097269" ] } ] }, "schedule_info" : { "name" : "Weekly Record Export", "schedule_datetime" : "2026-02-14T10:10:00.000Z", "repetative_type" : 4, "time_span" : 1, "days_of_week" : [ "1" ], "skip_type" : 1, "mail_to_user" : { "zpuid" : [ "27000000007031" ] } }, "access_code" : "SampleAccessCode", "scheduler_status" : true }

Sample Response

200{ "export_id" : "27000000009001", "schedule_id" : "27000000009003" }

Get Portal Exports

Retrieve scheduled and completed exports for a portal-level Custom Module. Use is_completed to choose between the two: pass false for exports that are still scheduled, and true for exports that have finished and can be downloaded.

GET

/api/v3/portal/[PORTAL_ID]/module/[MODULE_ID]/export

OAuth Scope:

ZohoProjects.portals.READ

Path Parameters

Param Name
Data Type
Description

Query Parameters

Param Name
Data Type
Description

Request Example

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]/module/1752587000000097269/export?project_id=1752587000000097269&view=portal&filter=%7B%22criteria%22%3A%5B%7B%22api_name%22%3A%22-%22%2C%22field_name%22%3A%22status%22%2C%22criteria_condition%22%3A%22is%22%2C%22value%22%3A%5B%221752587000000097269%22%5D%7D%5D%2C%22pattern%22%3A%221+AND+2%22%7D&is_completed=false' \
-H 'Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa'

url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export";
filter_value = {"criteria":[{"api_name":"-","field_name":"status","criteria_condition":"is","value":["1752587000000097269"]}],"pattern":"1 AND 2"};
params = Map();
params.put("project_id", 1752587000000097269);
params.put("view", "portal");
params.put("filter", filter_value);
params.put("is_completed", false);
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]/module/1752587000000097269/export');
url.searchParams.append('project_id', '1752587000000097269');
url.searchParams.append('view', 'portal');
url.searchParams.append('filter', '{"criteria":[{"api_name":"-","field_name":"status","criteria_condition":"is","value":["1752587000000097269"]}],"pattern":"1 AND 2"}');
url.searchParams.append('is_completed', 'false');

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]/module/1752587000000097269/export")
params = {
  "project_id" => "1752587000000097269",
  "view" => "portal",
  "filter" => "{\"criteria\":[{\"api_name\":\"-\",\"field_name\":\"status\",\"criteria_condition\":\"is\",\"value\":[\"1752587000000097269\"]}],\"pattern\":\"1 AND 2\"}",
  "is_completed" => "false"
}
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 = [
    'project_id' => '1752587000000097269',
    'view' => 'portal',
    'filter' => '{"criteria":[{"api_name":"-","field_name":"status","criteria_condition":"is","value":["1752587000000097269"]}],"pattern":"1 AND 2"}',
    'is_completed' => 'false',
];
$url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export" . "?" . 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]/module/1752587000000097269/export"

params = {
    "project_id": "1752587000000097269",
    "view": "portal",
    "filter": "{\"criteria\":[{\"api_name\":\"-\",\"field_name\":\"status\",\"criteria_condition\":\"is\",\"value\":[\"1752587000000097269\"]}],\"pattern\":\"1 AND 2\"}",
    "is_completed": "false"
}

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_project_id = curl_easy_escape(curl, "1752587000000097269", 0);
        char *enc_view = curl_easy_escape(curl, "portal", 0);
        char *enc_filter = curl_easy_escape(curl, "{\"criteria\":[{\"api_name\":\"-\",\"field_name\":\"status\",\"criteria_condition\":\"is\",\"value\":[\"1752587000000097269\"]}],\"pattern\":\"1 AND 2\"}", 0);
        char *enc_is_completed = curl_easy_escape(curl, "false", 0);
        char url[2048];
        snprintf(url, sizeof(url), "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export?project_id=%s&view=%s&filter=%s&is_completed=%s", enc_project_id, enc_view, enc_filter, enc_is_completed);

        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_project_id);
        curl_free(enc_view);
        curl_free(enc_filter);
        curl_free(enc_is_completed);
        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["project_id"] = "1752587000000097269";
query["view"] = "portal";
query["filter"] = "{\"criteria\":[{\"api_name\":\"-\",\"field_name\":\"status\",\"criteria_condition\":\"is\",\"value\":[\"1752587000000097269\"]}],\"pattern\":\"1 AND 2\"}";
query["is_completed"] = "false";
var uriBuilder = new UriBuilder("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export") { 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_project_id = curl_easy_escape(curl, "1752587000000097269", 0);
        char* enc_view = curl_easy_escape(curl, "portal", 0);
        char* enc_filter = curl_easy_escape(curl, "{\"criteria\":[{\"api_name\":\"-\",\"field_name\":\"status\",\"criteria_condition\":\"is\",\"value\":[\"1752587000000097269\"]}],\"pattern\":\"1 AND 2\"}", 0);
        char* enc_is_completed = curl_easy_escape(curl, "false", 0);
        std::string url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export";
        url += "?project_id=" + std::string(enc_project_id);
        url += "&view=" + std::string(enc_view);
        url += "&filter=" + std::string(enc_filter);
        url += "&is_completed=" + std::string(enc_is_completed);

        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_project_id);
        curl_free(enc_view);
        curl_free(enc_filter);
        curl_free(enc_is_completed);
        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}
(require '[clj-http.client :as client])

(let [enc-project_id (java.net.URLEncoder/encode "1752587000000097269" "UTF-8")
      enc-view (java.net.URLEncoder/encode "portal" "UTF-8")
      enc-filter (java.net.URLEncoder/encode "{\"criteria\":[{\"api_name\":\"-\",\"field_name\":\"status\",\"criteria_condition\":\"is\",\"value\":[\"1752587000000097269\"]}],\"pattern\":\"1 AND 2\"}" "UTF-8")
      enc-is_completed (java.net.URLEncoder/encode "false" "UTF-8")
      url (str "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export" "?project_id=" enc-project_id "&view=" enc-view "&filter=" enc-filter "&is_completed=" enc-is_completed)]
(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]/module/1752587000000097269/export", nil)
    q := req.URL.Query()
    q.Add("project_id", "1752587000000097269")
    q.Add("view", "portal")
    q.Add("filter", "{\"criteria\":[{\"api_name\":\"-\",\"field_name\":\"status\",\"criteria_condition\":\"is\",\"value\":[\"1752587000000097269\"]}],\"pattern\":\"1 AND 2\"}")
    q.Add("is_completed", "false")
    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]/module/1752587000000097269/export?project_id=1752587000000097269&view=portal&filter=%7B%22criteria%22%3A%5B%7B%22api_name%22%3A%22-%22%2C%22field_name%22%3A%22status%22%2C%22criteria_condition%22%3A%22is%22%2C%22value%22%3A%5B%221752587000000097269%22%5D%7D%5D%2C%22pattern%22%3A%221+AND+2%22%7D&is_completed=false HTTP/1.1
Host: https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export?project_id=1752587000000097269&view=portal&filter=%7B%22criteria%22%3A%5B%7B%22api_name%22%3A%22-%22%2C%22field_name%22%3A%22status%22%2C%22criteria_condition%22%3A%22is%22%2C%22value%22%3A%5B%221752587000000097269%22%5D%7D%5D%2C%22pattern%22%3A%221+AND+2%22%7D&is_completed=false
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]/module/1752587000000097269/export");
uriBuilder.addParameter("project_id", "1752587000000097269");
uriBuilder.addParameter("view", "portal");
uriBuilder.addParameter("filter", "{\"criteria\":[{\"api_name\":\"-\",\"field_name\":\"status\",\"criteria_condition\":\"is\",\"value\":[\"1752587000000097269\"]}],\"pattern\":\"1 AND 2\"}");
uriBuilder.addParameter("is_completed", "false");
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]/module/1752587000000097269/export';

const params = new URLSearchParams({
  'project_id': '1752587000000097269',
  'view': 'portal',
  'filter': '{"criteria":[{"api_name":"-","field_name":"status","criteria_condition":"is","value":["1752587000000097269"]}],"pattern":"1 AND 2"}',
  'is_completed': 'false'
});

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));
project_id = 1752587000000097269
view = "portal"
filter = {"criteria":[{"api_name":"-","field_name":"status","criteria_condition":"is","value":["1752587000000097269"]}],"pattern":"1 AND 2"}
is_completed = false
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]/module/1752587000000097269/export".toHttpUrl().newBuilder()
    urlBuilder.addQueryParameter("project_id", "1752587000000097269")
    urlBuilder.addQueryParameter("view", "portal")
    urlBuilder.addQueryParameter("filter", "{\"criteria\":[{\"api_name\":\"-\",\"field_name\":\"status\",\"criteria_condition\":\"is\",\"value\":[\"1752587000000097269\"]}],\"pattern\":\"1 AND 2\"}")
    urlBuilder.addQueryParameter("is_completed", "false")
    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 *encodedProject_id = [@"1752587000000097269" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *encodedView = [@"portal" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *encodedFilter = [@"{\"criteria\":[{\"api_name\":\"-\",\"field_name\":\"status\",\"criteria_condition\":\"is\",\"value\":[\"1752587000000097269\"]}],\"pattern\":\"1 AND 2\"}" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *encodedIs_completed = [@"false" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *urlString = [NSString stringWithFormat:@"https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export?project_id=%@&view=%@&filter=%@&is_completed=%@", encodedProject_id, encodedView, encodedFilter, encodedIs_completed];
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_project_id = Uri.pct_encode "1752587000000097269" in
  let enc_view = Uri.pct_encode "portal" in
  let enc_filter = Uri.pct_encode "{\"criteria\":[{\"api_name\":\"-\",\"field_name\":\"status\",\"criteria_condition\":\"is\",\"value\":[\"1752587000000097269\"]}],\"pattern\":\"1 AND 2\"}" in
  let enc_is_completed = Uri.pct_encode "false" in
  let uri = Uri.of_string ("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export" ^ "?project_id=" ^ enc_project_id ^ "&view=" ^ enc_view ^ "&filter=" ^ enc_filter ^ "&is_completed=" ^ enc_is_completed) 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 = @{
    project_id = "1752587000000097269"
    view = "portal"
    filter = "{`"criteria`":[{`"api_name`":`"-`",`"field_name`":`"status`",`"criteria_condition`":`"is`",`"value`":[`"1752587000000097269`"]}],`"pattern`":`"1 AND 2`"}"
    is_completed = "false"
}
$queryString = ($params.GetEnumerator() | ForEach-Object { "$($_.Key)=$([System.Uri]::EscapeDataString($_.Value))" }) -join "&"
$url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export" + "?" + $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]/module/1752587000000097269/export"

params <- list(
  project_id = "1752587000000097269",
  view = "portal",
  filter = "{\"criteria\":[{\"api_name\":\"-\",\"field_name\":\"status\",\"criteria_condition\":\"is\",\"value\":[\"1752587000000097269\"]}],\"pattern\":\"1 AND 2\"}",
  is_completed = "false"
)

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]/module/1752587000000097269/export")!
components.queryItems = [
    URLQueryItem(name: "project_id", value: "1752587000000097269"),
    URLQueryItem(name: "view", value: "portal"),
    URLQueryItem(name: "filter", value: "{\"criteria\":[{\"api_name\":\"-\",\"field_name\":\"status\",\"criteria_condition\":\"is\",\"value\":[\"1752587000000097269\"]}],\"pattern\":\"1 AND 2\"}"),
    URLQueryItem(name: "is_completed", value: "false")
]
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

project_id : 1752587000000097269 view : "portal" filter : { "criteria" : [ { "api_name" : "-", "field_name" : "status", "criteria_condition" : "is", "value" : [ "1752587000000097269" ] } ], "pattern" : "1 AND 2" } is_completed : false

Sample Response

200[ { "id" : "27000000009001", "file_format" : "xlsx", "status" : "SCHEDULED", "project_type" : "active", "scheduler_status" : "scheduled", "is_file_info_needed" : false, "exported_time" : "2026-02-14T10:10:00.000Z", "view" : { "id" : "27000000006267", "name" : "" }, "schedule_info" : { "id" : "27000000009003", "name" : "Weekly Record Export", "status" : "on", "repetative_type" : "4", "time_span" : "1", "skip_type" : "1", "ends_after_type" : "0", "executed_count" : "0", "next_schedule_time" : "2026-02-14T10:10:00.000Z" }, "created_by" : { "zuid" : "45524228", "zpuid" : "27000000007031", "name" : "Reece Turner", "first_name" : "Reece", "last_name" : "Reed" }, "notify_users" : [ { "zuid" : "45524228", "zpuid" : "27000000007031", "name" : "Reece Turner", "first_name" : "Reece", "last_name" : "Reed" } ] } ]

Get Portal Export Details

Retrieve the details of a specific portal-level Custom Module export, including its file format, selected fields, filter criteria, schedule and notified users.

GET

/api/v3/portal/[PORTAL_ID]/module/[MODULE_ID]/export/[EXPORT_ID]

OAuth Scope:

ZohoProjects.portals.READ

Path Parameters

Param Name
Data Type
Description

Query Parameters

Param Name
Data Type
Description

Request Example

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]/module/1752587000000097269/export/1752587000000097269?project_id=1752587000000097269' \
-H 'Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa'

url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269";
params = Map();
params.put("project_id", 1752587000000097269);
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]/module/1752587000000097269/export/1752587000000097269');
url.searchParams.append('project_id', '1752587000000097269');

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]/module/1752587000000097269/export/1752587000000097269")
params = {
  "project_id" => "1752587000000097269"
}
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 = [
    'project_id' => '1752587000000097269',
];
$url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269" . "?" . 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]/module/1752587000000097269/export/1752587000000097269"

params = {
    "project_id": "1752587000000097269"
}

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_project_id = curl_easy_escape(curl, "1752587000000097269", 0);
        char url[2048];
        snprintf(url, sizeof(url), "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269?project_id=%s", enc_project_id);

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

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

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

        curl_free(enc_project_id);
        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}
using System.Net.Http;
using System.Text;
using System.Web;

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

var query = HttpUtility.ParseQueryString(string.Empty);
query["project_id"] = "1752587000000097269";
var uriBuilder = new UriBuilder("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269") { 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_project_id = curl_easy_escape(curl, "1752587000000097269", 0);
        std::string url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269";
        url += "?project_id=" + std::string(enc_project_id);

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

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

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

        curl_free(enc_project_id);
        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}
(require '[clj-http.client :as client])

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

(println (:body response))
package main

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

func main() {
    req, _ := http.NewRequest("GET", "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269", nil)
    q := req.URL.Query()
    q.Add("project_id", "1752587000000097269")
    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]/module/1752587000000097269/export/1752587000000097269?project_id=1752587000000097269 HTTP/1.1
Host: https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269?project_id=1752587000000097269
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]/module/1752587000000097269/export/1752587000000097269");
uriBuilder.addParameter("project_id", "1752587000000097269");
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]/module/1752587000000097269/export/1752587000000097269';

const params = new URLSearchParams({
  'project_id': '1752587000000097269'
});

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));
project_id = 1752587000000097269
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]/module/1752587000000097269/export/1752587000000097269".toHttpUrl().newBuilder()
    urlBuilder.addQueryParameter("project_id", "1752587000000097269")
    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 *encodedProject_id = [@"1752587000000097269" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *urlString = [NSString stringWithFormat:@"https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269?project_id=%@", encodedProject_id];
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_project_id = Uri.pct_encode "1752587000000097269" in
  let uri = Uri.of_string ("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269" ^ "?project_id=" ^ enc_project_id) in
  let headers = Cohttp.Header.init ()
    |> fun h -> Cohttp.Header.add h "Authorization" "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
  in
  Lwt_main.run (
    Client.get ~headers uri >>= fun (_, body) ->
    Cohttp_lwt.Body.to_string body >|= fun s ->
    print_endline s)
$headers = @{
    "Authorization" = "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
}

$params = @{
    project_id = "1752587000000097269"
}
$queryString = ($params.GetEnumerator() | ForEach-Object { "$($_.Key)=$([System.Uri]::EscapeDataString($_.Value))" }) -join "&"
$url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269" + "?" + $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]/module/1752587000000097269/export/1752587000000097269"

params <- list(
  project_id = "1752587000000097269"
)

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]/module/1752587000000097269/export/1752587000000097269")!
components.queryItems = [
    URLQueryItem(name: "project_id", value: "1752587000000097269")
]
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

project_id : 1752587000000097269

Sample Response

200{ "id" : "27000000009001", "file_format" : "xlsx", "status" : "SCHEDULED", "project_type" : "active", "scheduler_status" : "scheduled", "is_file_info_needed" : false, "all_project_items_in_single_sheet" : true, "selected_fields" : [ "name", "status" ], "exported_time" : "2026-02-14T10:10:00.000Z", "filter" : { "pattern" : "1", "criteria" : [ { "field_name" : "status", "condition" : "is", "value" : [ "1752587000000097269" ] } ] }, "view" : { "id" : "27000000006267", "name" : "" }, "schedule_info" : { "id" : "27000000009003", "name" : "Weekly Record Export", "status" : "on", "schedule_datetime" : "2026-02-14T10:10:00.000Z", "repetative_type" : "4", "time_span" : "1", "days_of_week" : [ "1" ], "skip_type" : "1", "ends_after_type" : "0", "executed_count" : "0", "next_schedule_time" : "2026-02-14T10:10:00.000Z" }, "created_by" : { "zuid" : "45524228", "zpuid" : "27000000007031", "name" : "Reece Turner", "first_name" : "Reece", "last_name" : "Reed" }, "notify_users" : [ { "zuid" : "45524228", "zpuid" : "27000000007031", "name" : "Reece Turner", "first_name" : "Reece", "last_name" : "Reed" } ] }

Update Portal Export

Modify a portal-level Custom Module export. Use this API to change the file format, the selected fields, the filter criteria, or the schedule of an existing export.

Every field is replaced by the value sent, so pass the complete configuration rather than only the keys that changed.

PATCH

/api/v3/portal/[PORTAL_ID]/module/[MODULE_ID]/export/[EXPORT_ID]

OAuth Scope:

ZohoProjects.portals.UPDATE

Path Parameters

Param Name
Data Type
Description

Body Parameters

Param Name
Data Type
Description

Request Example

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

curl -X PATCH \
'https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269' \
-H 'Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa' \
-H 'Content-Type: application/json' \
-d '{"file_format":"xlsx","selected_fields":["name","status"],"project_id":1752587000000097269,"filter":{"pattern":"1","criteria":[{"field_name":"status","condition":"is","value":["1752587000000097269"]}]},"schedule_info":{"name":"Weekly Record Export","schedule_datetime":"2026-02-14T10:10:00.000Z","repetative_type":4,"time_span":1,"days_of_week":["1"],"skip_type":1,"mail_to_user":{"zpuid":["27000000007031"]}},"access_code":"SampleAccessCode","scheduler_status":true}'

url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269";
params = Map();
params.put("file_format", "xlsx");
params.put("selected_fields", ["name","status"]);
params.put("project_id", 1752587000000097269);
params.put("filter", {"pattern":"1","criteria":[{"field_name":"status","condition":"is","value":["1752587000000097269"]}]});
params.put("schedule_info", {"name":"Weekly Record Export","schedule_datetime":"2026-02-14T10:10:00.000Z","repetative_type":4,"time_span":1,"days_of_week":["1"],"skip_type":1,"mail_to_user":{"zpuid":["27000000007031"]}});
params.put("access_code", "SampleAccessCode");
params.put("scheduler_status", true);
response = invokeUrl
[
    url: url
    type: PATCH
    parameters: params.toString()
    connection: "projects"
];
info response;
const https = require('https');
const url = new URL('https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269');

const payload = JSON.stringify({"file_format":"xlsx","selected_fields":["name","status"],"project_id":1752587000000097269,"filter":{"pattern":"1","criteria":[{"field_name":"status","condition":"is","value":["1752587000000097269"]}]},"schedule_info":{"name":"Weekly Record Export","schedule_datetime":"2026-02-14T10:10:00.000Z","repetative_type":4,"time_span":1,"days_of_week":["1"],"skip_type":1,"mail_to_user":{"zpuid":["27000000007031"]}},"access_code":"SampleAccessCode","scheduler_status":true});

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

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

req.on('error', (err) => { console.error(err); });
req.write(payload);
req.end();
require 'net/http'
require 'uri'
require 'json'

url = URI("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269")

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 = '{"file_format":"xlsx","selected_fields":["name","status"],"project_id":1752587000000097269,"filter":{"pattern":"1","criteria":[{"field_name":"status","condition":"is","value":["1752587000000097269"]}]},"schedule_info":{"name":"Weekly Record Export","schedule_datetime":"2026-02-14T10:10:00.000Z","repetative_type":4,"time_span":1,"days_of_week":["1"],"skip_type":1,"mail_to_user":{"zpuid":["27000000007031"]}},"access_code":"SampleAccessCode","scheduler_status":true}'

response = http.request(request)
puts response.read_body
<?php
$url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269";

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => $url,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => '{"file_format":"xlsx","selected_fields":["name","status"],"project_id":1752587000000097269,"filter":{"pattern":"1","criteria":[{"field_name":"status","condition":"is","value":["1752587000000097269"]}]},"schedule_info":{"name":"Weekly Record Export","schedule_datetime":"2026-02-14T10:10:00.000Z","repetative_type":4,"time_span":1,"days_of_week":["1"],"skip_type":1,"mail_to_user":{"zpuid":["27000000007031"]}},"access_code":"SampleAccessCode","scheduler_status":true}',
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa",
    "Content-Type: application/json"
  ],
]);

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

echo $response;
import requests

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

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

payload = '{"file_format":"xlsx","selected_fields":["name","status"],"project_id":1752587000000097269,"filter":{"pattern":"1","criteria":[{"field_name":"status","condition":"is","value":["1752587000000097269"]}]},"schedule_info":{"name":"Weekly Record Export","schedule_datetime":"2026-02-14T10:10:00.000Z","repetative_type":4,"time_span":1,"days_of_week":["1"],"skip_type":1,"mail_to_user":{"zpuid":["27000000007031"]}},"access_code":"SampleAccessCode","scheduler_status":true}'

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

print(response.json())
#include <stdio.h>
#include <string.h>
#include <curl/curl.h>

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

        curl_easy_setopt(curl, CURLOPT_URL, "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269");
        curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
        curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "PATCH");
        curl_easy_setopt(curl, CURLOPT_POSTFIELDS, "{\"file_format\":\"xlsx\",\"selected_fields\":[\"name\",\"status\"],\"project_id\":1752587000000097269,\"filter\":{\"pattern\":\"1\",\"criteria\":[{\"field_name\":\"status\",\"condition\":\"is\",\"value\":[\"1752587000000097269\"]}]},\"schedule_info\":{\"name\":\"Weekly Record Export\",\"schedule_datetime\":\"2026-02-14T10:10:00.000Z\",\"repetative_type\":4,\"time_span\":1,\"days_of_week\":[\"1\"],\"skip_type\":1,\"mail_to_user\":{\"zpuid\":[\"27000000007031\"]}},\"access_code\":\"SampleAccessCode\",\"scheduler_status\":true}");

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

        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}
using System.Net.Http;
using System.Text;
using System.Web;

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

var request = new HttpRequestMessage(HttpMethod.Patch, "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269");
request.Content = new StringContent(
    @"{""file_format"":""xlsx"",""selected_fields"":[""name"",""status""],""project_id"":1752587000000097269,""filter"":{""pattern"":""1"",""criteria"":[{""field_name"":""status"",""condition"":""is"",""value"":[""1752587000000097269""]}]},""schedule_info"":{""name"":""Weekly Record Export"",""schedule_datetime"":""2026-02-14T10:10:00.000Z"",""repetative_type"":4,""time_span"":1,""days_of_week"":[""1""],""skip_type"":1,""mail_to_user"":{""zpuid"":[""27000000007031""]}},""access_code"":""SampleAccessCode"",""scheduler_status"":true}",
    Encoding.UTF8,
    "application/json"
);

var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
#include <iostream>
#include <string>
#include <curl/curl.h>

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

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

        curl_easy_setopt(curl, CURLOPT_URL, "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269");
        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, "{\"file_format\":\"xlsx\",\"selected_fields\":[\"name\",\"status\"],\"project_id\":1752587000000097269,\"filter\":{\"pattern\":\"1\",\"criteria\":[{\"field_name\":\"status\",\"condition\":\"is\",\"value\":[\"1752587000000097269\"]}]},\"schedule_info\":{\"name\":\"Weekly Record Export\",\"schedule_datetime\":\"2026-02-14T10:10:00.000Z\",\"repetative_type\":4,\"time_span\":1,\"days_of_week\":[\"1\"],\"skip_type\":1,\"mail_to_user\":{\"zpuid\":[\"27000000007031\"]}},\"access_code\":\"SampleAccessCode\",\"scheduler_status\":true}");

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

        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}
(require '[clj-http.client :as client])

(def response
  (client/patch "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269"
    {:headers {"Authorization" "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
                "Content-Type" "application/json"}
     :body "{\"file_format\":\"xlsx\",\"selected_fields\":[\"name\",\"status\"],\"project_id\":1752587000000097269,\"filter\":{\"pattern\":\"1\",\"criteria\":[{\"field_name\":\"status\",\"condition\":\"is\",\"value\":[\"1752587000000097269\"]}]},\"schedule_info\":{\"name\":\"Weekly Record Export\",\"schedule_datetime\":\"2026-02-14T10:10:00.000Z\",\"repetative_type\":4,\"time_span\":1,\"days_of_week\":[\"1\"],\"skip_type\":1,\"mail_to_user\":{\"zpuid\":[\"27000000007031\"]}},\"access_code\":\"SampleAccessCode\",\"scheduler_status\":true}"
     :as :json}))

(println (:body response))
package main

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

func main() {
    payload := strings.NewReader("{\"file_format\":\"xlsx\",\"selected_fields\":[\"name\",\"status\"],\"project_id\":1752587000000097269,\"filter\":{\"pattern\":\"1\",\"criteria\":[{\"field_name\":\"status\",\"condition\":\"is\",\"value\":[\"1752587000000097269\"]}]},\"schedule_info\":{\"name\":\"Weekly Record Export\",\"schedule_datetime\":\"2026-02-14T10:10:00.000Z\",\"repetative_type\":4,\"time_span\":1,\"days_of_week\":[\"1\"],\"skip_type\":1,\"mail_to_user\":{\"zpuid\":[\"27000000007031\"]}},\"access_code\":\"SampleAccessCode\",\"scheduler_status\":true}")
    req, _ := http.NewRequest("PATCH", "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269", payload)
    req.Header.Add("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa")
    req.Header.Add("Content-Type", "application/json")

    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}
PATCH https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269 HTTP/1.1
Host: https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269
Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa
Content-Type: application/json

{"file_format":"xlsx","selected_fields":["name","status"],"project_id":1752587000000097269,"filter":{"pattern":"1","criteria":[{"field_name":"status","condition":"is","value":["1752587000000097269"]}]},"schedule_info":{"name":"Weekly Record Export","schedule_datetime":"2026-02-14T10:10:00.000Z","repetative_type":4,"time_span":1,"days_of_week":["1"],"skip_type":1,"mail_to_user":{"zpuid":["27000000007031"]}},"access_code":"SampleAccessCode","scheduler_status":true}
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]/module/1752587000000097269/export/1752587000000097269");
HttpUriRequest requestObj = new HttpPatch(uriBuilder.build());
requestObj.addHeader("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");

HttpEntityEnclosingRequestBase requestBase = (HttpEntityEnclosingRequestBase) requestObj;
String requestBody = "{\"file_format\":\"xlsx\",\"selected_fields\":[\"name\",\"status\"],\"project_id\":1752587000000097269,\"filter\":{\"pattern\":\"1\",\"criteria\":[{\"field_name\":\"status\",\"condition\":\"is\",\"value\":[\"1752587000000097269\"]}]},\"schedule_info\":{\"name\":\"Weekly Record Export\",\"schedule_datetime\":\"2026-02-14T10:10:00.000Z\",\"repetative_type\":4,\"time_span\":1,\"days_of_week\":[\"1\"],\"skip_type\":1,\"mail_to_user\":{\"zpuid\":[\"27000000007031\"]}},\"access_code\":\"SampleAccessCode\",\"scheduler_status\":true}";
requestBase.setEntity(new StringEntity(requestBody, HTTP.UTF_8));

HttpResponse response = httpclient.execute(requestObj);

HttpEntity responseEntity = response.getEntity();
Object responseObject = EntityUtils.toString(responseEntity);
String responseString = responseObject.toString();
const url = 'https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269';

const options = {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({"file_format":"xlsx","selected_fields":["name","status"],"project_id":1752587000000097269,"filter":{"pattern":"1","criteria":[{"field_name":"status","condition":"is","value":["1752587000000097269"]}]},"schedule_info":{"name":"Weekly Record Export","schedule_datetime":"2026-02-14T10:10:00.000Z","repetative_type":4,"time_span":1,"days_of_week":["1"],"skip_type":1,"mail_to_user":{"zpuid":["27000000007031"]}},"access_code":"SampleAccessCode","scheduler_status":true})
};

fetch(url, options)
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error(error));
{"file_format":"xlsx","selected_fields":["name","status"],"project_id":1752587000000097269,"filter":{"pattern":"1","criteria":[{"field_name":"status","condition":"is","value":["1752587000000097269"]}]},"schedule_info":{"name":"Weekly Record Export","schedule_datetime":"2026-02-14T10:10:00.000Z","repetative_type":4,"time_span":1,"days_of_week":["1"],"skip_type":1,"mail_to_user":{"zpuid":["27000000007031"]}},"access_code":"SampleAccessCode","scheduler_status":true}
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]/module/1752587000000097269/export/1752587000000097269")
    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("""{"file_format":"xlsx","selected_fields":["name","status"],"project_id":1752587000000097269,"filter":{"pattern":"1","criteria":[{"field_name":"status","condition":"is","value":["1752587000000097269"]}]},"schedule_info":{"name":"Weekly Record Export","schedule_datetime":"2026-02-14T10:10:00.000Z","repetative_type":4,"time_span":1,"days_of_week":["1"],"skip_type":1,"mail_to_user":{"zpuid":["27000000007031"]}},"access_code":"SampleAccessCode","scheduler_status":true}""") }

    val response = conn.inputStream.bufferedReader().readText()
    println(response)
}
NSURL *url = [NSURL URLWithString:@"https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269"];
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 = [@"{\"file_format\":\"xlsx\",\"selected_fields\":[\"name\",\"status\"],\"project_id\":1752587000000097269,\"filter\":{\"pattern\":\"1\",\"criteria\":[{\"field_name\":\"status\",\"condition\":\"is\",\"value\":[\"1752587000000097269\"]}]},\"schedule_info\":{\"name\":\"Weekly Record Export\",\"schedule_datetime\":\"2026-02-14T10:10:00.000Z\",\"repetative_type\":4,\"time_span\":1,\"days_of_week\":[\"1\"],\"skip_type\":1,\"mail_to_user\":{\"zpuid\":[\"27000000007031\"]}},\"access_code\":\"SampleAccessCode\",\"scheduler_status\":true}" dataUsingEncoding:NSUTF8StringEncoding];
[request setHTTPBody:body];

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

let () =
  let uri = Uri.of_string "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269" 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|{"file_format":"xlsx","selected_fields":["name","status"],"project_id":1752587000000097269,"filter":{"pattern":"1","criteria":[{"field_name":"status","condition":"is","value":["1752587000000097269"]}]},"schedule_info":{"name":"Weekly Record Export","schedule_datetime":"2026-02-14T10:10:00.000Z","repetative_type":4,"time_span":1,"days_of_week":["1"],"skip_type":1,"mail_to_user":{"zpuid":["27000000007031"]}},"access_code":"SampleAccessCode","scheduler_status":true}|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 = @'
{"file_format":"xlsx","selected_fields":["name","status"],"project_id":1752587000000097269,"filter":{"pattern":"1","criteria":[{"field_name":"status","condition":"is","value":["1752587000000097269"]}]},"schedule_info":{"name":"Weekly Record Export","schedule_datetime":"2026-02-14T10:10:00.000Z","repetative_type":4,"time_span":1,"days_of_week":["1"],"skip_type":1,"mail_to_user":{"zpuid":["27000000007031"]}},"access_code":"SampleAccessCode","scheduler_status":true}
'@

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

$response | ConvertTo-Json
library(httr)

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

response <- PATCH(
  url,
  add_headers(Authorization = "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"),
  content_type_json(),
  body = "{\"file_format\":\"xlsx\",\"selected_fields\":[\"name\",\"status\"],\"project_id\":1752587000000097269,\"filter\":{\"pattern\":\"1\",\"criteria\":[{\"field_name\":\"status\",\"condition\":\"is\",\"value\":[\"1752587000000097269\"]}]},\"schedule_info\":{\"name\":\"Weekly Record Export\",\"schedule_datetime\":\"2026-02-14T10:10:00.000Z\",\"repetative_type\":4,\"time_span\":1,\"days_of_week\":[\"1\"],\"skip_type\":1,\"mail_to_user\":{\"zpuid\":[\"27000000007031\"]}},\"access_code\":\"SampleAccessCode\",\"scheduler_status\":true}"
)

content(response, "text")
import Foundation

let url = URL(string: "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269")!
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 = """
{"file_format":"xlsx","selected_fields":["name","status"],"project_id":1752587000000097269,"filter":{"pattern":"1","criteria":[{"field_name":"status","condition":"is","value":["1752587000000097269"]}]},"schedule_info":{"name":"Weekly Record Export","schedule_datetime":"2026-02-14T10:10:00.000Z","repetative_type":4,"time_span":1,"days_of_week":["1"],"skip_type":1,"mail_to_user":{"zpuid":["27000000007031"]}},"access_code":"SampleAccessCode","scheduler_status":true}
""".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
{ "file_format" : "xlsx", "selected_fields" : [ "name", "status" ], "project_id" : 1752587000000097269, "filter" : { "pattern" : "1", "criteria" : [ { "field_name" : "status", "condition" : "is", "value" : [ "1752587000000097269" ] } ] }, "schedule_info" : { "name" : "Weekly Record Export", "schedule_datetime" : "2026-02-14T10:10:00.000Z", "repetative_type" : 4, "time_span" : 1, "days_of_week" : [ "1" ], "skip_type" : 1, "mail_to_user" : { "zpuid" : [ "27000000007031" ] } }, "access_code" : "SampleAccessCode", "scheduler_status" : true }

Sample Response

200{ "id" : "27000000009001", "schedule_id" : "27000000009003" }

Update Portal Export Status

Toggle a portal-level Custom Module scheduled export on or off. Switching it off suspends the schedule without deleting the export, so it can be resumed later.

PATCH

/api/v3/portal/[PORTAL_ID]/module/[MODULE_ID]/export/[EXPORT_ID]/status

OAuth Scope:

ZohoProjects.portals.UPDATE

Path Parameters

Param Name
Data Type
Description

Body Parameters

Param Name
Data Type
Description

Request Example

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

curl -X PATCH \
'https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269/status' \
-H 'Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa' \
-H 'Content-Type: application/json' \
-d '{"status":"on"}'

url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269/status";
params = Map();
params.put("status", "on");
response = invokeUrl
[
    url: url
    type: PATCH
    parameters: params.toString()
    connection: "projects"
];
info response;
const https = require('https');
const url = new URL('https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269/status');

const payload = JSON.stringify({"status":"on"});

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

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

req.on('error', (err) => { console.error(err); });
req.write(payload);
req.end();
require 'net/http'
require 'uri'
require 'json'

url = URI("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269/status")

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 = '{"status":"on"}'

response = http.request(request)
puts response.read_body
<?php
$url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269/status";

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => $url,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => '{"status":"on"}',
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa",
    "Content-Type: application/json"
  ],
]);

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

echo $response;
import requests

url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269/status"

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

payload = '{"status":"on"}'

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

print(response.json())
#include <stdio.h>
#include <string.h>
#include <curl/curl.h>

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

        curl_easy_setopt(curl, CURLOPT_URL, "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269/status");
        curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
        curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "PATCH");
        curl_easy_setopt(curl, CURLOPT_POSTFIELDS, "{\"status\":\"on\"}");

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

        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}
using System.Net.Http;
using System.Text;
using System.Web;

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

var request = new HttpRequestMessage(HttpMethod.Patch, "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269/status");
request.Content = new StringContent(
    @"{""status"":""on""}",
    Encoding.UTF8,
    "application/json"
);

var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
#include <iostream>
#include <string>
#include <curl/curl.h>

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

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

        curl_easy_setopt(curl, CURLOPT_URL, "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269/status");
        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, "{\"status\":\"on\"}");

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

        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}
(require '[clj-http.client :as client])

(def response
  (client/patch "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269/status"
    {:headers {"Authorization" "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
                "Content-Type" "application/json"}
     :body "{\"status\":\"on\"}"
     :as :json}))

(println (:body response))
package main

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

func main() {
    payload := strings.NewReader("{\"status\":\"on\"}")
    req, _ := http.NewRequest("PATCH", "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269/status", payload)
    req.Header.Add("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa")
    req.Header.Add("Content-Type", "application/json")

    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}
PATCH https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269/status HTTP/1.1
Host: https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269/status
Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa
Content-Type: application/json

{"status":"on"}
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]/module/1752587000000097269/export/1752587000000097269/status");
HttpUriRequest requestObj = new HttpPatch(uriBuilder.build());
requestObj.addHeader("Authorization", "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa");

HttpEntityEnclosingRequestBase requestBase = (HttpEntityEnclosingRequestBase) requestObj;
String requestBody = "{\"status\":\"on\"}";
requestBase.setEntity(new StringEntity(requestBody, HTTP.UTF_8));

HttpResponse response = httpclient.execute(requestObj);

HttpEntity responseEntity = response.getEntity();
Object responseObject = EntityUtils.toString(responseEntity);
String responseString = responseObject.toString();
const url = 'https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269/status';

const options = {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({"status":"on"})
};

fetch(url, options)
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error(error));
{"status":"on"}
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]/module/1752587000000097269/export/1752587000000097269/status")
    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("""{"status":"on"}""") }

    val response = conn.inputStream.bufferedReader().readText()
    println(response)
}
NSURL *url = [NSURL URLWithString:@"https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269/status"];
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 = [@"{\"status\":\"on\"}" dataUsingEncoding:NSUTF8StringEncoding];
[request setHTTPBody:body];

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

let () =
  let uri = Uri.of_string "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269/status" 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|{"status":"on"}|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 = @'
{"status":"on"}
'@

$response = Invoke-RestMethod -Uri "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269/status" -Method PATCH -Headers $headers -Body $body

$response | ConvertTo-Json
library(httr)

url <- "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269/status"

response <- PATCH(
  url,
  add_headers(Authorization = "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"),
  content_type_json(),
  body = "{\"status\":\"on\"}"
)

content(response, "text")
import Foundation

let url = URL(string: "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269/status")!
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 = """
{"status":"on"}
""".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
{ "status" : "on" }

Sample Response

200{ "id" : "27000000009001", "status" : "on" }

Delete Portal Export

Remove a portal-level Custom Module export. Deleting a scheduled export also cancels its remaining runs.

DELETE

/api/v3/portal/[PORTAL_ID]/module/[MODULE_ID]/export/[EXPORT_ID]

OAuth Scope:

ZohoProjects.portals.DELETE

Path Parameters

Param Name
Data Type
Description

Query Parameters

Param Name
Data Type
Description

Request Example

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]/module/1752587000000097269/export/1752587000000097269?project_id=1752587000000097269' \
-H 'Authorization: Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa'

url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269";
params = Map();
params.put("project_id", 1752587000000097269);
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]/module/1752587000000097269/export/1752587000000097269');
url.searchParams.append('project_id', '1752587000000097269');

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]/module/1752587000000097269/export/1752587000000097269")
params = {
  "project_id" => "1752587000000097269"
}
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 = [
    'project_id' => '1752587000000097269',
];
$url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269" . "?" . 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]/module/1752587000000097269/export/1752587000000097269"

params = {
    "project_id": "1752587000000097269"
}

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_project_id = curl_easy_escape(curl, "1752587000000097269", 0);
        char url[2048];
        snprintf(url, sizeof(url), "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269?project_id=%s", enc_project_id);

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

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

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

        curl_free(enc_project_id);
        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}
using System.Net.Http;
using System.Text;
using System.Web;

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

var query = HttpUtility.ParseQueryString(string.Empty);
query["project_id"] = "1752587000000097269";
var uriBuilder = new UriBuilder("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269") { 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_project_id = curl_easy_escape(curl, "1752587000000097269", 0);
        std::string url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269";
        url += "?project_id=" + std::string(enc_project_id);

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

        curl_easy_setopt(curl, CURLOPT_URL, url.c_str());
        curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
        curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "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_project_id);
        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
    }
    return 0;
}
(require '[clj-http.client :as client])

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

const params = new URLSearchParams({
  'project_id': '1752587000000097269'
});

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));
project_id = 1752587000000097269
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]/module/1752587000000097269/export/1752587000000097269".toHttpUrl().newBuilder()
    urlBuilder.addQueryParameter("project_id", "1752587000000097269")
    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 *encodedProject_id = [@"1752587000000097269" stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];
NSString *urlString = [NSString stringWithFormat:@"https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269?project_id=%@", encodedProject_id];
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_project_id = Uri.pct_encode "1752587000000097269" in
  let uri = Uri.of_string ("https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269" ^ "?project_id=" ^ enc_project_id) in
  let headers = Cohttp.Header.init ()
    |> fun h -> Cohttp.Header.add h "Authorization" "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
  in
  Lwt_main.run (
    Client.delete ~headers uri >>= fun (_, body) ->
    Cohttp_lwt.Body.to_string body >|= fun s ->
    print_endline s)
$headers = @{
    "Authorization" = "Bearer 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"
}

$params = @{
    project_id = "1752587000000097269"
}
$queryString = ($params.GetEnumerator() | ForEach-Object { "$($_.Key)=$([System.Uri]::EscapeDataString($_.Value))" }) -join "&"
$url = "https://projects.zoho.com/api/v3/portal/[PORTAL_ID]/module/1752587000000097269/export/1752587000000097269" + "?" + $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]/module/1752587000000097269/export/1752587000000097269"

params <- list(
  project_id = "1752587000000097269"
)

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]/module/1752587000000097269/export/1752587000000097269")!
components.queryItems = [
    URLQueryItem(name: "project_id", value: "1752587000000097269")
]
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

project_id : 1752587000000097269

Sample Response

204 No Content
AI Tools
ChatGPT Open in ChatGPT ↗ Open in ChatGPT to ask questions about this page
Claude Open in Claude ↗ Open in Claude to ask questions about this page
Copy as Markdown Copy this page as markdown to use with AI assistants
View as Markdown ↗ Open this page as markdown in a new tab
Copy OpenAPI Spec Copy the OpenAPI YAML to the clipboard
View as YAML ↗ Open the OpenAPI spec in a new tab
Download YAML Save the OpenAPI spec as a .yaml file