Creator API

XML RPC API - Add Records

URL

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

HTTP Method

POST

Parameters

Parameter Name Usage Description
authtoken Required. A valid API authtoken. Refer https://api.creator.zoho.com/Generate-Auth-Token.html for generating authtoken.
scope Required Specify the value as creatorapi
zc_ownername Optional. The application owner's name. Required if the record is being edited by a shared or public user
<application name> Required. The name of the application that contains the form. Multiple applications can be updated at a time.
<form name> Required. The name of the form to edit records in. Multiple forms in an application can be updated 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.

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'>
            <formlist>
                <form name='Employee'>
                    <add>
                        <field name='Name'>
                            <value>Gary</value>
                        </field>
                        <field name='DOB'>
                            <value>12-Jun-1980</value>
                        </field>
                        <field name='Address'>
                            <value>UK</value>
                        </field>Em
                        <field name='Basic'>
                            <value>30000</value>
                        </field>
                        <field name='Hobbies'>
                            <options>
                                <option>Reading</option>
                                <option>Writing</option>
                            </options>
                        </field>
                    </add>
                    <add>
                        <field name='Name'>
                            <value>Jean</value>
                        </field>
                        <field name='DOB'>
                            <value>20-Jul-1981</value>
                        </field>
                        <field name='Address'>
                            <value>UK</value>
                        </field>
                        <field name='Basic'>
                            <value>32000</value>
                        </field>
                        <field name='Hobbies'>
                            <options>
                                <option>Running</option>
                                <option>Swimming</option>
                            </options>
                        </field>
                    </add>
                </form>
            </formlist>
        </application>
    </applicationlist>
</ZohoCreator>
</textarea>

<input type="hidden" name="zc_ownername" value="sampleapps">
<input type="submit" value="Add Record">
</form>

Sample Response - Success Message

XML response

<response>
    <result>
        <form name="Employee">
            <add>
                <values>
                    <field name="Name">
                        <value>Jean</value>
                    </field>
                    <field name="dateFormat">
                        <value>dd-MMM-yyyy</value>
                    </field>
                    <field name="timeZone">
                        <value>America/Los_Angeles</value>
                    </field>
                    <field name="DOB">
                        <value>20-Jul-1981</value>
                    </field>
                    <field name="Basic">
                        <value>32000</value>
                    </field>
                    <field name="Address">
                        <value>UK</value>
                    </field>
                    <field name="Hobbies">
                        <options>
                            <option>Running</option>
                            <option>Swimming</option>
                        </options>
                    </field>
                </values>
                <status>Success</status>
            </add>
        </form>
    </result>
    <result>
        <form name="Employee">
            <add>
                <values>
                    <field name="Name">
                        <value>Gary</value>
                    </field>
                    <field name="dateFormat">
                        <value>dd-MMM-yyyy</value>
                    </field>
                    <field name="timeZone">
                        <value>America/Los_Angeles</value>
                    </field>
                    <field name="DOB">
                        <value>12-Jun-1980</value>
                    </field>
                    <field name="Basic">
                        <value>30000</value>
                    </field>
                    <field name="Address">
                        <value>UK</value>
                    </field>
                    <field name="Hobbies">
                        <options>
                            <option>Reading</option>
                            <option>Writing</option>
                        </options>
                    </field>
                </values>
                <status>Success</status>
            </add>
        </form>
    </result>
</response>

Sample Response - Failure Message

<?xml version="1.0" encoding="UTF-8" ?>
 <response>
      <result>
         <form name="Employee">
             <add>
                 <values>
                     <field name="ID">
                         <value>471735000001632045</value>
                     </field>
                     <field name="Name">
                         <value>Gary</value>
                     </field>
                     <field name="DOB">
                         <value>12-Jun-1980</value>
                     </field>
                     <field name="Basic">
                         <value>10000</value>
                     </field>
                     <field name="Address">
                         <value>USA</value>
                     </field>
                     <field name="Hobbies">
                         <options>
                             <option>Reading</option>
                             <option>Writing</option>
                         </options>
                     </field>
                 </values>
                 <status>Failure, Basic*Enter a valid number for Basic</status>
             </add>
         </form>
 </result>
</response>

Sample Request to add record to a form with subform

<ZohoCreator>
        <applicationlist>
            <application name="api-sample">
                <formlist>
                    <form name="Department">
                        <add>
                            <field name="Department_Name">
                                <value>Department Name</value>
                            </field>
                            <field name="Department_ID">
                                <value>11</value>
                            </field>
                            <field name="Employee_Details">
                                <add>
                                    <field name="Name">Employee1</field>
                                    <field name="Email">employee1@zoho.com</field>
                                    <field name="Emp_No">12445</field>
                                    <field name="Contact_Number">12234455</field>
                                </add>
                                <add>
                                    <field name="Name">Employee2</field>
                                    <field name="Email">employee2@zoho.com</field>
                                    <field name="Emp_No">12332</field>
                                    <field name="Contact_Number">12973737</field>
                                </add>
                                <add>
                                    <field name="Name">Employee3</field>
                                    <field name="Email">employee3@zoho.com</field>
                                    <field name="Emp_No">123</field>
                                    <field name="Contact_Number">9989988</field>
                                </add>
                            </field>
                        </add>
                        
                    </form>
                </formlist>
            </application>
        </applicationlist>
    </ZohoCreator>

Sample Response to adding record to a form with subform

<response>
<result>
<form name="Department">
<add>
<values xmlns="add">
<field xmlns="" name="Department_Name">
<value>Department Name</value>
</field>
<field xmlns="" name="Department_ID">
<value>11</value>
</field>
<field xmlns="" name="Employee_Details">
<add>
<field name="Name">Employee1</field>
<field name="Email">employee1@zoho.com</field>
<field name="Emp_No">12445</field>
<field name="Contact_Number">12234455</field>
</add>
<add>
<field name="Name">Employee2</field>
<field name="Email">employee2@zoho.com</field>
<field name="Emp_No">12332</field>
<field name="Contact_Number">12973737</field>
</add>
<add>
<field name="Name">Employee3</field>
<field name="Email">employee3@zoho.com</field>
<field name="Emp_No">123</field>
<field name="Contact_Number">9989988</field>
</add>
</field>
<field name="ID">
<value>752226000001810017</value>
</field>
<field name="dateFormat">
<value>dd-MMM-yyyy</value>
</field>
<field name="timeZone">
<value>America/Los_Angeles</value>
</field>
</values>
<status>Success</status>
</add>
</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".

Notes

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

Top