Back

This article describes how to set up the Freshsales connector in your Universal Data Hub account.

In this article:

Table of Contents Placeholder

Connector Actions

Action Name AudienceStream EventStream
Create a Lead
Convert a Lead
Update a Lead
Delete A Lead
Create a Contact
Update Contact
Delete a Contact
Create an Account
Update an Account
Delete an Account

Configure Settings

Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector.

After adding the connector, configure the following settings:

  • Company Domain
    The company subdomain name preceding freshsales.io in your login URL.
    Example: COMPANY_DOMAIN.freshsales.io.

    Do not include http:// or https://

  • API Key:
    To find your API key: click your profile picture and select Profile Settings, then click the API Settings tab. You can find your API key in the field "Your API key".

Action Settings - Parameters and Options

Click Next or go to the Actions tab. This is where you configure connector actions.

This section describes how to set up parameters and options for each action.

Action - Create a Lead

Parameters

Parameter Description
Last Name
First Name
  • First name of the lead.
Job Title
  • Designation of the lead in the company they belong to.
Department
  • The department that the lead belongs to.
Email
  • Primary email address of the lead.
Work Phone
  • Work phone number of the lead.
Mobile Phone
  • Mobile phone number of the lead.
Address
  • Address of the lead.
City
  • City that the lead belongs to.
State
  • State that the lead belongs to.
Zipcode
  • Zipcode of the region that the lead belongs to.
Country
  • Country that the lead belongs to.
Lead Stage ID
  • ID of the lead stage that the lead belongs to.
Lead Reason ID
  • ID of the lead reason: that is, the reason to unqualify the lead.
  • Can be set only if the lead is in "Unqualified" stage.
Lead Source ID
  • ID of the source where lead came from.
Owner ID
  • ID of the user to whom the lead has been assigned.
Has Authority
  • Whether the lead has authority to take decisions regarding the purchase.
  • Possible values: true or false.
Do Not Disturb
  • Whether the lead has enabled do not disturb, or unsubscribed from your emails.
  • Possible values: true or false.
Medium
  • The medium that led your lead to your website or app.
Campaign ID
  • The campaign that led your lead to your website or app.
  • Must be an existing Campaign in Freshsales.
Keyword
  • The keywords that the lead used to reach your website or app.
Timezone
  • Timezone that the lead belongs to.
Facebook Account
  • Facebook account of the lead.
Twitter Account
  • Twitter account of the lead.
Linkedin Account
  • LinkedIn account of the lead.
Territory ID
  • ID of the territory that the lead belongs to.
Company Name
  • Name of the company that the lead belongs to.
Company Address
  • Address of the company that the lead belongs to.
Company City
  • City that the lead's company belongs to.
Company State
  • State that the lead's company belongs to.
Company Zipcode
  • Zipcode of the region that the lead's company belongs to.
Company Country
  • Country that the lead's company belongs to.
Company Industry Type ID
  • ID of the industry that the lead's company belongs to.
Company Business Type ID
  • ID of the business that the lead's company belongs to.
Company Number of Employees
  • Number of employees in the lead's company.
  • Possible values (in left column): 1 = " 1-10" 11 = " 11-50" 51 = " 51-200 201 = " 201-500" 501 = " 501-1000" 1001 = "1 001-5000" 5001 = " 5001-10000" 10001 = "10000+"
Company Annual Revenue
  • Annual revenue of the lead's company.
Company Website
  • Website of the lead's company.
Company Phone
  • Phone number of the lead's company.
Deal Name
  • Name of the lead's deal.
Deal Amount
  • Value of the lead's deal in dollars.
Deal Expected Close Date
  • The date when the lead's deal is expected to close.
Deal Product ID
  • ID of the product that the lead's deal belongs to (in a multi-product company).
Created Date
  • Lead creation timestamp.
Updated Date
  • Lead updated timestamp.
Custom Fields
  • Map additional custom fields for the lead.
  • Custom fields must already exist in Freshsales.
  • You must also prepend ' cf_' to the field name.
  • For example, when mapping a value to a custom field called ' custom1', you must use ' cf_custom1' as the field name.

Action - Convert a Lead

Parameters

Parameter Description
Last Name
Company Name
  • Name of the company that the lead belongs to.
Lead ID
First Name
  • First name of the lead.
Job Title
  • Designation of the lead in the company they belong to.
