Creator API

REST API - Share Forms and Views

URL

https://creator.zoho.com/api/<format>/<applicationName>/<formName>/share/

https://creator.zoho.com/api/<format>/<applicationName>/<viewName>/share/

https://creator.zoho.com/api/<format>/<applicationName>/<formName>/cancelshare/

https://creator.zoho.com/api/<format>/<applicationName>/<viewName>/cancelshare/

where <applicationName>, <formName> and <viewName> are the link names of your application, form and view as can be referred to here
and <format> is the type of response format as listed below.

Formats

xml, json

HTTP Method

POST

Parameters

Parameter Name Usage Description
authtoken Required. A valid API authtoken. Referhttps://api.creator.zoho.com/Generate-Auth-Token.htmlfor generating authtoken.
scope Required Specify the value as creatorapi
mailids Required. The email IDs to share/unshare, separated by commas. For example: user1@website.com,user2@website.com

Prerequisites

Notes

  • Only the owner of the application can set sharing.

Sample Request

<form method="POST" action="" target="_blank">https://creator.zoho.com/api/xml/sample/Employee/share/">
<input type="hidden" name ="authtoken" value="************">
<input type="hidden" name ="scope" id="scope" value="creatorapi">
<input type="text" name ="mailids" value="user1@website.com,user2@website.com">
<input type="submit" value="Share Form">
</form>

Sample Response

XML response

<?xml version="1.0" encoding="UTF-8" ?>
response>
<share operation="add">
<application name="sample">
<form name="Employee"/>
<mailids>
<mailid>user1@website.com</mailid>
<mailid>user2@website.com</mailid>
</mailids>
<status>Success</status>
</application>
</share>
</response>

JSON response

{"response":[{"application":[{"name":"sample"},{"form":[{"name":"Employee"}]}],
"share":[{"operation":"add"}],"status":"Success","mailids":"[user1@website.com]"}]}

Error Codes

If there is an error in the request format, the corresponding error code with error message will be displayed. Please refer to the topic Error codes and descriptions for the list of error codes. If the operation is successful, the response message will be displayed with status as "Success".

Top