REST API - Delete Records

Table of Contents

URL

When accessed by the application owner:

https://creator.zoho.com/api/<ownername>/<format>/<applicationName>/form/<formName>/record/delete

When accessed by a shared user:

https://creator.zoho.com/api/<ownername>/<format>/<applicationName>/view/<viewName>/record/delete

where,

<ownername>This is the admin username which can be obtained using zoho.adminuser or zoho.appuri variables (refer this page). You can also view your app URL in the URL bar of your browser for example, <https://creator.zoho.com/<ownername>/<applicationname>/...> to obtain it.
<applicationName> , <formName> and <viewName>These are the link names of your application, form and report (that is shared with the users), respectively. They can be referred from here.
<format>This is the type of response format as listed below.

Formats

xml, json

HTTP Method

POST

Parameters

Parameter NameUsageDescription
authtokenRequiredA valid API authtoken. Refer this page for generating authtoken.
scopeRequiredSpecify the value as creatorapi
criteriaRequired

The criteria must be specified in the format <criteria column name> <operator> <value>
where <criteria column name> is the link name of the field to check <value> against
and <operator> is the operator to use. Some of the expamples for the operators supported are
!=, <=, >=,<, >, =

Example : (Name == "Jean" && DOB == "20-Jul-1981")

Refer to this page for the link names used in your applications.

Prerequisites

Notes

  • The owner of the application with a valid auth token can delete a record in a Form.
  • A user with a valid auth token and share permission can delete a record in a View with record deleting enabled.

Sample Request

<form method="POST" action="https://creator.zoho.com/api/sampleapps/xml/sample/form/Employee/record/delete">
<input type="hidden" name ="authtoken" value="************">
<input type="hidden" name ="scope" id="scope" value="creatorapi">
<input type="text" name="criteria" value="Name=Gary">

<input type="submit" value="Delete Record">
</form>

Sample Response

XML response

<response>
     <result>
        <form name="Employee">
             <delete>
                  <criteria>Name=Gary</criteria>
                       <status>Success</status>
             </delete>
        </form>
    </result>
</response>

JSON response

{"formname":["RestAPI",{"operation":["delete",{"criteria":"Name=Gary","status":"Success"}]}]}

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 to know about them. If the operation is successful, the response message will be displayed with status as "Success".