Skip to main content

Download Attachment

Description

Zoho CRM: Download Attachment step download attachments of the record from the Zoho CRM instance.

No.Scope
1scope=ZohoCRM.modules.ALL

(or)

scope=ZohoCRM.modules.{module_name}.{operation_type}

(and)

scope=ZohoCRM.modules.attachments.{operation_type}

Reference: https://www.zoho.com/crm/developer/docs/api/v3/download-attachments.html

Configurations

General Tab:

No.Field NameDescription
1Step NameName of the step. This name has to be unique in a single workflow.
Connection:
2Base URLSpecify a base URL of the Zoho CRM instance.

For example: https://crm.zoho.in

The Base URL will change as per the Data Centre.
3Client IdSpecify the client Id that is created on Zoho Developer Console.

The data type is string. This field is mandatory.

Client Secret:
4Checkbox: Accept value as variable/staticLeave checkbox unchecked to accept Client Secret from a field in the previous steps using a drop down list, else enable checkbox for Client Secret field to appear as text box.
5Client SecretSpecify Client Secret that is created on Zoho Developer Console. The data type is string. This field is mandatory.If checkbox above is enabled Client Secret field appears as Text box and you may provide a static value or variable.

Else if checkbox above is disabled Client Secret field appears as a drop down containing fields from previous steps. You may select the field containing the Client Secret value.

Refresh Token:The process to get Refresh Token is available in Appendix 27: ZOHO CRM: Generate Refresh Token.
5Checkbox: Accept value as variable/staticLeave checkbox unchecked to accept Refresh Token from a field in the previous steps using a drop down list. Else enable checkbox for Refresh Token field to appear as Text box.
6Refresh TokenSpecify the Refresh Token with appropriate permissions.

The data type is string. This field is mandatory.

If checkbox above is enabled Refresh Token field appears as Text box and you may provide a static value or variable.

Else if checkbox above is disabled Refresh Token field appears as a drop down containing fields from previous steps. You may select the field containing the Refresh Token value.
7Test ConnectionVerifies the connection is established or not.

Note: The Test Connection button does not work for previous step variables. The button only works with static values and environment variables.

Input Tab

No.Field NameDescription
Input Fields:
1ModuleSpecify a module whose record’s attachments are to be downloaded.

The data type is string. This field is mandatory.

2GetOn click; if connection is successfully established it populates the list of modules.

Note: The Get button will not work for the previous step variables; the button will only work with static values and environment variables in the connection parameters.

3Record IDSpecify the record ID of the record whose attachments are to be downloaded.

The data type is string. This field is mandatory.

4Download PathSpecify the path where attachments are to be downloaded.

The data type is string. This field is mandatory.

5Delete Output Folder Content Before DownloadingSpecify Yes to delete output folder contents before downloading else Specify No.

Allowed values: Yes, No.

Default value: No

The data type is string. This field is mandatory.

6Add Unique Id for Duplicate FilesSpecify Yes to add Unique ID for duplicate files else Specify No.

Allowed values: Yes, No.

Default value: No

The data type is string. This field is mandatory.

7Add Files to ResultSetSpecify Yes to add the downloaded files to the result and display the download link on AE else Specify No.

Allowed values: Yes, No.

Default value: No

The data type is string. This field is mandatory.

Output Tab

No.Field NameDescription
Output Fields:
1Total FilesSpecify an output field to define the output variable name. The default output variable name is “TotalFiles”. On successful execution, it holds the total number of all files.

The data type is string. This field is mandatory.

2Downloaded FilesSpecify an output field t to define the output variable name. The default output variable name is “DownloadedFiles”. On successful execution, it holds the total number of downloaded files.

The data type is string. This field is mandatory.

3Overwritten FilesSpecify an output field to define the output variable name. The default output variable name is “OverwrittenFiles”. On successful execution, it holds the total number of overwritten files.

The data type is string. This field is mandatory.