Publish API

Publish and manage presentation visibility. Publish presentations within the organization or to the public web, configure player settings, and monitor publication status.

Data Center:

⬇ Download OpenAPI Spec

GET Get Published Document

GET https://show.zoho.com/api/v1/presentation/{rid}/publish

Required Scopes:

ZohoShow.showdocslist.READ

Returns the published metadata for a provided presentation id.

Path parameters

Name	Type	Required	Description
rid	string	Required	Resource id of the presentation. The caller must have the appropriate permission on this presentation.

Query parameters

Name	Type	Required	Description
fields	string	Optional	Comma-separated response fields to include.

Samples

Responses

200 Published Document Retrieved

404 Document Not Published

401 Missing OAuth Token

400 Invalid Resource ID

405 Invalid Method

{
  "data": {
    "document_info": {
      "file_path": "iy2x3cb54b1c9e95d46839c92d735d56fdc2d",
      "last_applied_version": "3",
      "document_name_url": "",
      "formatted_created_date": "Tue 03/31/26",
      "version_number": 0,
      "type": "1",
      "document_id": "106689000002283003",
      "is_new_publish": false,
      "last_author_name": "93600994",
      "encrypted_description": "",
      "status_change_time": "1779883473976",
      "fromsync": "",
      "state": "1",
      "created_time": "1774937762562",
      "extra_prop": {
        "is_spam": "0",
        "img_conv_status": "2",
        "retry_count": "0",
        "collab_id": "1828996484438803238"
      },
      "resource_type": "2201",
      "last_opened_time": "1774937762562",
      "child_index": "0",
      "parent_id": "iy2x3cb54b1c9e95d46839c92d735d56fdc2d",
      "name": "Untitled Presentation",
      "zs_creator": "93703623",
      "deleted_time": "-1",
      "favorite": "0",
      "status": "1",
      "author_name": "93601174",
      "extension": "zslides",
      "encrypted_document_name_url": "Untitled Presentation",
      "formatted_last_modified_time": "19 hours ago",
      "description": "",
      "document_name": "",
      "last_downloaded_version_id": "0",
      "modified_time": "-1",
      "document_status": "1",
      "encrypted_document_name": "Untitled Presentation",
      "scope": "0",
      "last_author_display_name": "Sample User",
      "author_display_name": "",
      "base_parent_id": "iy2x3cb54b1c9e95d46839c92d735d56fdc2d",
      "document_type": "2",
      "owner": "93601174",
      "creator": "93703623",
      "last_modified_time": "1779883473957",
      "perma_link": "https://show.zoho.com/file/7fgg637ac6060b3f24b368cafcbd2652f292c",
      "migration_status": "1",
      "version_id": "106689000002347011",
      "file_size": "14331",
      "download_count": "0",
      "uploaded_time": "1774937762562",
      "service_type": "3",
      "unique_key_id": "106689000002283001",
      "theme_name": "8114000000832732",
      "modified_by": "93600994",
      "is_public": true,
      "resource_id": "7fgg637ac6060b3f24b368cafcbd2652f292c",
      "created_date": "1774937762562",
      "space_id": "93601174"
    }
  },
  "message": "Published document retrieved",
  "request_uri": "/api/v1/presentation/7fgg637ac6060b3f24b368cafcbd2652f292c/publish",
  "status": "success"
}

Code Examples

cURL

curl -X GET "https://show.zoho.com/api/v1/presentation/{rid}/publish?fields=publish_url,publish_type,published_time" \
  -H "Authorization: Zoho-oauthtoken YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json"

JavaScript

