XML RPC API - Delete Records

Table of ContentsDown

URL

https://creator.zoho.com/api/xml/write

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.
zc_ownernameRequiredThe application owner's name. 
<application name>Required.The name of the application that contains the form. Multiple applications can be added to at a time.
<form name>Required.The name of the form to add records to. Multiple forms in an application can be added to at a time.
<field name>Required.The link name of the field. This parameter's value specifies the value to be set for that field.

Refer to this pagefor the link names used in your applications.

Prerequisites

Notes

  • Anyone with a valid Auth token can add a record to a public Form.
  • Only the owner of the application can add a record to a private Form.
  • Any user with a valid auth token and share permission can add a record to a shared Form.
  • You can add records to multiple applications and multiple forms at a time.
  • Multiple picklist values must be specified within the <options> tag and each value must be specified in <option> tag.

Sample Request

<form method="POST" action="https://creator.zoho.com/api/xml/write">
 <input type="hidden" name ="authtoken" value="************">
 <input type="hidden" name ="scope" id="scope" value="creatorapi">
 <textarea name="XMLString">
  <ZohoCreator>
    <applicationlist>
        <application name='sample'>
            <viewlist>
                <view name='Employee_Report'>
                    <delete>
                        <criteria>
                              <![CDATA[Name == "Gary" && DOB == "12-Jun-1980"]]>
                        </criteria>
                    </delete>
                </view>
            </viewlist>
        </application>
    </applicationlist>
</ZohoCreator>
</textarea>
<input type="hidden" name="zc_ownername" value="sampleapps">
<input type="submit" value="Delete Record">
</form>

Sample Response

XML response

<?xml version="1.0" encoding="UTF-8" ?>
<response>
    <result>
        <form name="Employee">
         <delete>
            <criteria>
                <![CDATA[Name == "Gary" && DOB == "12-Jun-1980"]]>
            </criteria>
            <status>Success</status>
            </delete>
        </form>
    </result>
</response>

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