Insert Subform Data
Purpose
To insert a new record with subforms in a module.
Endpoints
Request Details
Request URL
{api-domain}/crm/{version}/{module_api_name}
Supported modules
Leads, Accounts, Contacts, Deals, Campaigns, Cases, Solutions, Products, Vendors, Quotes, Sales Orders, Purchase Orders, Invoices and Custom.
Header
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Scope
scope=ZohoCRM.modules.{module_name}.{operation_type}
Possible module names
leads, accounts, contacts, deals, campaigns, cases, solutions, products, vendors, quotes, salesorders, purchaseorders, invoices and custom.
Possible operation types
ALL - Full access to a record
WRITE - Edit records in a module
CREATE - Create records in a module
Note
- To add multiple subforms, enter the input in the following format.
{
“data”: [
{
....
Subform_1: [
{
sub_form_data
},
],
...
},
{
....
Subform_2: [
{
sub_form_data
},
],
...
}
]
} - The Enterprise and Zoho One editions support a maximum of two subform fields in a module, while the Ultimate and CRM Plus editions support five subform fields in a module. Each subform field can have a maximum of 100 subform records in a single record in a module.
- A maximum of 5 aggregate custom fields are available for a subform.
- 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.
- If there are no JSON objects given within the subform attribute, that subform will be deleted.
Sample Input
Copied
Here, "Languages" and "Availability" are two subforms in the Leads module. "Proficiency" and "Languages_Known" are custom picklists in Languages subform. "Weekends" and "Weekdays" are boolean fields in Availability subform.
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_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 subform 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 subform records
Resolution: The user does not have the permission to add subform records. Contact your system administrator. - INVALID_DATAHTTP 400
invalid data
Resolution: The input specified is incorrect. Specify valid input. - MANDATORY_NOT_FOUNDHTTP 400
required field not found
Resolution: You have not specified one or more mandatory fields in the input. Refer to Fields Metadata API to know the mandatory fields.
Sample Response
Copied