Department
  • The department that the lead belongs to.
Email
  • Primary email address of the lead.
Work Phone
  • Work phone number of the lead.
Mobile Phone
  • Mobile phone number of the lead.
Address
  • Address of the lead.
City
  • City that the lead belongs to.
State
  • State that the lead belongs to.
Zipcode
  • Zipcode of the region that the lead belongs to.
Country
  • Country that the lead belongs to.
Lead Stage ID
  • ID of the lead stage that the lead belongs to.
Lead Reason ID
  • ID of the lead reason: that is, reason to unqualify the lead.
  • Can be set only if the lead is in "Unqualified" stage.
Lead Source ID
  • ID of the source where lead came from.
Owner ID
  • ID of the user to whom the lead has been assigned.
Has Authority
  • Whether the lead has authority to take decisions regarding the purchase.
  • Possible values: true or false.
Do Not Disturb
  • Whether the lead has enabled do not disturb, or unsubscribed from your emails.
  • Possible values: true or false.
Medium
  • The medium that led your lead to your website or web app.
Campaign ID
  • The campaign that led your lead to your website or web app.
  • Must be an existing Campaign in Freshsales.
Keyword
  • The keywords that the lead used to reach your website or web app.
Timezone
  • Timezone that the lead belongs to.
Facebook Account
  • Facebook account of the lead.
Twitter Account
  • Twitter account of the lead.
Linkedin Account
  • LinkedIn account of the lead.
Territory ID
  • ID of the territory that the lead belongs to.
Company Address
  • Address of the company that the lead belongs to.
Company City
  • City that the lead's company belongs to.
Company State
  • State that the lead's company belongs to.
Company Zipcode
  • Zipcode of the region that the lead's company belongs to.
Company Country
  • Country that the lead's company belongs to.
Company Industry Type ID
  • ID of the industry that the lead's company belongs to.
Company Business Type ID
  • ID of the business that the lead's company belongs to.
Company Number of Employees
  • Number of employees in the lead's company.
  • Possible values (in left column): 1 = " 1-10" 11 = " 11-50" 51 = " 51-200201 = " 201-500" 501 = " 501-1000" 1001 = "1 001-5000" 5001 = " 5001-1000010001 = "10000+"
Company Annual Revenue
  • Annual revenue of the lead's company.
Company Website
  • Website of the lead's company.
Company Phone
  • Phone number of the lead's company.
Deal Name
  • Name of the lead's deal.
Deal Amount
  • Value of the lead's deal in dollars.
Deal Expected Close Date
  • The date when the deal is expected to close.
Deal Product ID
  • ID of the product that the lead's deal belongs to (in a multi-product company).
Created Date
  • Lead creation timestamp.
Updated Date
  • Lead updated timestamp.

Action - Update a Lead

Parameters

Parameter Description
Lead ID
Last Name
  • Last name of the lead.
First Name
  • First name of the lead.
Job Title
  • Designation of the lead in the company they belong to.
Department
  • The department that the lead belongs to.
Email
  • Primary email address of the lead.
Work Phone
  • Work phone number of the lead.
Mobile Phone
  • Mobile phone number of the lead.
Address
  • Address of the lead.
City
  • City that the lead belongs to.
State
  • State that the lead belongs to.
Zipcode
  • Zipcode of the region that the lead belongs to.
Country
  • Country that the lead belongs to.
Lead Stage ID
  • ID of the lead stage that the lead belongs to.
Lead Reason ID
  • ID of the lead reason: that is, reason to unqualify the lead.
  • Can be set only if the lead is in "Unqualified" stage.
Lead Source ID
  • ID of the source where lead came from.
Owner ID
  • ID of the user to whom the lead has been assigned.
Has Authority
  • Whether the lead has authority to take decisions regarding the purchase.
  • Possible values: true or false.
Do Not Disturb
  • Whether the lead has enabled do not disturb, or unsubscribed from your emails.
  • Possible values: true or false.
Medium
  • The medium that led your lead to your website or web app.
Campaign ID
  • The campaign that led your lead to your website or web app.
  • Must be an existing Campaign in Freshsales.
Keyword
  • The keywords that the lead used to reach your website or web app.
Timezone
  • Timezone that the lead belongs to.
Facebook Account
  • Facebook account of the lead.
Twitter Account
  • Twitter account of the lead.
Linkedin Account
  • LinkedIn account of the lead.
