Overview
Configuration is provided for establishing connections with Zoom Campaigns 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 how to create a connection to Zoho Campaigns REST API using COZYROC's REST Connection Manager.
Step 1. Run "Visual Studio" under "Administrator account". Right click on Connection managers Tab and Select New Connection. In Add SSIS Connection Manager scroll down and select Connection managers for REST Connection and click Add.
Step 2. From drop-down menu Configuration select Zoho Campaigns. Then click New in the Token File parameter to create a new token file.
Step 3: Provide Email or Mobile Number and hit Next button.
Step 4: Once you have completed the login process, you will be redirected to the Authorization screen. Click on Accept to continue with token generation process.
Step 5: Save generated access token. Specify token protection password. Click OK.
Step 6. Click "Test Connection" to test your connection.
Congratulations! You have now established a connection to your Zoho Campaigns instance.
In this guide, we will show how to read data from the Zoho Campaigns service resource using the COZYROC REST Source component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open the "SSIS Toolbox" and drag and drop COZYROC "REST Source" component.
Step 3. Double click on the "REST Source" component and select Zoho Camapigns connection from the combo. Select from available Zoho Camapigns resources listed in the second combo below.
Optionally you can include extra parameters in the grid below if needed.
Step 4. Click on the "Columns tab" and select the Zoho Campaigns resource columns you want to read.
Step 5. Click Preview to make sure all necessary resource columns are included.
Bravo! You have now learned how to read data from Zoho Campaigns service.
In this guide, we will show how to write data to the Zoho Campaigns service resource using the COZYROC REST Destination component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open the "SSIS Toolbox" and drag and drop COZYROC "REST Destination" component.
Step 3. Double click on the "REST Destination" component and select Zoho Campaigns connection from the combo. Also, select resource action and the Zoho Campaigns resource you want to work on.
Step 4. Click on the "Mapping" tab and map the input columns for the process you are configuring.
If you want to provide input for other resource composite objects, change the input above and map the columns.
Done. You have now learned how to write data into the Zoho Campaigns resource.
Configuration
Base URL address: https://campaigns.zoho.com/api/v1.1.
- OAuth 2
-
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}} -
resfmt:
JSON
Documentation: https://www.zoho.com/campaigns/help/developers/access-token.html.
Based on resource template Base.
- [Read recent] action
-
Endpoint URL address:
/recentcampaigns.
The result is extracted from:{{=response.recent_campaigns}}.
The result is paginated.The action has the following user-defined parameters:
- sort: Available values: asc/desc
- status: Specify campaign status.
The following request parameters will be automatically processed:
-
fromindex:
{{=parameters.iterator}} -
range:
{{=parameters.batchSize}}
Documentation: https://www.zoho.com/campaigns/help/developers/recent-campaign.html.
- [Read recently sent] action
-
Endpoint URL address:
/recentsentcampaigns.
The result is extracted from:{{=response.recent_sent_campaigns}}.The action has the following user-defined parameters:
- limit: Required. Limit on the number of campaigns returned.
- version: This will fetch responses based on the current API version
Documentation: https://www.zoho.com/campaigns/help/developers/recently-sent-campaign.html.
- [Create] action
-
Endpoint URL address:
/createCampaign.The following request parameters will be automatically processed:
-
item:
{{=!_.isEmpty(item) && _.extend({ campaignname: item.campaign_name }, item)}}
Documentation: https://www.zoho.com/campaigns/help/developers/create-campaign.html.
-
item:
- [Delete] action
-
Endpoint URL address:
/deletecampaign.The following request parameters will be automatically processed:
-
campaignkey:
{{=item.campaign_key}}
Documentation: https://www.zoho.com/campaigns/help/developers/delete-campaign.html.
-
campaignkey:
- campaign_key
A key field. Template: ShortText.
- updated_time
Template: UnixTime. A read-only field.
- created_time
Template: UnixTime. A read-only field.
- from_email
Template: ShortText.
- subject
Template: ShortText.
- is_hybrid
Template: ShortText. A read-only field.
- sent_time_zone
Template: ShortText. A read-only field.
- sent_date_string
Template: ShortText. A read-only field.
- campaign_preview
Template: ShortText. A read-only field.
- zuid
Template: ShortText. A read-only field.
- sent_time
Template: UnixTime. A read-only field.
- campaign_name
Template: ShortText.
- updated_time_gmt
Template: DateTime. A read-only field.
- campaigntype
Template: ShortText. A read-only field.
- reply_to
Template: ShortText.
- sent_time_gmt
Template: DateTime. A read-only field.
- campaign_status
Template: ShortText. A read-only field.
- created_time_gmt
Template: UnixTime. A read-only field.
- created_date_string
Template: ShortText. A read-only field.
- folder_id
Template: ShortText.
- updated_date_string
Template: ShortText. A read-only field.
- content_url
Template: ShortText.
- list_details
Template: LongText. A composite field.
- topicId
Template: ShortText.
- recipients
-
A read-only field. Field components:
- Contains the following components: sent, opened, optout, spam, unopened, clicked, hardbounce, softbounce, unsent.
Documentation: https://www.zoho.com/campaigns/help/developers/campaign-recipient-data.html.
- action
Field components:
- Contains the following components: send, schedule, clone.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/coupon/coupondetails.
The result is extracted from:{{=[response.response.CouponDetails]}}.The action has the following user-defined parameters:
- couponCode: Required. Get it from recent coupon campaign.
Documentation: https://www.zoho.com/campaigns/help/developers/view-coupon-details.html.
- [Update] action
-
Endpoint URL address:
/coupon/changestatus.The following request parameters will be automatically processed:
-
type:
JSON -
couponCode:
{{=item.coupon}} -
changeStatus:
{{=item.status}}
Documentation: https://www.zoho.com/campaigns/help/developers/change-coupon-status.html.
-
type:
- coupon
A key field. Template: ShortText.
- usedon
Data type: DT_I4 A read-only field.
- campaignname
Template: ShortText. A read-only field.
- status
Template: ShortText.
- expireon
Template: DateTime. A read-only field.
- senton
Template: DateTime. A read-only field.
- couponprefix
Template: ShortText. A read-only field.
- couponid
Template: ShortText. A read-only field.
- recipient
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/workflow.
The result is extracted from:{{=response.workflows}}.The action has the following user-defined parameters:
- sort_order: Available values: asc/desc
- user: List triggers created by my (your list triggers) | all (both your and other's) | other (other's list triggers)
The following request parameters will be automatically processed:
-
trigger-type:
open
Documentation: https://www.zoho.com/campaigns/help/developers/get-open-custom-workflows.html.
- workflow_key
A key field. Template: ShortText.
- created_time
Template: DateTime.
- triggerkey
Template: ShortText.
- workflow_name
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/getmailinglists.
The result is extracted from:{{=response.list_of_details}}.
The result is paginated.The action has the following user-defined parameters:
- sort: Specify sort.
The following request parameters will be automatically processed:
-
fromindex:
{{=parameters.iterator}} -
range:
{{=parameters.batchSize}}
Documentation: https://www.zoho.com/campaigns/help/developers/get-mailing-lists.html.
- [Create] action
-
Endpoint URL address:
/addlistandcontacts.The following request parameters will be automatically processed:
-
item:
-
mode:
newlist -
listname:
{{=item.listname}} -
listdescription:
{{=item.listdesc}} -
signupform:
{{=item.signupform}} -
emailids:
{{=item.emailids}}
Documentation: https://www.zoho.com/campaigns/help/developers/add-new-list-contact.html.
-
item:
- [Update] action
-
Endpoint URL address:
/updatelistdetails.The following request parameters will be automatically processed:
-
listkey:
{{=item.listkey}} -
newlistname:
{{=item.listname}} -
signupform:
{{=item.signupform}}
Documentation: https://www.zoho.com/campaigns/help/developers/update-list.html.
-
listkey:
- [Delete] action
-
Endpoint URL address:
/deletemailinglist.
The action uses GET method.The action has the following user-defined parameters:
- deletecontacts: Specify to delete contacts from the organization or remove them only from the list.
The following request parameters will be automatically processed:
-
listkey:
{{=item.listkey}}
Documentation: https://www.zoho.com/campaigns/help/developers/delete-list.html.
- listkey
A key field. Template: ShortText.
- date
Template: ShortText. A read-only field.
- deletable
Data type: DT_BOOL A read-only field.
- segments
Template: LongText. A read-only field. A composite field.
- updated_time_gmt
Template: UnixTime. A read-only field.
- listdesc
Template: ShortText.
- created_time_gmt
Template: UnixTime. A read-only field.
- list_created_time
Template: DateTime. A read-only field.
- noofunsubcnt
Data type: DT_I4 A read-only field.
- lockstatus
Template: ShortText. A read-only field.
- listtype
Data type: DT_I4 A read-only field.
- sentcnt
Data type: DT_I4 A read-only field.
- owner
Template: ShortText. A read-only field.
- list_campaigns_count
Data type: DT_I4 A read-only field.
- created_time
Template: UnixTime. A read-only field.
- noofcontacts
Data type: DT_I4 A read-only field.
- editable
Data type: DT_BOOL A read-only field.
- listname
Template: ShortText.
- listdgs
Template: ShortText. A read-only field.
- noofbouncecnt
Data type: DT_I4 A read-only field.
- issmart
Template: ShortText.
- list_created_date
Template: ShortText. A read-only field.
- listnotifications
Template: ShortText. A read-only field.
- listunino
Template: ShortText. A read-only field.
- zuid
Template: ShortText. A read-only field.
- servicetype
Data type: DT_I4 A read-only field.
- sno
Data type: DT_I4 A read-only field.
- is_public
Data type: DT_BOOL A read-only field.
- otherslist
Data type: DT_BOOL A read-only field.
- zx
Template: ShortText. A read-only field.
- created_date
Template: UnixTime. A read-only field.
- signupform
Template: ShortText.
- emailids
Template: ShortText.
- details
-
Field components:
-
Uses template:
ListDetailT. - Contains the following components: sentcampaigns, scheduledcampaigns, recentcampaigns.
Documentation: https://www.zoho.com/campaigns/help/developers/list-advanced-details.html.
-
Uses template:
- subs_count
-
Field components:
- Contains the following components: active, unsub, bounce, spam.
Documentation: https://www.zoho.com/campaigns/help/developers/view-total-contacts.html.
- action
Field components:
- Contains the following components: addContacts.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/getlistsubscribers.
The result is extracted from:{{=response.list_of_details}}.
The result is paginated.The action has the following user-defined parameters:
- listKey: Required. Select contact list.
- sort: Specify sort.
- status: Specify status.
The following request parameters will be automatically processed:
-
fromindex:
{{=parameters.iterator}} -
range:
{{=parameters.batchSize}} -
listkey:
{{=ZohoCampaigns.UI.ListEditor.getValue(parameters)}}
Documentation: https://www.zoho.com/campaigns/help/developers/get-list-subscribers.html.
- [Read segment] action
-
Endpoint URL address:
/getsegmentcontacts.
The result is extracted from:{{=response.list_of_details}}.The action has the following user-defined parameters:
- cvid: Required. Specify segment key.
Documentation: https://www.zoho.com/campaigns/help/developers/get-segment-contacts.html.
- [Create] action
-
Endpoint URL address:
/json/listsubscribe.The following request parameters will be automatically processed:
-
listkey:
{{=item.listkey}} -
contactinfo:
{{=JSON.stringify(item)}} -
source:
{{=item.source}} -
topic_id:
{{=item.topic_id}}
Documentation: https://www.zoho.com/campaigns/help/developers/contact-subscribe.html.
-
listkey:
- [Delete] action
-
Endpoint URL address:
/json/listunsubscribe.The following request parameters will be automatically processed:
-
listkey:
{{=item.listkey}} -
contactinfo:
{{=JSON.stringify(item)}} -
topic_id:
{{=item.topic_id}}
Documentation: https://www.zoho.com/campaigns/help/developers/contact-unsubscribe.html.
-
listkey:
- zuid
A key field. Template: ShortText.
- added_time
Template: ShortText. A read-only field.
- source
Template: ShortText.
- topic_id
Template: ShortText.
- action
Field components:
- Contains the following components: doNotMail.
- [External]
-
The external fields URL address:
/contact/allfields. The external fields list is extracted from:{{=response.response.fieldnames.fieldname}}.- {{=external.FIELD_NAME}}
Template: ShortText. ( length {{=external.MAXLENGTH}} )
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/contact/allfields.
The result is extracted from:{{=response.response.fieldnames.fieldname}}.The following request parameters will be automatically processed:
-
type:
JSON
Documentation: https://www.zoho.com/campaigns/help/developers/get-contact-fields.html.
-
type:
- [Create] action
-
Endpoint URL address:
/custom/add.The following request parameters will be automatically processed:
-
type:
JSON -
fieldname:
{{=item.FIELD_NAME}} -
fieldtype:
{{=item.UITYPE}} -
fieldlength:
{{=item.MAXLENGTH}}
Documentation: https://www.zoho.com/campaigns/help/developers/create-custom-field.html.
-
type:
- FIELD_NAME
Template: ShortText.
- UITYPE
Template: ShortText.
- MAXLENGTH
Data type: DT_I4
- no
Data type: DT_I4 A read-only field.
- FIELD_ID
Template: ShortText. A read-only field.
- is_otheruser_field
Data type: DT_BOOL A read-only field.
- DISPLAY_NAME
Template: ShortText. A read-only field.
- BLOCK_LABEL
Template: ShortText. A read-only field.
- SEQUENCE
Data type: DT_I4 A read-only field.
- FIELD_DISPLAY_NAME
Template: ShortText. A read-only field.
- TYPE
Template: ShortText. A read-only field.
- block_sequence
Data type: DT_I4 A read-only field.
- IS_MANDATORY
Data type: DT_BOOL A read-only field.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/merge/create.
The action uses GET method.The following request parameters will be automatically processed:
-
type:
JSON
Documentation: https://www.zoho.com/campaigns/help/developers/merge-tags.html.
-
type:
- mergename
Template: ShortText.
- fieldname
Template: ShortText.
- tagtype
Template: ShortText.
- fieldtype
Template: ShortText.
- mailvalue
Template: ShortText.
- socialvalue
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/topics.
The result is extracted from:{{=response.topicDetails}}.
The result is paginated.The following request parameters will be automatically processed:
-
range:
{{=parameters.batchSize}} -
from_index:
{{=parameters.iterator}}
Documentation: https://www.zoho.com/campaigns/help/developers/get-topics.html.
-
range:
- [Create] action
-
Endpoint URL address:
/topics.The following request parameters will be automatically processed:
-
details:
{{=JSON.stringify({ topic_name: item.topicName, topic_desc: item.topicDesc, product_id: item.product_id })}}
Documentation: https://www.zoho.com/campaigns/help/developers/create-topics.html.
-
details:
- topicId
Template: ShortText.
- primaryList
Data type: DT_I4
- topicName
Template: ShortText.
- topicDesc
Template: ShortText.
- product_id
Template: ShortText.
Based on resource template Base.
- [Read Product] action
-
Endpoint URL address:
{{='/topics/products'}}.
The result is extracted from:{{=response.products}}.
The action uses GET method.
The result is paginated.The following request parameters will be automatically processed:
-
range:
{{= parameters.batchSize}} -
from_index:
{{= parameters.iterator}}
Documentation: https://www.zoho.com/campaigns/help/developers/get-product.html.
-
range:
- product_id
Template: ShortText.
- product_name
Template: ShortText.
- [Read] action
-
The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
-
_includeUserParameters:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
item:
{{=item}}
-
_includeUserParameters:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
item:
{{=item}}
-
_includeUserParameters:
- [Delete] action
-
The action uses DELETE method.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Date
Data type: DT_DBDATE
- UnixTime
Data type: DT_DBTIMESTAMP The gathered value is processed with
{{=value && new Date(parseFloat(value) * 1000).toUTCString()}}expression.- RecipientT
Field components:
-
Uses template:
ShortText. - Contains the following components: country, note, contactid, sentdate, city, timezone, secondtestfield, contactemailaddress, title, secondary_email, linkedin_handle, twitter_handle, bingo1, contactfn, facebook_handle, state, contactln, website, address, jobtitle, mobile, zipcode, sent_time, contactstatus, phone, companyname, bingo.
-
Uses template:
- ListDetailT
Field components:
-
Uses template:
ShortText. - Contains the following components: contact_stats, localsubscribers, email_client, tablet_devices, campaign_details, requestdetails, web_client, brower_type, mobile_devices, operating_system.
-
Uses template:
Knowledge Base
What's New
- 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.