Skip to main content

Update Record

Description

Zoho CRM: Update Record step will update an existing record on the Zoho CRM instance.

No.Scope
1scope=ZohoCRM.modules.ALL

(or)

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

Reference API documentation: https://www.zoho.com/crm/developer/docs/api/v3/update-records.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:Note: At least one input field must be provided. Either using JSON or Table Fields.
1ModuleOn click get button, if a connection is successfully established it populates a list of the module on the Zoho CRM.

The data type is String. This field is mandatory.

2GetOn click the get button, if a connection is successfully established it populates a list of the module.

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 IdIn this field provide a record Id that is to be updated.
4Accept fields as JSONOn the selection of checkbox, we can use the JSON field as an input to build JSON, when It is not checked we can use table input to build the JSON.

The data type is Checkbox. This field is mandatory.

5JSONIn this field provide JSON in a valid format to update a record. The data type is String.

Following is Sample JSON:

{<p>"data": [</p> {<p>"Email": "pqr@vyomlabs.com" </p> }<p> ]</p>}

Note: If invalid field name is provided to update still plugin step will execute successfully.

Table Fields:
1Variable Field NameThis is an optional field. Choose a field in input stream from drop down list or provide a user or system defined variable.

The data type is String.

Note:• If both Static Field Name and Variable Field Name are provided in the table, then the Static Field Name is considered.

• Even if an invalid field name to be updated is provided, the plugin step executes successfully.

2Static Field NameOn click of a cell in this column, it opens a dialog with the fields of the module’s records. The name of the fields to be updated should be selected. Multiple fields can be selected from the list displayed on click. The selected field’s values provided below will be updated in the record. The data type is String.

Note:

• If both Static Field Name and Variable Field Name are provided in the table, then the Static Field Name is considered.

• Even if an invalid field name to be updated is provided, the plugin step executes successfully.

3Field ValueProvide field values to be updated for the corresponding fields (Static Field Name/Variable Field Name above). The data type is String.