Territory ID
  • ID of the territory that the lead belongs to.
Company Name
  • Name of the company that the lead belongs to.
Company Address
  • Address of the company that the lead belongs to.
Company City
  • City that the lead's company belongs to.
Company State
  • State that the lead's company belongs to.
Company Zipcode
  • Zipcode of the region that the lead's company belongs to.
Company Country
  • Country that the lead's company belongs to.
Company Industry Type ID
  • ID of the industry that the lead's company belongs to.
Company Business Type ID
  • ID of the business that the lead's company belongs to.
Company Number of Employees
  • Number of employees in the lead's company.
  • Possible values (in left column): 1 = " 1-10" 11 = " 11-50" 51 = " 51-200201 = " 201-500" 501 = " 501-1000" 1001 = "1 001-5000" 5001 = " 5001-1000010001 = "10000+"
Company Annual Revenue
  • Annual revenue of the lead's company.
Company Website
  • Website of the lead's company.
Company Phone
  • Phone number of the lead's company.
Deal Name
  • Name of the lead's deal.
Deal Amount
  • Value of the lead's deal in dollars.
Deal Expected Close Date
  • The date when the deal is expected to close.
Deal Product ID
  • ID of the product that the lead's deal belongs to (in a multi-product company).
Created Date
  • Lead creation timestamp
Updated Date
  • Lead updated timestamp
Custom Fields
  • Map additional custom fields for the lead.
  • Custom fields must already exist in Freshsales.
  • You must also prepend cf_ to the field name.
  • For example, when mapping a value to a custom field called ' custom1', you must use ' cf_custom1' as the field name.

Action - Delete A Lead

Parameters

Parameter Description
Lead ID

Action - Create a Contact

Parameters

Parameter Description
Last Name
First Name
  • First name of the contact.
Job Title
  • Designation of the contact in the company they belong to.
Department
  • The department that the contact belongs to.
Email
  • Primary email address of the contact.
Work Phone
  • Work phone number of the contact.
Mobile Phone
  • Mobile phone number of the contact.
Address
  • Address of the contact.
City
  • City that the contact belongs to.
State
  • State that the contact belongs to.
Zipcode
  • Zipcode of the region that the contact belongs to.
Country
  • Country that the contact belongs to.
Sales Account ID
  • Existing Account ID that the contact belongs to.
New Account Name
  • New sales account to create and associate the contact to.
Territory ID
  • ID of the territory that the contact belongs to.
Lead Source ID
  • ID of the source where contact came from.
Owner ID
  • ID of the user to whom the contact has been assigned.
Has Authority
  • Whether the contact has authority to take decisions regarding the purchase. Possible values: true or false.
Do Not Disturb
  • Whether the contact has enabled do not disturb, or unsubscribed from your emails.
  • Possible values: true or false.
Medium
  • The medium that led your contact to your website or web app.
Campaign ID
  • The campaign that led your contact to your website or web app.
  • Must be an existing Campaign in Freshsales.
Keyword
  • The keywords that the contact used to reach your website or web app.
Timezone
  • Timezone that the contact belongs to.
Facebook Account
  • Facebook account of the contact.
Twitter Account
  • Twitter account of the contact.
Linkedin Account
  • LinkedIn account of the contact.
Created Date
  • Contact creation timestamp.
Updated Date
  • Contact updated timestamp.
Contact Status ID
  • ID of the contact status that the contact belongs to.
Custom Fields
  • Map additional custom fields for the contact.
  • Custom fields must already exist in Freshsales.
  • You must also prepend ' cf_' to the field name.
  • For example, when mapping a value to a custom field called ' custom1', you must use ' cf_custom1' as the field name.

Action - Update Contact

Parameters

Parameter Description
Contact ID
Last Name
  • Last name of the lead.
First Name
  • First name of the contact.
Job Title
  • Designation of the contact in the company they belong to.
Department
  • The department that the contact belongs to.
Email
  • Primary email address of the contact.
Work Phone
  • Work phone number of the contact.
Mobile Phone
  • Mobile phone number of the contact.
Address
  • Address of the contact.
City
  • City that the contact belongs to.
State
  • State that the contact belongs to.
Zipcode
  • Zipcode of the region that the contact belongs to.
Country
  • Country that the contact belongs to.
Sales Account ID
  • Existing Account ID that the contact belongs to.
Territory ID
  • ID of the territory that the contact belongs to.
