REST API - Share Application

URL

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

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

Formats

xml, json

HTTP Method

POST

Parameters

Parameter NameUsageDescription
authtokenRequired.A valid API authtoken. Refer https://api.creator.zoho.com/Generate-Auth-Token.html for authtoken.
scopeRequiredSpecify the value as creatorapi
applinknameRequired.

The link name of your application, as can be referred to here

mailids/usernamesRequired.The email IDs/usernames to share/unshare to, separated by commas. For example: user1,user2

Prerequisites

Notes

  • Only the owner of the application can set sharing.

Sample Request

<form method="POST" action="https://creator.zoho.com/api/xml/share/">
<input type="hidden" name ="authtoken" value="************">
<input type="hidden" name ="scope" id="scope" value="creatorapi">
<input type="text" name ="applinkname" value="Employee">
<input type="text" name ="usernames" value="user1,user2">
<input type="submit" value="Share Application">
</form>

Sample Response

XML response

<?xml version="1.0" encoding="UTF-8" ?>
response>
<share operation="add">
<application name="Employee">
<usernames>
<username>user1</username>
<username>user2</username>
</usernames>
<status>Success</status>
</application>
</share>
</response>

JSON response

{"response":[{"status":"Success","usernames":"[user1, user2]","application":[{"name":"Employee"}],"share":[{"operation":"add"}]}]}

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".