Overview
Configuration is provided for establishing connections with the Zoho CRM service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Quick Start
In this task, we will show you step-by-step in How-To create a connection to Zoho CRM service using COZYROC's REST Connection Manager.
Step 1. Run "Visual Studio" under "Administrator account".
Select "Data Flow task" tab and Click "Add new Data flow task"
Step 2. Right click on Connection managers Tab and Select New Connection
Step 3. In "Add SSIS Connection Manager" scroll down and select REST "Connection managers for REST Connection" and click "Add"
Step 4. From Configuration drop-down menu select "Zoho CRM connection" and provide Authentication token for your Zoho CRM account, click Test to check your connection and next click OK
Step 5. In Connection managers Tab right click to rename "REST Connection" to "Zoho CRM connection"
Step 1. Open the right side panel and Drag and Drop REST Source component
Step 2. Double click on it and select "Zoho CRM Connection", select from available** Zoho CRM resources** listed in second drop-down menu and click OK
Step 3. Click on Columns and Select from Zoho CRM available columns. Click OK
Step 4. Click Preview columns
Step 5. Drag and drop OLE DB Destination component from the left side panel - SSIS Toolbox
Step 6. Double Click on OLD DB Destination and Select Connection manager and Table name. Click OK
Step 7. Drag the blue arrow to Connect Zoho CRM source and OLE DB Destination
Step 8. Click on OLE Destination Mapping tab and map the columns
Step 9. Run the package
Step 1. Right click on Connection managers Tab and Select New OLE DB Connection
Step 2. Select your DB connection and click OK
Step 3. Drag and drop OLE DB Source component from the left side panel - SSIS Toolbox
Step 4. Select your OLE DB connection and table name. Next click Preview to see the data. Click OK
Step 5. Click on Columns on the left menu and Select Columns you want to map
Step 6. Drag and drop REST Destination component from the SSIS Toolbox and Rename it to "Zoho CRM destination"
Step 7. Drag the blue arrow to Connect OLE DB source with Zoho CRM Destination
Step 8. Double click on "Zoho CRM destination" component and Select "Zoho CRM connection", Action and Resourse from drop down menu. Click OK
Step 9. Click on Mapping tab and map the columns
Step 10. Run the package
Configuration
Base URL address: https://www.zohoapis.com/crm/v2.
- OAuth
-
The authentication uses an authorized token. The token will be refreshed with the following expression:
{{=Date.now() + (response.expires_in - 300000)}}.The authentication has the following user-defined parameters:
- Scope:
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Zoho-oauthtoken {{=token.Access}}
Documentation: https://www.zoho.com/crm/developer/docs/api/oauth-overview.html.
- [Read] action
-
Endpoint URL address:
/settings/modules.
The result is extracted from:{{=response.modules}}.Documentation: https://www.zoho.com/crm/developer/docs/api/modules-api.html.
- id
A key field. Template: Id.
- convertable
Data type: DT_BOOL
- editable
Data type: DT_BOOL
- deletable
Data type: DT_BOOL
- web_link
Template: ShortText.
- singular_label
Template: ShortText.
- modified_time
Template: DateTime.
- viewable
Data type: DT_BOOL
- api_supported
Data type: DT_BOOL
- creatable
Data type: DT_BOOL
- plural_label
Template: ShortText.
- api_name
Template: ShortText.
- modified_by
Template: Id.
- generated_type
Template: ShortText.
- module_name
Template: ShortText.
- business_card_field_limit
Data type: DT_I4
- feeds_required
Data type: DT_BOOL
- filter_supported
Data type: DT_BOOL
- global_search_supported
Data type: DT_BOOL
- parent_module
Template: ShortText.
- presence_sub_menu
Data type: DT_BOOL
- profiles
Field components:
- An array.
-
Uses template:
Profile.
- quick_create
Data type: DT_BOOL
- scoring_supported
Data type: DT_BOOL
- sequence_number
Data type: DT_I4
- visibility
Data type: DT_I4
- fields
-
The value is gathered from
{{=item.api_supported ? '/settings/fields' : undefined}}address. Field components:- An array.
- Contains the following components: id, custom_field, lookup, visible, field_label, length, view_type, read_only, api_name, unique, data_type, formula, currency, decimal_place, pick_list_values, auto_number, default_value, layouts.
Documentation: https://www.zoho.com/crm/developer/docs/api/field-meta.html.
- layouts
-
The value is gathered from
{{=item.api_supported ? '/settings/layouts' : undefined}}address. Field components:- An array.
- Contains the following components: id, created_by, sections, modified_by, status, modified_time, name, profiles, created_time, visible, convert_mapping.
Documentation: https://www.zoho.com/crm/developer/docs/api/layouts-meta.html.
- related_lists
-
The value is gathered from
{{=item.api_supported ? '/settings/related_lists' : undefined}}address. Field components:- An array.
- Contains the following components: id, list_label, api_name, module, name, href, sort_by, fields, sort_order.
Documentation: https://www.zoho.com/crm/developer/docs/api/related-list-meta.html.
- custom_views
-
The value is gathered from
{{=item.api_supported ? '/settings/custom_views' : undefined}}address. Field components:- An array.
- Contains the following components: id, display_value, shared_type, criteria, system_name, shared_details, sort_by, offline, default, system_defined, name, category, fields, favorite, sort_order.
Documentation: https://www.zoho.com/crm/developer/docs/api/custom-view-meta.html.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/users.
The result is extracted from:{{=response.users}}.Documentation: https://www.zoho.com/crm/developer/docs/api/get-users.html.
- country
Template: ShortText.
- role
Template: Lookup.
- city
Template: ShortText.
- signature
Template: ShortText.
- name_format
Template: ShortText.
- language
Template: ShortText.
- locale
Template: ShortText.
- personal_account
Data type: DT_BOOL
- default_tab_group
Template: ShortText.
- street
Template: ShortText.
- alias
Template: ShortText.
- theme
Field components:
-
Uses template:
Tab. - Contains the following components: normal_tab, selected_tab, new_background, background, screen, type.
-
Uses template:
- state
Template: ShortText.
- country_locale
Template: ShortText.
- fax
Template: ShortText.
- first_name
Template: ShortText.
Template: ShortText.
- zip
Template: ShortText.
- decimal_separator
Template: ShortText.
- website
Template: ShortText.
- time_format
Template: ShortText.
- profile
Template: Profile.
- mobile
Template: ShortText.
- last_name
Template: ShortText.
- time_zone
Template: ShortText.
- zuid
Template: ShortText.
- confirm
Data type: DT_BOOL
- full_name
Template: ShortText.
- territories
Template: LongText.
- phone
Template: ShortText.
- dob
Template: ShortText.
- date_format
Template: ShortText.
- status
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/settings/roles.
The result is extracted from:{{=response.role}}.Documentation: https://www.zoho.com/crm/developer/docs/api/get-roles.html.
- display_label
Template: ShortText.
- name
Template: ShortText.
- reporting_to
Template: ShortText.
- admin_user
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/settings/profiles.
The result is extracted from:{{=response.profiles}}.Documentation: https://www.zoho.com/crm/developer/docs/api/get-profiles.html.
- name
Template: ShortText.
- modified_by
Template: Id.
- description
Template: LongText.
- category
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/actions/watch.
The result is extracted from:{{=response.watch}}.Documentation: https://www.zoho.com/crm/developer/docs/api/notifications/get-details.html.
- [Create] action
-
Endpoint URL address:
/actions/watch.
The result is extracted from:{{=response.watch}}.The following request parameters will be automatically processed:
-
application/json:
{{={ watch: batch } }}
Documentation: https://www.zoho.com/crm/developer/docs/api/notifications/enable.html.
-
application/json:
- [Update] action
-
Endpoint URL address:
/actions/watch.
The result is extracted from:{{=response.watch}}.The following request parameters will be automatically processed:
-
application/json:
{{={ watch: batch } }}
Documentation: https://www.zoho.com/crm/developer/docs/api/notifications/update-details.html.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/actions/watch.
The result is extracted from:{{=response.watch}}.The following request parameters will be automatically processed:
-
channel_ids:
{{=_.pluck(batch, 'channel_id').join()}}
Documentation: https://www.zoho.com/crm/developer/docs/api/notifications/disable.html.
-
channel_ids:
- channel_id
A key field. Template: ShortText.
- channel_expiry
Template: DateTime.
- resource_uri
Template: ShortText.
- resource_id
Template: Id.
- notify_url
Template: ShortText.
- resource_name
Template: ShortText.
- events
Template: LongText. A composite field.
- token
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/settings/tags.
The result is extracted from:{{=response.tags}}.The action has the following user-defined parameters:
- module: Required. Specify module name.
Documentation: https://www.zoho.com/crm/developer/docs/api/get-tag-list.html.
- [Create] action
-
Endpoint URL address:
/settings/tags.
The result is extracted from:{{=response.tags}}.The action has the following user-defined parameters:
- module: Required. Specify module name.
The following request parameters will be automatically processed:
-
module:
{{=parameters.module}} -
application/json:
{{={ tags: batch } }}
Documentation: https://www.zoho.com/crm/developer/docs/api/create-tag.html.
- [Update] action
-
Endpoint URL address:
/settings/tags.
The result is extracted from:{{=response.tags}}.The action has the following user-defined parameters:
- module: Required. Specify module name.
The following request parameters will be automatically processed:
-
module:
{{=parameters.module}} -
application/json:
{{={ tags: _.map(batch, function(item) { return _.extend({ id: item.id }, item); }) } }}
Documentation: https://www.zoho.com/crm/developer/docs/api/update-tags.html.
- [Delete] action
-
Endpoint URL address:
/settings/tags/{{=item.id}}.
The result is extracted from:{{=[response.tags]}}.Documentation: https://www.zoho.com/crm/developer/docs/api/delete-tag.html.
- id
A key field. Template: Id.
- name
Template: ShortText.
- created_by
Template: Lookup. A read-only field.
- created_time
Template: DateTime. A read-only field.
- modified_by
Template: Lookup. A read-only field.
- modified_time
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/{{=parameters.module}}/{{=parameters.record_id}}/{{=parameters.related_list}}.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- module: Required. Specify module name.
- record_id: Required. Specify unique record identifier.
- related_list: Required. Specify related list API name.
- modified_since: Optional. Specify datetime to get the list of recently modifed records.
The following request parameters will be automatically processed:
-
If-Modified-Since:
{{=parameters.get('modified_since')}}
Documentation: https://www.zoho.com/crm/developer/docs/api/get-related-records.html.
- [Update] action
-
Endpoint URL address:
/{{=parameters.module}}/{{=item.record_id}}/{{=item.related_list}}/{{=item.id}}.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- module: Required. Specify module name.
Documentation: https://www.zoho.com/crm/developer/docs/api/update-related-records.html.
- [Delete] action
-
Endpoint URL address:
/{{=parameters.module}}/{{=item.record_id}}/{{=item.related_list}}/{{=item.id}}.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- module: Required. Specify module name.
Documentation: https://www.zoho.com/crm/developer/docs/api/delink.html.
- related_list
Template: ShortText.
- [External]
-
The external fields URL address:
/settings/fields. The external fields list is extracted from:{{=_.where(response.fields, { visible: true })}}.- {{=external.api_name}}
Template: {{=ZohoCRM.getFieldTemplate(external.data_type)}}. Data type: {{=ZohoCRM.getDataType(external.data_type)}} ( length {{=external.length || 250}} )
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/Notes.
The result is extracted from:{{=response.data}}.Documentation: https://www.zoho.com/crm/developer/docs/api/get-notes.html.
- [Create] action
-
Endpoint URL address:
/Notes.
The result is extracted from:{{=response.data}}.The following request parameters will be automatically processed:
-
application/json:
{{={ data: batch } }}
Documentation: https://www.zoho.com/crm/developer/docs/api/create-notes.html.
-
application/json:
- [Update] action
-
Endpoint URL address:
/{{=item.se_module}}/{{=item.record_id}}/Notes/{{=item.id}}.
The result is extracted from:{{=response.data}}.Documentation: https://www.zoho.com/crm/developer/docs/api/update-notes.html.
- [Delete] action
-
Endpoint URL address:
/Notes.
The result is extracted from:{{=response.data}}.The following request parameters will be automatically processed:
-
ids:
{{=_.pluck(batch, 'id').join()}}
Documentation: https://www.zoho.com/crm/developer/docs/api/delete-notes.html.
-
ids:
The resource includes the fields from the Note template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/{{=parameters.module}}/{{=parameters.record_id}}/Attachments.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- module: Required. Specify module name.
- record_id: Required. Specify unique record identifier.
Documentation: https://www.zoho.com/crm/developer/docs/api/get-attachments.html.
- [Create] action
-
Endpoint URL address:
/{{=item.module}}/{{=item.record_id}}/Attachments.
The result is extracted from:{{=response.data}}.The following request parameters will be automatically processed:
-
content:
{{=item.content}}
Documentation: https://www.zoho.com/crm/developer/docs/api/upload-attachment.html.
-
content:
- [Delete] action
-
Endpoint URL address:
/{{=item.module}}/{{=item.record_id}}/Attachments/{{=item.id}}.
The result is extracted from:{{=response.data}}.Documentation: https://www.zoho.com/crm/developer/docs/api/delete-attachments.html.
- id
A key field. Template: Id.
- File_Name
Template: ShortText.
- Size
Data type: DT_I4
- Owner
Template: Id. A read-only field.
- Parent_Id
Template: Id. A read-only field.
- Created_By
Template: Id. A read-only field.
- Created_Time
Template: DateTime. A read-only field.
- Modified_By
Template: Id. A read-only field.
- Modified_Time
Template: DateTime. A read-only field.
- module
A key field. Template: ShortText.
- record_id
A key field. Template: Id.
- content
Data type: DT_IMAGE The value is gathered from
/{{=item.module}}/{{=item.record_id}}/Attachments/{{=item.id}}address.
- [Read] action
-
Endpoint URL address:
/{{=resource.external.api_name}}.
The result is extracted from:{{=response.data}}.
The result is paginated.The action has the following user-defined parameters:
- modified_since: Optional. Specify datetime to get the list of recently modifed records.
The following request parameters will be automatically processed:
-
fields:
{{=parameters.fields.join()}} -
page:
{{=parameters.iterator}} -
per_page:
{{=parameters.batchSize}} -
If-Modified-Since:
{{=parameters.get('modified_since')}} -
_includeUserParameters:
{{=parameters}}
Documentation: https://www.zoho.com/crm/developer/docs/api/get-records.html.
- [Read search] action
-
Endpoint URL address:
/{{=resource.external.api_name}}/search.
The result is extracted from:{{=response.data}}.
The result is paginated.The following request parameters will be automatically processed:
-
page:
{{=parameters.iterator}} -
per_page:
{{=parameters.batchSize}} -
_includeUserParameters:
{{=parameters}}
Documentation: https://www.zoho.com/crm/developer/docs/api/search-records.html.
-
page:
- [Read deleted] action
-
Endpoint URL address:
/{{=resource.external.api_name}}/deleted.
The result is extracted from:{{=response.data}}.
The result is paginated.The action has the following user-defined parameters:
- modified_since: Optional. Specify datetime to get the list of recently modifed records.
The following request parameters will be automatically processed:
-
page:
{{=parameters.iterator}} -
per_page:
{{=parameters.batchSize}} -
If-Modified-Since:
{{=parameters.get('modified_since')}} -
_includeUserParameters:
{{=parameters}}
Documentation: https://www.zoho.com/crm/developer/docs/api/get-deleted-records.html.
- [Create] action
-
Endpoint URL address:
/{{=resource.external.api_name}}.
The result is extracted from:{{=response.data}}.
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{={ data: batch, trigger: ZohoCRM.getActionTrigger(parameters) } }}
Documentation: https://www.zoho.com/crm/developer/docs/api/insert-records.html.
-
application/json:
- [Update] action
-
Endpoint URL address:
/{{=resource.external.api_name}}.
The result is extracted from:{{=response.data}}.
The action uses PUT method.The following request parameters will be automatically processed:
-
application/json:
{{={ data: batch, trigger: ZohoCRM.getActionTrigger(parameters) } }}
Documentation: https://www.zoho.com/crm/developer/docs/api/update-records.html.
-
application/json:
- [Upsert] action
-
Endpoint URL address:
/{{=resource.external.api_name}}/upsert.
The result is extracted from:{{=response.data}}.
The action uses POST method.The action has the following user-defined parameters:
- duplicate_check_fields: Specify comma (,) separated list of fields to check for duplicate records.
- trigger: The trigger input can be workflow, approval or blueprint.
The following request parameters will be automatically processed:
-
application/json:
{{={ data: batch, trigger: ZohoCRM.getActionTrigger(parameters) } }}
Documentation: https://www.zoho.com/crm/developer/docs/api/upsert-records.html.
- [Delete] action
-
Endpoint URL address:
/{{=resource.external.api_name}}.
The result is extracted from:{{=response.data}}.
The action uses DELETE method.The following request parameters will be automatically processed:
-
ids:
{{=_.pluck(batch, 'id').join()}}
Documentation: https://www.zoho.com/crm/developer/docs/api/delete-records.html.
-
ids:
- id
A key field. Template: Id.
- deleted_by
Template: Lookup. A read-only field.
- Type
Template: ShortText.
- deleted_time
Template: DateTime. A read-only field.
- [External]
-
The external fields URL address:
/settings/fields. The external fields list is extracted from:{{=_.where(response.fields, { visible: true })}}.- {{=external.api_name}}
Template: {{=ZohoCRM.getFieldTemplate(external.data_type)}}. Data type: {{=ZohoCRM.getDataType(external.data_type)}} ( length {{=external.length || 250}} )
The external resource list URL address: /settings/modules.
The external resource list is extracted from: {{=_.where(response.modules, { api_supported: true })}}.
- [Read] action
-
The following request parameters will be automatically processed:
-
page:
{{=parameters.iterator}} -
per_page:
{{=parameters.batchSize}} -
_includeUserParameters:
{{=parameters}}
-
page:
- [Create] action
-
The action uses POST method.
- [Update] action
-
The action uses PUT method.
- [Delete] action
-
The action uses DELETE method.
- id
A key field. Template: Id.
- ShortText
Data type: DT_WSTR ( length 250 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP Before setting, the value is processed with
{{=value && dateFormat(value, 'yyyy-mm-dd HH:MM:ss', true)}}expression.- Date
Data type: DT_DBDATE Before setting, the value is processed with
{{=value && dateFormat(value, 'yyyy-mm-dd', true)}}expression.- Id
Data type: DT_WSTR ( length 19 )
- PickListValue
Field components:
-
Uses template:
ShortText. - Contains the following components: sequence_number, display_value, maps, actual_value.
-
Uses template:
- Profile
Field components:
-
Uses template:
Id. - Contains the following components: id, default, name.
-
Uses template:
- Lookup
Field components:
-
Uses template:
Id. - Contains the following components: id, name.
-
Uses template:
- Tab
Field components:
-
Uses template:
ShortText. - Contains the following components: font_color, background.
-
Uses template:
- FieldRef
Field components:
-
Uses template:
ShortText. - Contains the following components: api_name, default_value, pick_list_values, required.
-
Uses template:
- Note
Field components:
-
Uses template:
Id. - Contains the following components: id, Note_Title, Note_Content, Parent_Id, se_module, record_id, Owner, Modified_By, Modified_Time, Created_By, Created_Time.
-
Uses template:
What's New
- Fixed: Authentication errors because of failed token refresh (Thank you, Ramu).
- Fixed: Various fixes (Thank you, Michelle).
- New: Included configuration for v2 API.
- Fixed: Various fixes (Thank you, Michelle).
- New: Introduced connection.
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.