Add Records

REST API v1 - Add Records

  • Zoho Creator's v1 APIs will reach their end-of-life on February 3rd, 2021. We strongly recommend you to migrate to the new v2 APIs. Refer to this post to learn more.
  • Accounts in Zoho's Australia data center ( can only use Creator's v2 APIs
  • Corresponding v2 API: Add Records



<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, <<ownername>/<applicationname>/...> to obtain it.
<applicationName> and <formName>These are the link names of your application and form as can be referred from here.
<format>This is the type of response format as listed below.


xml, json

HTTP Method



Parameter NameUsageDescription
authtokenRequired.A valid API authtoken. Refer this page to generate authtoken.
scopeRequiredSpecify the value as creatorapi
<field name>RequiredThis is the link name of a field. This parameter's value specifies the value to be set for that field. Refer to this page for the link names used in your applications.


  • A valid AuthToken
  • Please ensure that you've enabled the API accesspermission for the required users. It's enabled by default. It determines if the user is allowed to use your Creator application's APIs.


  • You can add only one record in one form at a time.
  • Multiple picklist values must be separated by a comma.
  • Only the owner of the application can add a record to a private Form.
  • Anyone with a valid authtoken can add a record to a public Form.
  • Any user with a valid authtoken and share permission can add a record to a shared Form.
  • Mandatory form fields cannot be left blank in the add request.
  • The record ID of the new entry is returned along with the field values passed in the request.

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="Name" value="Gary">
<input type="text" name="DOB" value="12-Jun-1980">
<input type="text" name="Address" value="USA">
<input type="text" name="Basic" value="10000">
<input type="text" name="Hobbies" value="Reading,Writing">

<input type="submit" value="Add Record">

Sample Response

XML response

        <form name="Employee">
                     <field name="Name">
                     <field name="DOB">
                     <field name="Basic">
                     <field name="Address">
                    <field name="Hobbies">


                     <field name="ID">
                     <field name="dateFormat">
                     <field name="timeZone">

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

Share this post : FacebookTwitter

Still can't find what you're looking for?

Write to us: