REST API - Share Application



xml, json

HTTP Method



Parameter Name Usage Description
authtoken Required. A valid API authtoken. Refer Generate-Auth-Token.html for authtoken.
scope Required Specify the value as creatorapi
applinkname Required.

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

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



  • Only the owner of the application can set sharing.

Sample Request

<form method="POST" action="">
<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">

Sample Response

XML response

<?xml version="1.0" encoding="UTF-8" ?>
<share operation="add">
<application name="Employee">

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