const response = await fetch('https://show.zoho.com/api/v1/presentation/{rid}/publish?fields=publish_url,publish_type,published_time', {
  method: 'GET',
  headers: {
    'Authorization': 'Zoho-oauthtoken YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
// Process the response data
return data;

Node.js

const https = require('https');
const url = require('url');

const options = {
  ...url.parse('https://show.zoho.com/api/v1/presentation/{rid}/publish?fields=publish_url,publish_type,published_time'),
  method: 'GET',
  headers: {
    'Authorization': 'Zoho-oauthtoken YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  }
};

const req = https.request(options, (res) => {
  let data = '';
  res.on('data', (chunk) => data += chunk);
  res.on('end', () => {
    const result = JSON.parse(data);
    // Process the response data
  });
});

req.end();

Python

import requests

url = "https://show.zoho.com/api/v1/presentation/{rid}/publish?fields=publish_url,publish_type,published_time"
headers = {
    "Authorization": "Zoho-oauthtoken YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json"
}

response = requests.get(url, headers=headers)
data = response.json()
print(data)

Java

import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import java.time.Duration;

public class ApiClient {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newBuilder()
            .connectTimeout(Duration.ofSeconds(10))
            .build();

        HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
            .uri(URI.create("https://show.zoho.com/api/v1/presentation/{rid}/publish?fields=publish_url,publish_type,published_time"))
            .header("Authorization", "Zoho-oauthtoken YOUR_ACCESS_TOKEN")
            .timeout(Duration.ofSeconds(30));

            .header("Content-Type", "application/json")
        HttpRequest request = requestBuilder
            .GET(HttpRequest.BodyPublishers.noBody())
            .build();

        HttpResponse<String> response = client.send(request,
            HttpResponse.BodyHandlers.ofString());

        System.out.println(response.body());
    }
}

Deluge

info "Making API request to: https://show.zoho.com/api/v1/presentation/{rid}/publish?fields=publish_url,publish_type,published_time";

headers = Map();
headers.put("Authorization", "Zoho-oauthtoken YOUR_ACCESS_TOKEN");
headers.put("Content-Type", "application/json");

response = invokeurl
[
    url: "https://show.zoho.com/api/v1/presentation/{rid}/publish?fields=publish_url,publish_type,published_time"
    type: GET
    headers: headers
];

if (response.get("status_code") == 200) {
    info "Request successful";
    responseData = response.get("response");
    info responseData;
} else {
    info "Request failed with status: " + response.get("status_code");
    info response.get("response");
}

POST Publish Presentation

POST https://show.zoho.com/api/v1/presentation/{rid}/publish

Required Scopes:

ZohoShow.showdocslist.CREATE

Publishes a presentation to the org or to the public web. The two targets are independent and can be toggled separately. Set type to ORG_PUBLISH (publish within the org) or EXTERNAL_WORLD (publish to the public web).

Path parameters

Name	Type	Required	Description
rid	string	Required	Resource id of the presentation. The caller must have the appropriate permission on this presentation.

Samples

Request Body

JSON

{
  "type": "ORG_PUBLISH"
}

Responses

200 Published to organization

200 Published to the public web

500 Already Published Document

401 Missing OAuth Token

400 Invalid Resource ID

{
  "data": {
    "published_type": "internalPublish"
  },
  "message": "Presentation published",
  "request_uri": "/api/v1/presentation/cpnv3d0203ec89cba4207ba255d785dfe125c/publish",
  "status": "success"
}

Code Examples

cURL

curl -X POST "https://show.zoho.com/api/v1/presentation/{rid}/publish" \
  -H "Authorization: Zoho-oauthtoken YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "ORG_PUBLISH"
}'

JavaScript

const response = await fetch('https://show.zoho.com/api/v1/presentation/{rid}/publish', {
  method: 'POST',
  headers: {
    'Authorization': 'Zoho-oauthtoken YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "type": "ORG_PUBLISH"
})
});

const data = await response.json();
// Process the response data
return data;

Node.js

const https = require('https');
const url = require('url');

const options = {
  ...url.parse('https://show.zoho.com/api/v1/presentation/{rid}/publish'),
  method: 'POST',
  headers: {
    'Authorization': 'Zoho-oauthtoken YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  }
};

const req = https.request(options, (res) => {
  let data = '';
  res.on('data', (chunk) => data += chunk);
  res.on('end', () => {
    const result = JSON.parse(data);
    // Process the response data
  });
});

req.write(JSON.stringify({
  "type": "ORG_PUBLISH"
}));
req.end();

Python

import requests

url = "https://show.zoho.com/api/v1/presentation/{rid}/publish"
headers = {
    "Authorization": "Zoho-oauthtoken YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json"
}

data = {
  "type": "ORG_PUBLISH"
}

response = requests.post(url, headers=headers, json=data)
data = response.json()
print(data)

Java

import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import java.time.Duration;

public class ApiClient {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newBuilder()
            .connectTimeout(Duration.ofSeconds(10))
            .build();

        HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
            .uri(URI.create("https://show.zoho.com/api/v1/presentation/{rid}/publish"))
            .header("Authorization", "Zoho-oauthtoken YOUR_ACCESS_TOKEN")
            .timeout(Duration.ofSeconds(30));

            .header("Content-Type", "application/json")
        String requestBody = "{\"type\":\"ORG_PUBLISH\"}";
        HttpRequest request = requestBuilder
            .POST(HttpRequest.BodyPublishers.ofString(requestBody))
            .build();

        HttpResponse<String> response = client.send(request,
            HttpResponse.BodyHandlers.ofString());

        System.out.println(response.body());
    }
}

Deluge

info "Making API request to: https://show.zoho.com/api/v1/presentation/{rid}/publish";

headers = Map();
headers.put("Authorization", "Zoho-oauthtoken YOUR_ACCESS_TOKEN");
headers.put("Content-Type", "application/json");

requestData = {"type": "ORG_PUBLISH"};

response = invokeurl
[
    url: "https://show.zoho.com/api/v1/presentation/{rid}/publish"
    type: POST
    headers: headers
    parameters: requestData
];

if (response.get("status_code") == 200) {
    info "Request successful";
    responseData = response.get("response");
    info responseData;
} else {
    info "Request failed with status: " + response.get("status_code");
    info response.get("response");
}

PUT Update Publish Settings

PUT https://show.zoho.com/api/v1/presentation/{rid}/publish

Required Scopes:

ZohoShow.showdocslist.UPDATE

Updates player settings on a published presentation without triggering a republish. Settings include colors, download options, sharing permissions, view type, and publish target type. Supported viewtype values are 1 through 12 (1 = default/classic, 2 = bold, 3 = polygon, 4 = tiles, 5 = screen, 6 = horizontal swipe, 7 = vertical swipe, 8 = horizontal scroll, 9 = vertical scroll, 10 = carousel, 11 = additional layout, 12 = full screen on paid plans). update_public_type supports 1 = organization publish and 2 = external/public publish.

Path parameters

Name	Type	Required	Description
rid	string	Required	Resource id of the presentation. The caller must have the appropriate permission on this presentation.

Samples

Request Body

JSON

{
  "republish": false,
  "auto_republish": false,
  "allow_share": true,
  "allow_download": true,
  "allow_translate": false,
  "update_show_explainer": true,
  "update_show_logo": true,
  "update_user_pic": true,
  "loop_show": false,
  "bg_color": "#ffffff",
  "viewtype": 1,
  "update_public_type": 1
}

Responses

200 Publish Settings Updated

500 Unpublished Document

410 Presentation already in trash

401 Missing OAuth Token

400 Invalid Resource ID

{
  "data": {
    "resource_id": "cpnv3d0203ec89cba4207ba255d785dfe125c",
    "updated_fields": {
      "allow_download": true,
      "update_show_explainer": true,
      "bg_color": "#ffffff",
      "allow_share": true,
      "update_show_logo": true,
      "update_public_type": 1,
      "republish": true,
      "allow_translate": false,
      "viewtype": 1,
      "update_user_pic": true,
      "loop_show": false
    },
    "status": "success"
  },
  "message": "Published document meta updated",
  "request_uri": "/api/v1/presentation/cpnv3d0203ec89cba4207ba255d785dfe125c/publish",
  "status": "success"
}

Code Examples

cURL

curl -X PUT "https://show.zoho.com/api/v1/presentation/{rid}/publish" \
  -H "Authorization: Zoho-oauthtoken YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "republish": false,
  "auto_republish": false,
  "allow_share": true,
  "allow_download": true,
  "allow_translate": false,
  "update_show_explainer": true,
  "update_show_logo": true,
  "update_user_pic": true,
  "loop_show": false,
  "bg_color": "#ffffff",
  "viewtype": 1,
  "update_public_type": 1
}'

