Insert Records API
Purpose
To add new records to a module.
Endpoints
Request Details
Request URL
{api-domain}/crm/v2/{module_api_name}
Supported modules
Leads, Accounts, Contacts, Deals, Campaigns, Tasks, Cases, Events, Calls, Solutions, Products, Vendors, Price Books, Quotes, Sales Orders, Purchase Orders, Invoices, and Custom
Header
Authorization: Zoho-oauthtoken 100xx.d92d4xxxxxxxxxxxxx15f52
Scope
scope=ZohoCRM.modules.ALL
(or)
scope=ZohoCRM.modules.{module_name}.{operation_type}
Possible module names
leads, accounts, contacts, deals, campaigns, tasks, cases, events, calls, solutions, products, vendors, pricebooks, quotes, salesorders, purchaseorders, invoices, custom, and notes
Possible operation types
ALL - Full access to the record
WRITE - Edit records in the module
CREATE - Create records in the module
To insert a single record, send only one JSON object in the input with the necessary keys and values.
The 'INVALID_DATA' error is thrown if the field value length is more than the maximum length defined for that field.
If an API is used inside a Function and the field value length exceeds the limit, then that function receives an error response from the API. For ex: If the max length for a "Text field" is defined as 10, then value given for it in API cannot be "12345678901", as it has 11 characters.
Duplicates are checked for every insert record API call based on unique fields.
A maximum of 100 records can be inserted per API call.
You must use only Field API names in the input. You can obtain the field API names from:
Fields metadata API (the value for the key “api_name” for every field). (Or)
Setup > Developer Space > APIs > API Names > {{Module}}. Choose “Fields” from the “Filter By” drop-down.
The trigger input can be workflow, approval, or blueprint. If "trigger" is not mentioned, the workflows, approvals and blueprints related to the API will get executed. Enter the trigger value as [] to not execute the workflows.
Records with Subform details can also be inserted to Vertical Solutions using the Records API. Please look at Subforms API to learn more about adding subform information within a record.
The $approved key is used to create records in the approval mode. It is mostly used for leads and contacts procured from web forms. Specify the value as false to create the record in approval mode.
Refer to Response Structure for more details about the JSON keys, values, and their descriptions. You can also use the sample response of each module as the input when you insert, update, or upsert a record in that corresponding module.
Sample Request
In the request, "@newlead.json" contains the sample input data.
System-defined mandatory fields for each module
While inserting records there are a few system-defined mandatory fields that you need to mention. Inorder to successfully insert records in Vertical Solutions, make sure you enter user-defined mandatory fields too.
- Leads
"Last_Name" - Single Line
- Contacts
"Last_Name" - Single Line
- Accounts
"Account_Name" - Single Line
- Deals
"Deal_Name"- Single Line
"Stage" - Picklist
"Pipeline" - Single Line (mandatory when pipeline is enabled) - Tasks
"Subject" - Multi Line
- Calls
"Subject" - Multi Line
"Call_Type" - Picklist
"Call_Start_Time" - Date/Time
"Call_Duration" - Single Line - Events
"Event_Title"- Single Line
"Start_DateTime" - Date/Time
"End_DateTime" - Date/Time - Products
"Product_Name" - Single Line
- Quotes
"Subject"- Single Line
"Quoted_Items" - Line item subform - Invoices
"Subject"- Single Line
"Invoiced_Items" - Line item subform - Campaigns
"Campaign_Name" - Single Line
- Vendors
"Vendor_Name"- Single Line
- Price Books
"Price_Book_Name"- Single Line
"Pricing_Details"- JSON Array with "from_range", "to_range", "discount" - Cases
"Case_Origin" - Picklist
"Status"- Picklist
"Subject" - Single Line - Solutions
"Solution_Title"- Single Line
- Purchase Orders
"Subject"- Single Line
"Vendor_Name"- Lookup
"Purchased_Items" - Line item subform - Sales Orders
"Subject"- Single Line
"Ordered_Items" - Line item subform
Sample Attributes
The following table gives you specific details about each field type in Zoho Vertical Solutions and their limitations. The JSON type and the data type of the field-types are extracted from fields metadata API.
The regex patterns listed below use the Unicode representation. Please refer to this link to check if this is supported in your preferred language.
- Single Linestring
Accepts up to 255 characters, and alphanumeric and special characters.
Example:"Last_Name": "Mike O'Leary" - Multi Linestring
Small - accepts up to 2000 characters.
Large - accepts up to 32000 characters.
You will not be able to use this field to create custom views, reports or other filters. Accepts alphanumeric and special characters.
Example:"Multi_Line_1": "This is the first line \n Now for the second Line" - Emailstring
Accepts valid email IDs. The regex in Zoho Vertical Solutions to validate the email fields is:
^[\+\-\p{L}\p{M}\p{N}_]([\p{L}\p{M}\p{N}!#$%&'*+\-\/=?^_`{|}~.]*)@(?=.{4,256}$)(([\p{L}\p{N}\p{M}]+)(([\-_]*[\p{L}\p{M}\p{N}])*)[.])+[\p{L}\p{M}]{2,22}$
Example:"Email_1": "p.boyle@zylker.com" - Phonestring
Accepts up to 30 characters. This limit may vary based on the value configured in 'Number of characters allowed' in the properties pop-up of the field, in UI.
Accepts only numeric characters and '+' (to add extensions). The regex pattern in Zoho Vertical Solutions to validate this field's value is ^([\+]?)(?![\.-])(?>(?>[\.-]?[ ]?[\da-zA-Z]+)+|([ ]?\((?![\.-])(?>[ \.-]?[\da-zA-Z]+)+\)(?![\.])([ -]?[\da-zA-Z]+)?)+)+(?>(?>([,]+)?[;]?[\da-zA-Z]+)+)?[;]?$
Example:"Phone_1": "9900000000"
"Phone_1":"91(987)654321" - Pickliststring
You can either pass an existing pick list value or add a new one. The pick list value accepts all alphanumeric and special characters.
Example:"Industry": "automobile" - Multi-select picklistJSON array
You can either pass existing pick list values or add a new one. The pick list value accepts all alphanumeric and special characters..
Example:"Courses_Opted": [
"Analytics",
"Big data"
] - Datestring
Accepts date in yyyy-MM-dd format.
Example: "Date_1": "2017-08-16" - Date/Timestring
Accepts date and time in yyyy-MM-ddTHH:mm:ss±HH:mm format.
Example: "Date_Time": "2017-08-16T14:32:23+05:30".
Date_Time is in the ISO8601 format and the time zone is the current user's time zone. - Numberinteger
Accepts numbers up to 9 digits. This limit may vary based on the value configured in 'Maximum digits allowed' in the properties pop-up of the field, in UI. Accepts only numeric values.
- Currencydouble
Before decimal point - accepts numbers up to 16 digits. This limit may vary based on the value configured in 'Maximum digits allowed' in the properties pop-up of the field, in UI.
After decimal point - accepts precision up to 9 digits. This limit may vary based on the value configured in 'Number of decimal paces' in the properties pop-up of the field, in UI. Accepts only numeric values.
Example:"Annual_Revenue": 250000.90 - Decimaldouble
Before decimal point - accepts numbers up to 16 digits. This limit may vary based on the value configured in 'Maximum digits allowed' in the properties pop-up of the field, in UI.
After decimal point - accepts precision up to 9 digits. This limit may vary based on the value configured in 'Number of decimal places' in the properties pop-up of the field, in UI.
Accepts only numeric values..
Example:"Decimal_1": 250000.50 - Percentdouble
Accepts numbers up to 5 digits and only numeric values.
Example:"Percentage": 25 - Long Integerstring
Accepts numbers up to 18 digits. This limit may vary based on the value configured in 'Maximum digits allowed' in the properties pop-up of the field, in UI. Accepts only numeric values.
Example:"EAN_Code":"0012345600012" - Checkboxboolean
Accepts only Boolean values (true,false)
Example:"Email_Opt_Out": true - URLstring
Accepts valid URLs. The regex pattern in Zoho Vertical Solutions to validate this field's value is:
^(http:\/\/www.|https:\/\/www.|ftp:\/\/www.|www.|http:\/\/|https:\/\/|ftp:\/\/|){1}[^\x00-\x19\x22-\x27\x2A-\x2C\x2E-\x2F\x3A-\x40\x5B-\x5E\x60\x7B\x7D-\x7F]+(\.[^\x00-\x19\x22\x24-\x2C\x2E-\x2F\x3C\x3E\x40\x5B-\x5E\x60\x7B\x7D-\x7F]+)+(\/[^\x00-\x19\x22\x3C\x3E\x5E\x7B\x7D-\x7D\x7F]*)*$
Example:"URL": "https://www.zylker.com" - LookupJSON object
Accepts unique ID of the record, which you can get through Get Records API.
Example:"Lookup" : {
"id" : "425248000000104001"
} - UserJSON object
This is a default look-up field to users in Zoho Vertical Solutions.
Example:"User":
{
"name":"Patricia Boyle",
"id":"4150868000000623001"
} - lar_idstring
The unique ID of the lead assignment rule you want to trigger while inserting the lead. Use the Get Assignment Rules API to obtain the lar_id. This key must be given parallel to the key "data".
- apply_feature_executionJSON array
Use this array to apply an existing layout rule when you create a record. Layout rules allow you to show a section, certain fields, set mandatory fields, or show a subform. However, you can only trigger the "Set Mandatory Field" option through the API. Specify the value layout_rules for the key name to apply a layout rule to the record. Note that you must give this key parallel to "data".
Ensure that the input body includes all the keys required to satisfy the criteria in the layout rule. The system throws an error, otherwise. For example, if the layout rule triggers when the Lead_Source is Employee Referral, and you have mandated the Company field, then the system throws the MANDATORY_NOT_FOUND error if you fail to give the Company key in the input.
Sample Input
Copied
Possible Errors
- INVALID_MODULEHTTP 400
The module name given seems to be invalid
Resolution: You have specified an invalid module name or there is no tab permission, or the module could have been removed from the available modules. Specify a valid module API name. - INVALID_MODULEHTTP 400
The given module is not supported in API
Resolution: The modules such as Documents and Projects are not supported in the current API. (This error will not be shown, once these modules are been supported). Specify a valid module API name. - INVALID_DATAHTTP 400
Invalid Data
Resolution: One of the input keys is specified in the wrong format. Refer to Sample Attributes section above and specify valid input. - INVALID_DATAHTTP 400
Invalid Data
Resolution: The record passed isn't a JSON object. Refer to Sample Input section and specify valid input. - INVALID_DATAHTTP 202
Invalid Data
Resolution: There is a data type mismatch in one of the input keys is specified. Refer to Sample Attributes section above and specify valid input. - MANDATORY_NOT_FOUNDHTTP 202
You have not specified one or more mandatory fields.
Resolution: You must specify all the mandatory fields of the module including the layout-specific ones, if you want to execute the layout rule. - INVALID_DATAHTTP 400
Invalid Data
Resolution: One of the input keys has the invalid data type. Refer to Sample Attributes section above and specify valid input. - INVALID_URL_PATTERNHTTP 404
Please check if the URL trying to access is a correct one
Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to request URL section above. - OAUTH_SCOPE_MISMATCHHTTP 401
Unauthorized
Resolution: Client does not have ZohoCRM.modules.{module_name}.CREATE scope. Create a new client with valid scope. Refer to scope section above. - NO_PERMISSIONHTTP 403
Permission denied to add records
Resolution: The user does not have permission to add records. Contact your system administrator. - INTERNAL_ERRORHTTP 500
Internal Server Error
Resolution: Unexpected and unhandled exception in Server. Contact support team. - INVALID_REQUEST_METHODHTTP 400
The http request method type is not a valid one
Resolution: You have specified an invalid HTTP method to access the API URL. Specify a valid request method. Refer to endpoints section above. - AUTHORIZATION_FAILEDHTTP 400
User does not have sufficient privilege to add records
Resolution: The user does not have the permission to add records. Contact your system administrator. - DUPLICATE_DATAHTTP 202
duplicate data
Resolution: You have specified a duplicate value for one or more unique fields. Refer to Fields Metadata API to know the unique fields. - LIMIT_EXCEEDEDHTTP 202
Only 50 participants can be added to an event.
Resolution: You can add only a maximum of 50 participants to an event. Ensure that the number of participants you add does not exceed 50.
Sample Response
Copied