Co-edit Spreadsheet | Zoho Sheet

Co-editing Spreadsheet

Purpose

To co-edit or real-time collaborate on a spreadsheet in Zoho Sheet editor.

HTTP Request URL

https://sheet.zoho.com/sheet/remotedoc.im

Request Parameters

Parameter	Data Type	Description
Mandatory Parameters
apikey	String	Uniquely identifies the web application in which the Sheet editor is integrated.
content or url	File or String	Method of providing the input file depending on its location. content - if the input file is from your local drive or desktop. url - if the input file is from a publicly accessible Web URL.
mode	String	Defines the access privilege of the user while opening the spreadsheet in Sheet editor. collabedit - spreadsheet opens in real-time collaborative edit mode. Multiple users can edit the spreadsheet as well as add notes/comments at the same time.
format	String	Defines the format in which the spreadsheet needs to be saved back to the partner's storage server. Supported file formats: .xlsx .xls .ods .sxc .csv .tsv Max. file size: 10MB
saveurl	String	Defines partner's storage server location. The saveurl is a publicly accessible web URL/Service, to which Zoho will push the updated spreadsheet content from Sheet editor to the partner's server.
documentid	Integer	Unique id for spreadsheet identification. In the case of user failing to provide a documentid, Sheet will generate one automatically in the form of an encrypted string.
Optional Parameters
username	String	Identifies the name of the user opening a spreadsheet in collaboration mode. Default value: Guest
delimiter	Char	Enables user to add custom delimiters to CSV & TSV file formats (e.g. delimiter=;) Possible values: '\|' , ';' , '^' , '~' , ' , ' , '\t'
lang	String	Enables the Sheet editor interface to open in different languages. Default value: en (English)

Note:

To view a particular spreadsheet in collaboration mode, users need to specify the "mode" parameter value as "collabview" in the HTTPS POST request.

Co-editing Spreadsheet - Error Codes

Code	Description
2831	Mandatory parameter(s) missing.
2890	Invalid API key
2891	The specific URL request is incorrect.

For a full list of error handling cases in Co-editing Spreadsheet, refer here.

Sample Request:

Copiedcurl --request POST \
  --url 'https://sheet.zoho.com/sheet/remotedoc.im?apikey=1ee6127ff93882de82599eacc2668023' \
  --header 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
  --form content=@/Users/username/Spreadsheets/Sample.xlsx \
  --form mode=collabedit \
  --form username=Mark \
  --form format=xlsx \
  --form lang=en

Sample Response:

CopiedRESULT=TRUE
URL=https://sheet.zoho.com/sheet/editor.do?
doc=d55ce7a40befa74f501a88646e84769d8370b12883da6d9c9539af282a869ede6f75603ca2c557c013ad9f9b1f992cbdd233e36e3b19a7b655e352d0a8e6f27b&lang=en