JavaScript

const response = await fetch('https://show.zoho.com/api/v1/presentation/{rid}/publish', {
  method: 'PUT',
  headers: {
    'Authorization': 'Zoho-oauthtoken YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "republish": false,
  "auto_republish": false,
  "allow_share": true,
  "allow_download": true,
  "allow_translate": false,
  "update_show_explainer": true,
  "update_show_logo": true,
  "update_user_pic": true,
  "loop_show": false,
  "bg_color": "#ffffff",
  "viewtype": 1,
  "update_public_type": 1
})
});

const data = await response.json();
// Process the response data
return data;

Node.js

const https = require('https');
const url = require('url');

const options = {
  ...url.parse('https://show.zoho.com/api/v1/presentation/{rid}/publish'),
  method: 'PUT',
  headers: {
    'Authorization': 'Zoho-oauthtoken YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  }
};

const req = https.request(options, (res) => {
  let data = '';
  res.on('data', (chunk) => data += chunk);
  res.on('end', () => {
    const result = JSON.parse(data);
    // Process the response data
  });
});

req.write(JSON.stringify({
  "republish": false,
  "auto_republish": false,
  "allow_share": true,
  "allow_download": true,
  "allow_translate": false,
  "update_show_explainer": true,
  "update_show_logo": true,
  "update_user_pic": true,
  "loop_show": false,
  "bg_color": "#ffffff",
  "viewtype": 1,
  "update_public_type": 1
}));
req.end();

Python

import requests

url = "https://show.zoho.com/api/v1/presentation/{rid}/publish"
headers = {
    "Authorization": "Zoho-oauthtoken YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json"
}

data = {
  "republish": false,
  "auto_republish": false,
  "allow_share": true,
  "allow_download": true,
  "allow_translate": false,
  "update_show_explainer": true,
  "update_show_logo": true,
  "update_user_pic": true,
  "loop_show": false,
  "bg_color": "#ffffff",
  "viewtype": 1,
  "update_public_type": 1
}

response = requests.put(url, headers=headers, json=data)
data = response.json()
print(data)

Java

import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import java.time.Duration;

public class ApiClient {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newBuilder()
            .connectTimeout(Duration.ofSeconds(10))
            .build();

        HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
            .uri(URI.create("https://show.zoho.com/api/v1/presentation/{rid}/publish"))
            .header("Authorization", "Zoho-oauthtoken YOUR_ACCESS_TOKEN")
            .timeout(Duration.ofSeconds(30));

            .header("Content-Type", "application/json")
        String requestBody = "{\"republish\":false,\"auto_republish\":false,\"allow_share\":true,\"allow_download\":true,\"allow_translate\":false,\"update_show_explainer\":true,\"update_show_logo\":true,\"update_user_pic\":true,\"loop_show\":false,\"bg_color\":\"#ffffff\",\"viewtype\":1,\"update_public_type\":1}";
        HttpRequest request = requestBuilder
            .PUT(HttpRequest.BodyPublishers.ofString(requestBody))
            .build();

        HttpResponse<String> response = client.send(request,
            HttpResponse.BodyHandlers.ofString());

        System.out.println(response.body());
    }
}

