REST API - Change Access Privileges of a Form or View

URL

https://creator.zoho.com/api/<format>/formorview/changeaccess/

where <format> is the type of response format as listed below.

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 generating authtoken.
scopeRequiredSpecify the value as creatorapi
applinknameRequired.The link name of your application, as can be referred to here.
componentnameRequired.The link name of the form or view to set access level for.
accessRequired.The access level, can be private or public.

Prerequisites

Notes

  • Only the owner of the application can set access privileges.

Sample Request

<form method="POST" action="https://creator.zoho.com/api/xml/formorview/changeaccess/">
 <input type="hidden" name ="authtoken" value="************">
 <input type="hidden" name ="scope" id="scope" value="creatorapi">
 <input type="text" name ="applinkname" value="sample">
 <input type="text" name ="componentname" value="Employee">
 <input type="text" name ="access" value="public">

 <input type="submit" value="Make Employee Public">
</form>

Sample Response

XML response

<?xml version="1.0" encoding="UTF-8" ?>
<response>
    <application name="sample">
        <form name="Employee">
            <access>public</access>
            <status>Success</status>
        </form>
    </application>
</response>

JSON response

{"form":{"access":"public","status":"Success","name":"Employee"},"application-name":"sample"}

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