Upload a file to CRM

POST/upload

Use it in a workflow

Add a step and choose the Zoho CRM connector.
Pick the Upload a file to CRM action (under Files).
Fill in the fields below, then reference the result from later steps as {{uploadAFileToCrm.response.data}}.

Request

Headers

X-CRM-ORGinteger (int32)required

Static CRM organization identifier. This value is fixed per account and shared during onboarding.

featurestringrequired

Specify the feature for which the file upload is being performed. Possible values: **bulk-write** - Indicates a bulk write operation.

One ofbulk-write

Request body

Enter the body as JSON in the step's Body field.

fileobjectrequired

Specify the file to upload. The file must be a ZIP archive containing one or more CSV files, with a maximum of **25,000 records** per file. The maximum file size is **25 MB.** 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.](https://help.zoho.com/portal/en/community/topic/kaizen-131-bulk-write-for-parent-child-records-scala-sdk)

json

{
  "file": {}
}

Response

Returns 200 with an object. Read it in later steps with {{uploadAFileToCrm.response.data.<field>}}.

statusstring

Represents the status of the upload operation. Possible values: **success** - The file was uploaded successfully.

One ofsuccess

codestring

Represents the result code for the upload operation. Possible values: **FILE_UPLOAD_SUCCESS** - The file was uploaded successfully.

One ofFILE_UPLOAD_SUCCESS

messagestring

Represents the message confirming the outcome of the upload operation.

One offile uploaded.

detailsobject

Represents the details of the uploaded file, including the file ID and creation time.

file_idstringrequired

Represents the unique ID assigned to the uploaded file. Use this ID in the Create Bulk Write Job request.

created_timestring (date-time)required

Represents the date and time when the file was uploaded, in ISO 8601 format.

json

{
  "status": "success",
  "code": "FILE_UPLOAD_SUCCESS",
  "message": "file uploaded.",
  "details": {
    "file_id": "string",
    "created_time": "2025-01-01T00:00:00Z"
  }
}

Need more? See the Zoho CRM guide for connection setup and behaviour shared by every action.

Was this page helpful?