Deluge

info "Making API request to: https://show.zoho.com/api/v1/presentation/{rid}/publish";

headers = Map();
headers.put("Authorization", "Zoho-oauthtoken YOUR_ACCESS_TOKEN");
headers.put("Content-Type", "application/json");

requestData = {"republish": false, "auto_republish": false, "allow_share": true, "allow_download": true, "allow_translate": false, "update_show_explainer": true, "update_show_logo": true, "update_user_pic": true, "loop_show": false, "bg_color": "#ffffff", "viewtype": 1, "update_public_type": 1};

response = invokeurl
[
    url: "https://show.zoho.com/api/v1/presentation/{rid}/publish"
    type: PUT
    headers: headers
    parameters: requestData
];

if (response.get("status_code") == 200) {
    info "Request successful";
    responseData = response.get("response");
    info responseData;
} else {
    info "Request failed with status: " + response.get("status_code");
    info response.get("response");
}

DELETE Unpublish Presentation

DELETE https://show.zoho.com/api/v1/presentation/{rid}/publish

Required Scopes:

ZohoShow.showdocslist.DELETE

Removes a presentation from either org-publish or external-publish states, taking it off the web. Set type to ORG_PUBLISH or EXTERNAL_WORLD to match the state being removed.

Path parameters

Name	Type	Required	Description
rid	string	Required	Resource id of the presentation. The caller must have the appropriate permission on this presentation.