Lead Source ID
  • ID of the source where contact came from
Owner ID
  • ID of the user to whom the contact has been assigned
Has Authority
  • Whether the contact has authority to take decisions regarding the purchase.
  • Possible values: true or false.
Do Not Disturb
  • Whether the contact has enabled do not disturb, or unsubscribed from your emails.
  • Possible values: true or false.
Medium
  • The medium that led your contact to your website or web app.
Campaign ID
  • The campaign that led your contact to your website or web app.
  • Must be an existing Campaign in Freshsales.
Keyword
  • The keywords that the contact used to reach your website or web app.
Timezone
  • Timezone that the contact belongs to.
Facebook Account
  • Facebook account of the contact.
Twitter Account
  • Twitter account of the contact.
Linkedin Account
  • LinkedIn account of the contact.
Created Date
  • Contact creation timestamp.
Updated Date
  • Contact updated timestamp.
Contact Status ID
  • ID of the contact status that the contact belongs to.
Custom Fields
  • Map additional custom fields for the contact.
  • Custom fields must already exist in Freshsales.
  • You must also prepend ' cf_' to the field name.
  • For example, when mapping a value to a custom field called ' custom1', you must use ' cf_custom1' as the field name.

Action - Delete a Contact

Parameters

Parameter Description
Contact ID

Action - Create an Account

Parameters

Parameter Description
Account Name
Address
  • Address of the account.
City
  • City that the account belongs to.
State
  • State that the account belongs to.
Zipcode
  • Zipcode of the region that the account belongs to.
Country
  • Country that the account belongs to.
Industry Type ID
  • ID of the industry that the account belongs to.
Business Type ID
  • ID of the business that the account belongs to.
Number of Employees
  • Number of employees in the account.
  • Possible values (in left column): 1 = " 1-10" 11 = " 11-50" 51 = " 51-200201 = " 201-500" 501 = " 501-1000" 1001 = "1 001-5000" 5001 = " 5001-1000010001 = "10000+"
Annual Revenue
  • Annual revenue of the account.
Website
  • Website of the account.
Phone Number
  • Phone number of the account.
Owner ID
  • ID of the user to whom the account has been assigned.
Facebook
  • Facebook account of the account.
Twitter
  • Twitter account of the account.
Linkedin
  • LinkedIn account of the account.
Territory ID
  • ID of the territory that the account belongs to.
Created Date
  • Account creation timestamp.
Updated Date
  • Account updated timestamp.
Parent Sales Account ID
  • Parent account ID of the account.
Custom Fields
  • Map additional custom fields for the account.
  • Custom fields must already exist in Freshsales.
  • ou must also prepend ' cf_' to the field name.
  • For example, when mapping a value to a custom field called ' custom1', you must use ' cf_custom1' as the field name.

Action - Update an Account

Parameters

Parameter Description
Account ID
Account Name
  • Name of the account.
Address
  • Address of the account.
City
  • City that the account belongs to.
State
  • State that the account belongs to.
Zipcode
  • Zipcode of the region that the account belongs to.
Country
  • Country that the account belongs to.
Industry Type ID
  • ID of the industry that the account belongs to.
Business Type ID
  • ID of the business that the account belongs to.
Number of Employees
  • Number of employees in the account.
  • Possible values (in left column): 1 = " 1-10" 11 = " 11-50" 51 = " 51-200201 = " 201-500" 501 = " 501-1000" 1001 = "1 001-5000" 5001 = " 5001-1000010001 = "10000+"
Annual Revenue
  • Annual revenue of the account.
Website
  • Website of the account.
Phone Number
  • Phone number of the account.
Owner ID
  • ID of the user to whom the account has been assigned.
Facebook
  • Facebook account of the account.
Twitter
  • Twitter account of the account.
Linkedin
  • LinkedIn account of the account.
Territory ID
  • ID of the territory that the account belongs to.
Created Date
  • Account creation timestamp.
Updated Date
  • Account updated timestamp.
Parent Sales Account ID
  • Parent account id of the account.
Custom Fields
  • Map additional custom fields for the account.
  • Custom fields must already exist in Freshsales.
  • You must also prepend ' cf_' to the field name.
  • For example, when mapping a value to a custom field called ' custom1', you must use ' cf_custom1' as the field name.

Action - Delete an Account

Parameters

Parameter Description
Account ID