Upload File
Purpose
To upload a CSV file in ZIP format for bulk write API. The response contains the file_id. Use this ID while making the bulk write request.
Endpoints
Request Details
Request URL
https://content.zohoapis.com/crm/v3/upload
Header
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
feature: bulk-write - To indicate this is a bulk write job
X-CRM-ORG: zgid - The unique ID (zgid) of your organization obtained through the Organization API
Scope
scope=ZohoFiles.files.ALL
Input form-data
- filefile, mandatory
Choose the zip file you want to upload.
For modules such as Leads and Contacts, you can ZIP one CSV file in it, with a maximum of 25,000 records. If there are more records, make a separate API call by with a ZIP file containing the next 25,000 records in the module.
Please note that the Subform and multi-module lookup (MxN linking module) fields are treated as separate modules in Zoho CRM. This is a parent-child modulecase, for example, the Contacts module is the parent module, and the subform within it is the child module. So, prepare separate CSV files for parent and child modules, then ZIP them together into a ZIP file and upload.
For more details on preparing the input file for parent-child record imports, refer to Kaizen #131 - Bulk Write for parent-child records using Scala SDK.
Note
- To import parent-child module data in a single Bulk Write request:
- Add multiple CSV files in one ZIP file.
- Field mapping is mandatory.
- To import subform or linking module records, specify their respective API names in the input request. Refer to the Create Bulk Write Job API for more details.
Sample Request
Copied
Possible Errors
- INVALID_FILE_FORMATHTTP 400
The file you uploaded is not in the zip format.
Resolution: Please upload your file only in zip format. - FILE_TOO_LARGEHTTP 413
The file size is too large to process
Resolution: Upload the file with maximum of 25MB. - INVALID_URL_PATTERNHTTP 404
Please check if the URL trying to access is a correct one
Resolution: The request URL is incorrect. Specify a valid request URL. Refer to request URL section above. - OAUTH_SCOPE_MISMATCHHTTP 401
Unauthorized
Resolution: The current request has no valid scope to upload a file. Create a client with scope ZohoFiles.files.ALL. Refer to scope section above. - NO_PERMISSIONHTTP 403
Permission denied to create
Resolution: The user has no permission to upload a file. Contact the system administrator. - INTERNAL_ERRORHTTP 500
Internal Server Error
Resolution: Unexpected and unhandled exception in Server. Contact the support team. - INVALID_REQUEST_METHODHTTP 400
The http request method type is not a valid one
Resolution: The requested URL has an invalid method. Please request with a valid method. Refer to endpoints section above. - AUTHORIZATION_FAILEDHTTP 400
User does not have sufficient privilege to create.
Resolution: The user is not authorized to upload a file. Contact the system administrator.
Note
Refer to the Limitations page to learn more about the CSV file limits.
Sample Response
Copied