Edit Presentation

Purpose

To edit a presentation in Zoho Show. Users can upload an existing presentation from either their local drive or a publicly accessible Web URL and edit it online in Zoho Show.

HTTP Request URL

https://show.zoho.com/show/officeapi/v1/presentation

Request Parameters

Parameter	Value	Description
Mandatory Parameter
apikey	423s*****	Uniquely identifies the web application in which the Show editor is integrated.
document or url	File or String	Method of providing the input file depending on its location. document - if the input file is from your local drive or desktop. url - if the input file is from a publicly accessible Web URL.
callback_settings	{ "save_format":"pptx", "save_url":"https://domain.com/save.php", "context_info":"additional doc or user info" }	Set document save format, provide storage server location in save_url, and additional doc or user info.
Optional Parameters - Editor Customization
editor_settings	{ "language":"en" }	Set Editor preferences like interface language for new presentations.
permissions	{ "document.export":true, "document.print":true, "document.edit":true }	Define presentation permissions for user. Option to allow or revoke presentation "Export", "Print" and "Edit" access.
document_info	{ "document_name":"New", "document_id":"1349" }	Set a unique id and specify display name of the new presentation.
user_info	{ "user_id":"9173", "display_name":"Ken" }	Identify a user in the presentation with "user_id" and "display_name".

Note:

Editor customization parameters and their values are case-sensitive.

Editor Customization Parameters

editor_settings

Parameter	Type	Possible Values	Default Value
language	string	en / de / es / fr / ja / nl more...	en

permissions

Parameter	Type	Possible Values	Default Value
document.export	boolean	true / false	true
document.print	boolean	true / false	true
document.edit	boolean	true / false	false

callback_settings

Parameter	Type	Possible Values	Default Value
save_format	string	pptx / ppsx / odp / pdf	pptx
save_url	string	https://zylker.com/save.php
context_info	string	Details here

document_info

Parameter	Type	Possible Values	Default Value
document_id	string	24eru24960v
document_name	string	My_Presentation	Untitled

user_info

Parameter	Type	Possible Values	Default Value
user_id	integer	03588563264
display_name	string	Ken/James/Adam	Guest

Edit Presentation - Error Codes

Code	Description
3832	Error occurred. Parameter value is either incorrect or invalid.
3890	Invalid API key
3908	Invalid JSON.

For a full list of error handling cases in Edit Presentation, refer here.

save_url param usage:

Zoho Office Integrator allows partners and businesses to save the presentation content back to their specified storage server through "save_url" method.

A save_url is a publicly accessible Webhook or a Web URL to which Zoho will push the updated presentation content from Show editor to the partner's server.

In order to use the save_url method, partners should fulfill the below requirements:

Partner's remote servers need to expose one of their ports - port 443 (HTTPS) or port 80 (HTTP) - from their location, for Zoho Show to push the data back.
The save_url value specified in the HTTPS/HTTP POST request should be a proper domain name and publicly accessible over the web. Example: https://zykler.com/save.php

context_info parameter usage:

To store presentation-related information, Zoho provides partners with a specific parameter called "context_info".

The 'context_info' parameter can be used by partners to pass additional information on the presentation when sending the HTTPS POST request to Zoho.

The information provided in the 'context_info' parameter will be returned by Zoho to the partner's document repository every time a 'Save' is invoked from the Zoho Office editors. A few possible use-cases are:

Get to know who has saved the presentation in collaboration mode.
Assign shared user information as 'JSON/XML' string in the 'context_info' parameter value. Zoho will return the details of which user has saved the presentation in collaboration mode.
Any information pertaining to the partner's web application. This may include file type, file id, folder id where the presentation needs to be saved, etc.

Sample Request

Copiedcurl -X POST \
  https://show.zoho.com/show/officeapi/v1/presentation \
  -H 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
  -F apikey=423s***** \
  -F 'editor_settings={'\''language'\'':'\''en'\''}' \
  -F 'permissions={'\''document.export'\'':true,'\''document.print'\'':true,'\''document.edit'\'':true}' \
  -F 'callback_settings={'\''save_format'\'':'\''pptx'\'','\''context_info'\'':'\''doc or user info'\'','\''save_url'\'':'\''https://domain.com/save.php/'\''}' \
  -F 'document_info={'\''document_name'\'':'\''New'\'', '\''document_id'\'':1349}' \
  -F 'user_info={'\''user_id'\'':'\''9173'\'','\''display_name'\'':'\''Ken'\''}'

Sample Response

Copied{ 
"document_url": "https://show.zoho.com/show/officeapi/presentation/d26aa7b8029bf4f8d34c7dd0013939234a6e15dac88646f02a69582375b8da130efffac249d086aae4667dcbcfb7ac1d/open",
"document_id": "1349", 
"save_url": "https://show.zoho.com/show/officeapi/presentation/d26aa7b8029bf4f8d34c7dd0013939234a6e15dac88646f02a69582375b8da130efffac249d086aae4667dcbcfb7ac1d/save", 
"session_id": "d26aa7b8029bf4f8d34c7dd0013939234a6e15dac88646f02a69582375b8da130efffac249d086aae4667dcbcfb7ac1d", 
"session_delete_url": "https://show.zoho.com/show/officeapi/v1/session/d26aa7b8029bf4f8d34c7dd0013939234a6e15dac88646f02a69582375b8da130efffac249d086aae4667dcbcfb7ac1d", 
"document_delete_url": "https://show.zoho.com/show/officeapi/v1/presentation/1349",
 }