Samples

Request Body

JSON

{
  "type": "ORG_PUBLISH"
}

Responses

200 Presentation Unpublished

410 Presentation already in trash

401 Missing OAuth Token

400 Invalid Resource ID

404 Document Not Published

{
  "message": "Presentation unpublished",
  "request_uri": "/api/v1/presentation/cpnv3d0203ec89cba4207ba255d785dfe125c/publish",
  "status": "success"
}

Code Examples

cURL

curl -X DELETE "https://show.zoho.com/api/v1/presentation/{rid}/publish" \
  -H "Authorization: Zoho-oauthtoken YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "ORG_PUBLISH"
}'

JavaScript

const response = await fetch('https://show.zoho.com/api/v1/presentation/{rid}/publish', {
  method: 'DELETE',
  headers: {
    'Authorization': 'Zoho-oauthtoken YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "type": "ORG_PUBLISH"
})
});

const data = await response.json();
// Process the response data
return data;

Node.js

const https = require('https');
const url = require('url');

const options = {
  ...url.parse('https://show.zoho.com/api/v1/presentation/{rid}/publish'),
  method: 'DELETE',
  headers: {
    'Authorization': 'Zoho-oauthtoken YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  }
};

const req = https.request(options, (res) => {
  let data = '';
  res.on('data', (chunk) => data += chunk);
  res.on('end', () => {
    const result = JSON.parse(data);
    // Process the response data
  });
});

req.write(JSON.stringify({
  "type": "ORG_PUBLISH"
}));
req.end();

Python

import requests

url = "https://show.zoho.com/api/v1/presentation/{rid}/publish"
headers = {
    "Authorization": "Zoho-oauthtoken YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json"
}

data = {
  "type": "ORG_PUBLISH"
}

response = requests.delete(url, headers=headers, json=data)
data = response.json()
print(data)

Java

import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import java.time.Duration;

public class ApiClient {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newBuilder()
            .connectTimeout(Duration.ofSeconds(10))
            .build();

        HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
            .uri(URI.create("https://show.zoho.com/api/v1/presentation/{rid}/publish"))
            .header("Authorization", "Zoho-oauthtoken YOUR_ACCESS_TOKEN")
            .timeout(Duration.ofSeconds(30));

            .header("Content-Type", "application/json")
        String requestBody = "{\"type\":\"ORG_PUBLISH\"}";
        HttpRequest request = requestBuilder
            .DELETE(HttpRequest.BodyPublishers.ofString(requestBody))
            .build();

        HttpResponse<String> response = client.send(request,
            HttpResponse.BodyHandlers.ofString());

        System.out.println(response.body());
    }
}

Deluge

info "Making API request to: https://show.zoho.com/api/v1/presentation/{rid}/publish";

headers = Map();
headers.put("Authorization", "Zoho-oauthtoken YOUR_ACCESS_TOKEN");
headers.put("Content-Type", "application/json");

requestData = {"type": "ORG_PUBLISH"};

response = invokeurl
[
    url: "https://show.zoho.com/api/v1/presentation/{rid}/publish"
    type: DELETE
    headers: headers
    parameters: requestData
];

if (response.get("status_code") == 200) {
    info "Request successful";
    responseData = response.get("response");
    info responseData;
} else {
    info "Request failed with status: " + response.get("status_code");
    info response.get("response");
}