Overview
Configuration is provided for establishing connections with Freshsales 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 the service resource.
Insert data
Use REST Destination component to insert data into service resource.
Quick Start
In this guide, we will show you step-by-step how to create a connection to Freshsales 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 Freshsales.
Step 3. Set [domain] to the desired domainin the Server host parameter. Then provide the value for APIKey parameter in the grid below.
Step 4. Click "Test Connection" to test your connection.
Congratulations! You have now established a connection to your Freshsales instance.
In this guide, we will show how to read data from the Freshsales 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 "SSIS Toolbox" and drag and drop COZYROC "REST Source" component.
Step 3. Double click on the REST Source component and select Freshsales connection from the combo. Select from available Freshsales 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 Freshsales 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 Freshsales service.
In this guide, we will show how to write data to the Freshsales 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 Freshsales connection from the combo. Also, select resource action and Freshsales 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 Freshsales resource.
Configuration
Base URL address: https://[domain].myfreshworks.com/crm/sales.
-
The authentication uses a parameters-based authentication.
The authentication has the following user-defined parameters:
- APIKey: Required. Specify API Key.
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Token token={{=connection.user.APIKey}}
Documentation: https://developers.freshworks.com/crm/api/#getting-started.
Based on resource template Base.
- [Read view] action
-
Endpoint URL address:
/contacts/view/{{=Freshsales.UI.ContactViewEditor.getValue(parameters)}}.
The result is extracted from:{{=response.contacts}}.
The result is paginated.The action has the following user-defined parameters:
- view_id: Required. Please select the view.
Documentation: https://developers.freshworks.com/crm/api/#list_all_contacts.
- [Read single] action
-
Endpoint URL address:
/contacts/{{=parameters.id}}.
The result is extracted from:{{=[response.contact]}}.
The result is paginated.The action has the following user-defined parameters:
- id: Required. Please specify the contact identifier.
Documentation: https://developers.freshworks.com/crm/api/#view_a_contact.
- [Read lookup] action
-
Endpoint URL address:
/lookup.
The result is extracted from:{{=response.contacts.contacts}}.The action has the following user-defined parameters:
- f: Required. Please select the field.
- q: Required. Please specify the query.
The following request parameters will be automatically processed:
-
entities:
contact -
f:
{{=Freshsales.UI.ContactFieldEditor.getValue(parameters)}}
- [Read list] action
-
Endpoint URL address:
/contacts/lists/{{=parameters.list_id}}.
The result is extracted from:{{=response.contacts}}.The action has the following user-defined parameters:
- list_id: Required. Please select the marketing list.
- [Create] action
-
Endpoint URL address:
/contacts.
The result is extracted from:{{=response.contact}}.Documentation: https://developers.freshworks.com/crm/api/#create_contact.
- [Update] action
-
Endpoint URL address:
/contacts/{{=item.id}}.Documentation: https://developers.freshworks.com/crm/api/#update_a_contact.
- [Delete] action
-
Endpoint URL address:
/contacts/{{=item.id}}.Documentation: https://developers.freshworks.com/crm/api/#delete_a_contact.
The resource includes the fields from the contactT template.
- document_associations
The value is gathered from
/contacts/{{=item.id}}/document_associationsaddress. The gathered value is processed with{{=response[field.name]}}expression. Field components:- Contains the following components: documents, document_links.
- activities
The value is gathered from
/contacts/{{=item.id}}/activitiesaddress. The gathered value is processed with{{=response.activities}}expression. Field components:- An array.
-
Uses template:
activitiesT.
- appointments
-
The value is gathered from
/contacts/{{=item.id}}/appointmentsaddress. The gathered value is processed with{{=response.appointments}}expression. Field components:- An array.
-
Uses template:
appointmentT.
Documentation: https://developers.freshworks.com/crm/api/#list_all_appointment.
- conversations
The value is gathered from
/contacts/{{=item.id}}/conversations/alladdress. The gathered value is processed with{{=response[field.name]}}expression. Field components:- Contains the following components: conversations, email_conversations, notes, email_conversation_recipients, phone_calls, deals, contacts, users.
- notes
The value is gathered from
/contacts/{{=item.id}}/notesaddress. The gathered value is processed with{{=response.notes}}expression. Field components:- An array.
-
Uses template:
notesT.
- tasks
The value is gathered from
/contacts/{{=item.id}}/tasksaddress. The gathered value is processed with{{=response.tasks}}expression. Field components:- An array.
-
Uses template:
taskT.
- timeline_feeds
The value is gathered from
/contacts/{{=item.id}}/timeline_feedsaddress. The gathered value is processed with{{=response.timeline_feeds}}expression. Field components:- An array.
-
Uses template:
activitiesT.
- [External]
-
The external fields URL address:
/settings/contacts/fields. The external fields list is extracted from:{{=Freshsales.getCustomFields(response.fields)}}.- custom.{{=external.label}}
Template: {{=Freshsales.getFieldTemplate(external.type)}}. The gathered value is processed with
{{=item.custom_field[field.external.name]}}expression.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/lists.
The result is extracted from:{{=response.lists}}.Documentation: https://developers.freshworks.com/crm/api/#fetch_all_lists.
- [Create] action
-
Endpoint URL address:
/lists.Documentation: https://developers.freshworks.com/crm/api/#create_list.
- [Update] action
-
Endpoint URL address:
/lists/{{=item.id}}.Documentation: https://developers.freshworks.com/crm/api/#update_a_list.
- [Delete] action
-
Endpoint URL address:
/lists/{{=item.id}}.Documentation: https://developers.freshworks.com/crm/api/#delete_a_list.
- id
A key field. Template: Id.
- name
Template: ShortText.
- contacts
The value is gathered from
/contacts/lists/{{=item.id}}address. The gathered value is processed with{{=response.contacts}}expression. Field components:- An array.
-
Uses template:
contactT.
Based on resource template Base.
- [Read view] action
-
Endpoint URL address:
/sales_accounts/view/{{=Freshsales.UI.AccountViewEditor.getValue(parameters)}}.
The result is extracted from:{{=response.sales_accounts}}.The action has the following user-defined parameters:
- view_id: Required. Please select the view.
Documentation: https://developers.freshworks.com/crm/api/#list_all_accounts.
- [Read single] action
-
Endpoint URL address:
/sales_accounts/{{=parameters.id}}.
The result is extracted from:{{=[response.sales_account]}}.
The result is paginated.The action has the following user-defined parameters:
- id: Required. Please specify the account identifier.
Documentation: https://developers.freshworks.com/crm/api/#view_account.
- [Read lookup] action
-
Endpoint URL address:
/lookup.
The result is extracted from:{{=response.sales_accounts.sales_accounts}}.The action has the following user-defined parameters:
- f: Required. Please select the field .
- q: Required. Please specify the query.
The following request parameters will be automatically processed:
-
entities:
sales_account -
f:
{{=Freshsales.UI.AccountFieldEditor.getValue(parameters)}}
- [Read contact] action
-
Endpoint URL address:
/contacts/{{=parameters.contact_id}}.
The result is extracted from:{{=response.contact.sales_accounts}}.
The result is paginated.The action has the following user-defined parameters:
- contact_id: Required. Please specify the contact identifier.
Documentation: https://developers.freshworks.com/crm/api/#view_a_contact.
- [Create] action
-
Endpoint URL address:
/sales_accounts.Documentation: https://developers.freshworks.com/crm/api/#create_account.
- [Update] action
-
Endpoint URL address:
/sales_accounts/{{=item.id}}.Documentation: https://developers.freshworks.com/crm/api/#update_a_account.
- [Delete] action
-
Endpoint URL address:
/sales_accounts/{{=item.id}}.Documentation: https://developers.freshworks.com/crm/api/#delete_account.
The resource includes the fields from the saleAccountT template.
- appointments
The value is gathered from
/sales_accounts/{{=item.id}}/appointmentsaddress. The gathered value is processed with{{=response.appointments}}expression. Field components:- An array.
-
Uses template:
appointmentT.
- conversations
The value is gathered from
/sales_accounts/{{=item.id}}/conversations/alladdress. The gathered value is processed with{{=response[field.name]}}expression. Field components:- Contains the following components: conversations, email_conversations, phone_calls, notes, outcomes, contacts, users, deals.
- document_associations
The value is gathered from
/sales_accounts/{{=item.id}}/document_associationsaddress. The gathered value is processed with{{=response.document_associations}}expression. Field components:- An array.
-
Uses template:
documentAssociationT.
- notes
The value is gathered from
/sales_accounts/{{=item.id}}/notesaddress. The gathered value is processed with{{=response.notes}}expression. Field components:- An array.
-
Uses template:
notesT.
- tasks
The value is gathered from
/sales_accounts/{{=item.id}}/tasksaddress. The gathered value is processed with{{=response.tasks}}expression. Field components:- An array.
-
Uses template:
taskT.
- [External]
-
The external fields URL address:
/settings/sales_accounts/fields. The external fields list is extracted from:{{=Freshsales.getCustomFields(response.fields)}}.- custom.{{=external.label}}
Template: {{=Freshsales.getFieldTemplate(external.type)}}. The gathered value is processed with
{{=item.custom_field[field.external.name]}}expression.
Based on resource template Base.
- [Read view] action
-
Endpoint URL address:
/deals/view/{{=Freshsales.UI.DealViewEditor.getValue(parameters)}}.
The result is extracted from:{{=response.deals}}.The action has the following user-defined parameters:
- view_id: Required. Please select the view.
Documentation: https://developers.freshworks.com/crm/api/#list_all_deals.
- [Read single] action
-
Endpoint URL address:
/deals/{{=parameters.id}}.
The result is extracted from:{{=[response.deal]}}.
The result is paginated.The action has the following user-defined parameters:
- id: Required. Please specify the deal identifier.
Documentation: https://developers.freshworks.com/crm/api/#view_a_deal.
- [Read lookup] action
-
Endpoint URL address:
/lookup.
The result is extracted from:{{=response.deals.deals}}.The action has the following user-defined parameters:
- f: Required. Please select the field.
- q: Required. Please specify the query.
The following request parameters will be automatically processed:
-
entities:
deal -
f:
{{=Freshsales.UI.DealFieldEditor.getValue(parameters)}}
- [Create] action
-
Endpoint URL address:
/deals.Documentation: https://developers.freshworks.com/crm/api/#create_deal.
- [Update] action
-
Endpoint URL address:
/deals/{{=item.id}}.The action has the following user-defined parameters:
- id: Required. Please specify the deal identifier.
Documentation: https://developers.freshworks.com/crm/api/#update_a_deal.
- [Delete] action
-
Endpoint URL address:
/deals/{{=item.id}}.Documentation: https://developers.freshworks.com/crm/api/#bulk_delete_deal.
- id
A key field. Template: Id.
- name
Template: ShortText.
- amount
Data type: DT_R8
- base_currency_amount
Data type: DT_R8
- expected_close
Template: ShortText.
- closed_date
Template: Date.
- stage_updated_time
Template: DateTime. A read-only field.
- custom_field
Template: LongText. A composite field.
- probability
Template: ShortText.
- updated_at
Template: DateTime. A read-only field.
- created_at
Template: DateTime. A read-only field.
- age
Template: ShortText.
- creater_id
Template: Id.
- model_class_name
Template: ShortText.
- user_id
Template: Id.
- is_default
Template: ShortText.
- is_public
Template: ShortText.
- links
Template: linksT.
- selected_ids
Template: LongText. An array field.
- appointments
The value is gathered from
/deals/{{=item.id}}/appointmentsaddress. The gathered value is processed with{{=response.appointments}}expression. Field components:- An array.
-
Uses template:
appointmentT.
- conversations
The value is gathered from
/deals/{{=item.id}}/conversations/alladdress. The gathered value is processed with{{=response[field.name]}}expression. Field components:- Contains the following components: conversations, email_conversations, phone_calls, notes, outcomes, contacts, deals, users.
- document_associations
The value is gathered from
/deals/{{=item.id}}/document_associationsaddress. The gathered value is processed with{{=response.document_associations}}expression. Field components:- An array.
-
Uses template:
documentAssociationT.
- notes
Template: notesT. An array field. The value is gathered from
/deals/{{=item.id}}/notesaddress. The gathered value is processed with{{=response.notes}}expression. Field components:- An array.
-
Uses template:
notesT.
- tasks
Template: taskT. An array field. The value is gathered from
/deals/{{=item.id}}/tasksaddress. The gathered value is processed with{{=response.tasks}}expression. Field components:- An array.
-
Uses template:
taskT.
- products
The value is gathered from
/deals/{{=item.id}}/productsaddress. The gathered value is processed with{{=response.product_list_items}}expression. Field components:- An array.
-
Uses template:
productT.
- action
Template: ShortText. Field components:
- Contains the following components: addProduct, updateProduct, deleteProduct.
- [External]
-
The external fields URL address:
/settings/deals/fields. The external fields list is extracted from:{{=Freshsales.getCustomFields(response.fields)}}.- custom.{{=external.label}}
Template: {{=Freshsales.getFieldTemplate(external.type)}}. The gathered value is processed with
{{=item.custom_field[field.external.name]}}expression.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/notes.Documentation: https://developers.freshworks.com/crm/api/#create_note.
- [Update] action
-
Endpoint URL address:
/notes/{{=item.id}}.Documentation: https://developers.freshworks.com/crm/api/#update_note.
- [Delete] action
-
Endpoint URL address:
/notes/{{=item.id}}.Documentation: https://developers.freshworks.com/crm/api/#delete_a_note.
- id
A key field. Template: Id.
- description
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- targetable_type
Template: ShortText.
- targetable_id
Template: Id.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/tasks.
The result is extracted from:{{=response.tasks}}.The action has the following user-defined parameters:
- filter: Required. Please select the filter.
Documentation: https://developers.freshworks.com/crm/api/#list_all_task.
- [Read single] action
-
Endpoint URL address:
/tasks/{{=parameters.id}}.
The result is extracted from:{{=[response.task]}}.
The result is paginated.The action has the following user-defined parameters:
- id: Required. Please specify the task identifier.
Documentation: https://developers.freshworks.com/crm/api/#view_task.
- [Read contact] action
-
Endpoint URL address:
/contacts/{{=parameters.contact_id}}/tasks.
The result is extracted from:{{=response.tasks}}.The action has the following user-defined parameters:
- contact_id: Required. Please specify the contact identifier.
Documentation: https://developers.freshworks.com/crm/api/#view_a_contact.
- [Read account] action
-
Endpoint URL address:
/sales_accounts/{{=parameters.account_id}}/tasks.
The result is extracted from:{{=response.tasks}}.The action has the following user-defined parameters:
- account_id: Required. Please specify the account identifier.
Documentation: https://developers.freshworks.com/crm/api/#view_account.
- [Read deal] action
-
Endpoint URL address:
/deals/{{=parameters.deal_id}}/tasks.
The result is extracted from:{{=response.tasks}}.The action has the following user-defined parameters:
- deal_id: Required. Please specify the account identifier.
Documentation: https://developers.freshworks.com/crm/api/#view_a_deal.
- [Create] action
-
Endpoint URL address:
/tasks.Documentation: https://developers.freshworks.com/crm/api/#create_task.
- [Update] action
-
Endpoint URL address:
/tasks/{{=item.id}}.Documentation: https://developers.freshworks.com/crm/api/#update_task.
- [Delete] action
-
Endpoint URL address:
/tasks/{{=item.id}}.Documentation: https://developers.freshworks.com/crm/api/#delete_task.
The resource includes the fields from the taskT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/appointments.
The result is extracted from:{{=response.appointments}}.The action has the following user-defined parameters:
- filter: Required. Please select the filter.
Documentation: https://developers.freshworks.com/crm/api/#list_all_appointment.
- [Read single] action
-
Endpoint URL address:
/appointments/{{=parameters.id}}.
The result is extracted from:{{=[response.appointment]}}.
The result is paginated.The action has the following user-defined parameters:
- id: Required. Please specify the appointment identifier.
Documentation: https://developers.freshworks.com/crm/api/#view_an_appointment.
- [Create] action
-
Endpoint URL address:
/appointments.Documentation: https://developers.freshworks.com/crm/api/#appointment_attributes.
- [Update] action
-
Endpoint URL address:
/appointments/{{=item.id}}.Documentation: https://developers.freshworks.com/crm/api/#update_an_appointment.
- [Delete] action
-
Endpoint URL address:
/appointments/{{=item.id}}.Documentation: https://developers.freshworks.com/crm/api/#delete_an_appointment.
- id
A key field. Template: Id.
- time_zone
Template: ShortText.
- title
Template: ShortText.
- description
Template: ShortText.
- location
Template: ShortText.
- from_date
Template: DateTime.
- end_date
Template: DateTime.
- creater_id
Template: Id.
- latitude
Template: ShortText.
- longitude
Template: ShortText.
- checkedin_at
Template: DateTime.
- targetable_type
Template: ShortText.
- targetable_id
Data type: DT_I8
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/sales_activities.
The result is extracted from:{{=response.sales_activities}}.Documentation: https://developers.freshworks.com/crm/api/#list_all_sales_activities.
- [Read single] action
-
Endpoint URL address:
/sales_activities/{{=parameters.id}}.
The result is extracted from:{{=[response.sales_activity]}}.
The result is paginated.The action has the following user-defined parameters:
- id: Required. Please specify the sales activity identifier.
Documentation: https://developers.freshworks.com/crm/api/#view_a_sales_activity.
- [Create] action
-
Endpoint URL address:
/sales_activities.Documentation: https://developers.freshworks.com/crm/api/#create_sales_activity.
- [Update] action
-
Endpoint URL address:
/sales_activities/{{=item.id}}.Documentation: https://developers.freshworks.com/crm/api/#update_a_sales_activity.
- [Delete] action
-
Endpoint URL address:
/sales_activities/{{=item.id}}.Documentation: https://developers.freshworks.com/crm/api/#delete_a_sales_activity.
- id
A key field. Template: Id.
- title
Template: ShortText.
- end_date
Template: DateTime.
- sales_activity_type_id
Template: Id.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- notes
Template: ShortText.
- owner_id
Template: Id.
- sales_activity_outcome_id
Template: Id.
- remote_id
Template: Id.
- import_id
Template: Id.
- creater_id
Template: Id.
- updater_id
Template: Id.
- conversation_time
Template: DateTime.
- targetable_id
Template: Id.
- targetable_type
Template: ShortText.
- latitude
Template: ShortText.
- longitude
Template: ShortText.
- location
Template: ShortText.
- quick_add_position
Data type: DT_I4
- visible
Data type: DT_BOOL
- [External]
-
The external fields URL address:
/settings/sales_activities/fields. The external fields list is extracted from:{{=Freshsales.getCustomFields(response.fields)}}.- custom.{{=external.label}}
Template: {{=Freshsales.getFieldTemplate(external.type)}}. The gathered value is processed with
{{=item.custom_field[field.external.name]}}expression.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/phone_calls.Documentation: https://developers.freshworks.com/crm/api/#manual_call_log.
- contacts
Field components:
- An array.
- Contains the following components: partial, id.
- phone_numbers
Template: LongText. A composite field.
- phone_callers
Template: LongText. A composite field.
- notes
Field components:
- An array.
- Contains the following components: id, description, created_at, updated_at, creater_id, targetable_id.
- user
Field components:
- An array.
- Contains the following components: id, display_name, email, is_active.
- targetables
Field components:
- An array.
- Contains the following components: id, display_name, email.
- phone_calls
Field components:
-
Uses template:
Id. - Contains the following components: id, call_duration, call_direction, recording_duration, status, recording, conversation_time, cost, is_manual, targetable, phone_number_id, phone_caller_id, note_id.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/cpq/products.
The result is extracted from:{{=response.products}}.
- [Read single] action
-
Endpoint URL address:
/cpq/products/{{=parameters.id}}.
The result is extracted from:{{=[response.product]}}.
The result is paginated.The action has the following user-defined parameters:
- id: Required. Please specify the product identifier.
Documentation: https://developers.freshworks.com/crm/api/#view_a_product.
- [Read document] action
-
Endpoint URL address:
/cpq/cpq_documents/{{=parameters.document_id}}.
The result is extracted from:{{=response.cpq_document.products}}.The action has the following user-defined parameters:
- document_id: Required. Please specify the document identifier.
Documentation: https://developers.freshworks.com/crm/api/#view_a_document.
- [Read deal] action
-
Endpoint URL address:
/deals/{{=parameters.deal_id}}/products.
The result is extracted from:{{=response.product_list_items}}.The action has the following user-defined parameters:
- deal_id: Required. Please specify the deal identifier.
- [Create] action
-
Endpoint URL address:
/cpq/products.Documentation: https://developers.freshworks.com/crm/api/#create_product.
- [Update] action
-
Endpoint URL address:
/cpq/products/{{=item.id}}.Documentation: https://developers.freshworks.com/crm/api/#update_a_product.
- [Delete] action
-
Endpoint URL address:
/cpq/products/{{=item.id}}.
The action uses POST method.Documentation: https://developers.freshworks.com/crm/api/#delete_a_product.
- id
A key field. Template: Id.
- name
Template: ShortText.
- category
Template: ShortText.
- product_code
Template: ShortText.
- sku_number
Template: ShortText.
- parent_product
Data type: DT_I4
- territory_id
Template: Id.
- valid_till
Template: ShortText.
- is_active
Data type: DT_BOOL
- owner_id
Template: Id.
- is_deleted
Data type: DT_BOOL
- created_at
Template: ShortText.
- updated_at
Template: ShortText.
- pricing_type
Data type: DT_I4
- product_pricings
Field components:
- An array.
- Contains the following components: id, currency_code, billing_cycle, billing_type, unit_price, setup_fee, is_locked.
- avatar
Template: ShortText.
- base_currency_amount
Template: ShortText.
- creater_id
Template: Id.
- custom_field
The gathered value is processed with
{{=Freshsales.getCustomValue(item.custom_field)}}expression. Field components:- An array.
- Contains the following components: name, value.
- updater_id
Template: Id.
- description
Template: ShortText.
- lookup_information
Template: LongText. A composite field.
- selected_ids
Template: LongText. An array field.
- action
Template: ShortText. Field components:
- Contains the following components: addPrice, updatePrice, deletePrice.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/cpq/cpq_documents.
The result is extracted from:{{=response.cpq_documents}}.
- [Read single] action
-
Endpoint URL address:
/cpq/cpq_documents/{{=parameters.id}}.
The result is extracted from:{{=[response.cpq_document]}}.The action has the following user-defined parameters:
- id: Required. Please specify the document identifier.
Documentation: https://developers.freshworks.com/crm/api/#view_a_document.
- [Create] action
-
Endpoint URL address:
/cpq/cpq_documents.Documentation: https://developers.freshworks.com/crm/api/#create_document.
- [Update] action
-
Endpoint URL address:
/cpq/cpq_documents/{{=item.id}}.Documentation: https://developers.freshworks.com/crm/api/#update_a_document.
- [Delete] action
-
Endpoint URL address:
/cpq/cpq_documents/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
Documentation: https://developers.freshworks.com/crm/api/#delete_a_document.
-
application/json:
- id
A key field. Template: Id.
- deal_id
Template: Id.
- contact_id
Template: Id.
- sales_account_id
Template: Id.
- document_type
Template: ShortText.
- stage
Template: ShortText.
- valid_till
Template: DateTime.
- shipping_address
Template: ShortText.
- shipping_city
Template: ShortText.
- shipping_state
Template: ShortText.
- shipping_zipcode
Template: ShortText.
- shipping_country
Template: ShortText.
- billing_address
Template: ShortText.
- billing_city
Template: ShortText.
- billing_state
Template: ShortText.
- billing_zipcode
Template: ShortText.
- billing_country
Template: ShortText.
- owner_id
Data type: DT_I4
- amount
Data type: DT_R8
- currency_code
Template: ShortText.
- base_currency_amount
Data type: DT_R8
- creater_id
Data type: DT_I4
- custom_field
The gathered value is processed with
{{=Freshsales.getCustomValue(item.custom_field)}}expression. Field components:- An array.
- Contains the following components: name, value.
- updater_id
Data type: DT_I4
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- is_deleted
Data type: DT_BOOL
- document_number
Template: ShortText.
- territory_id
Data type: DT_I4
- is_deal_primary
Data type: DT_BOOL
- products
Field components:
- An array.
-
Uses template:
productT.
- display_name
Template: ShortText.
- email_template_id
Template: ShortText.
- action
Template: ShortText. Field components:
- Contains the following components: restore, addProduct, updateProduct, deleteProduct.
Based on resource template Base.
- [Read contact] action
-
Endpoint URL address:
/contacts/{{=parameters.contact_id}}/document_associations.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- contact_id: Required. Please specify the contact identifier.
Documentation: https://developers.freshworks.com/crm/api/#list_files.
- [Read account] action
-
Endpoint URL address:
/sales_accounts/{{=parameters.account_id}}/document_associations.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- account_id: Required. Please specify the account identifier.
- [Read deal] action
-
Endpoint URL address:
/deals/{{=parameters.deal_id}}/document_associations.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- deal_id: Required. Please specify the deal identifier.
- [Create] action
-
Endpoint URL address:
/documents.The action has the following user-defined parameters:
- targetable_type: Required. Please specify Contact, SalesAccount, or Deal.
- targetable_id: Required. Please specify the identifier of the target.
- is_shared: Optional. Please specify true or false.
The following request parameters will be automatically processed:
-
application/json:
{{=undefined}} -
file:
{{=item.content}} -
targetable_type:
{{=parameters.targetable_type}} -
targetable_id:
{{=parameters.targetable_id}} -
is_shared:
{{=parameters.is_shared || undefined}}
Documentation: https://developers.freshworks.com/crm/api/#create_file.
- document_associations
Field components:
- An array.
-
Uses template:
documentAssociationT.
- documents
Field components:
- An array.
-
Uses template:
documentT.
- users
Field components:
- An array.
-
Uses template:
userT.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/document_links.Documentation: https://developers.freshworks.com/crm/api/#create_link.
- id
A key field. Template: Id.
- msg
Template: ShortText.
- url
Template: ShortText.
- targetable_type
Template: ShortText.
- targetable_id
Template: Id.
- name
Template: ShortText.
Based on resource template Base.
- [Read single] action
-
Endpoint URL address:
/job_statuses/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Please specify the job status identifier.
Documentation: https://developers.freshworks.com/crm/api/#job-status.
- status
Template: ShortText.
- job_type_name
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- status_updated_at
Template: DateTime. A read-only field.
- progress
Data type: DT_I4
- data
Field components:
- Contains the following components: record_status, detailed_failure_report.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/settings/{{=parameters.entity}}/fields.
The result is extracted from:{{=response.fields}}.The action has the following user-defined parameters:
- entity: Required. Please specify the entity for which you want to retrieve fields.
- id
Data type: DT_I4
- label
Template: ShortText.
- name
Template: ShortText.
- type
Template: ShortText.
- default
Data type: DT_BOOL
- actionable
Data type: DT_BOOL
- position
Data type: DT_I4
- base_model
Template: ShortText.
- required
Data type: DT_BOOL
- quick_add_position
Data type: DT_I4
- visible
Data type: DT_BOOL
- auto_suggest_url
Template: ShortText.
- creatable
Data type: DT_BOOL
- choices
Field components:
- An array.
-
Uses template:
choiceT.
- field_groups
The value is gathered from
/settings/{{=parameters.entity}}/fieldsaddress. The gathered value is processed with{{=response.field_groups}}expression. Field components:- An array.
- Contains the following components: id, label, name.
- creatable_data_key
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/{{=parameters.entity}}/filters.
The result is extracted from:{{=response.filters}}.The action has the following user-defined parameters:
- entity: Required. Please specify the entity.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- model_class_name
Template: ShortText.
- user_id
Data type: DT_I4
- is_default
Data type: DT_BOOL
- is_public
Data type: DT_BOOL
- updated_at
Template: DateTime. A read-only field.
- [Read] action
-
The result is paginated.The following request parameters will be automatically processed:
-
per_page:
{{=parameters.batchSize}} -
page:
{{=parameters.iterator}} -
_includeUserParameters:
{{=parameters}}
-
per_page:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=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
- Number
Data type: DT_R8
- Id
Data type: DT_I8
- CheckBox
Data type: DT_BOOL
- linksT
Field components:
-
Uses template:
ShortText. - Contains the following components: conversations, document_associations, notes, tasks, appointments, timeline_feeds, reminders, duplicates, connections.
-
Uses template:
- choiceT
Field components:
-
Uses template:
Id. - Contains the following components: id, value, position, choice_type, deal_pipeline_id, forecast_type.
-
Uses template:
- documentT
Field components:
-
Uses template:
Id. - Contains the following components: id, url, name, is_shared, content_file_size, content_content_type, content_updated_at, content_file_size_readable, created_at, is_attached, creater_id, content.
-
Uses template:
- documentAssociationT
Field components:
-
Uses template:
Id. - Contains the following components: id, msg, url, filename.
-
Uses template:
- activitiesT
Field components:
-
Uses template:
DateTime. - Contains the following components: action_data, additional_timeline_info, created_at, automation, group, targetable_id, targetable_name, targetable_type, id, composite_id, action_type, user_activity, actionable_id, actionable_type, action_type.
-
Uses template:
- appointmentT
Field components:
-
Uses template:
Id. - Contains the following components: id, time_zone, title, description, location, is_allday, outcome_id, from_date, end_date, created_at, updated_at, provider, creater_id, latitude, longitude, checkedin_at, can_checkin_checkout, checkedout_latitude, checkedout_longitude, checkedout_location, checkedout_at, checkedin_duration, can_checkin, conference_id, updater_id, targetable, appointment_attendee_ids, note_id.
-
Uses template:
- taskT
Field components:
-
Uses template:
Id. - Contains the following components: id, status, title, description, created_at, updated_at, owner_id, due_date, completed_date, creater_id, updater_id, outcome_id, task_type_id, targetable_type, targetable_id.
-
Uses template:
- conversationT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, targetable.
-
Uses template:
- conversationDealT
Field components:
-
Uses template:
Id. - Contains the following components: partial, id, name, has_access, deal_pipeline_id, deal_stage_id, amount, avatar, avatarContent, record_type_id.
-
Uses template:
- emailConversationT
Field components:
-
Uses template:
Id. - Contains the following components: id, direction, subject, display_content, html_content, current_html_content, is_read, count, email_id, status, needs_response, needs_tracking, template_id, unsubscribe, scheduled_at, attachments, conversation_time, shrink_content, conversation_meta, email_association, linked_deals, email_deal_association, email_conversation_recipient_ids.
-
Uses template:
- phoneCallT
Field components:
-
Uses template:
Id. - Contains the following components: id, call_duration, call_direction, recording_duration, status, recording, conversation_time, cost, is_manual, root_phone_call_id, child_phone_calls, outcome_id, source, freshcaller_id, freshcaller_number, freshcaller_number_country, targetable, phone_number_id, phone_caller_id, note_id, user_id.
-
Uses template:
- conversationNotesT
Field components:
-
Uses template:
Id. - Contains the following components: user_id, description, created_at, updated_at, url, duration, creater_id, has_access, collab_context, targetable.
-
Uses template:
- emailConversationRecipientT
Field components:
-
Uses template:
ShortText. - Contains the following components: field, email_address, email_name, bounced, opened, clicked, bounced_time, opened_time, clicked_time, destroy, is_user, do_not_disturb, targetable.
-
Uses template:
- documentAssociationT
Field components:
-
Uses template:
Id. - Contains the following components: id, url, name, is_shared, created_at, is_attached, creater_id.
-
Uses template:
- notesT
Field components:
-
Uses template:
Id. - Contains the following components: id, description, created_at, updated_at, url, duration, creater_id, has_access, collab_context.
-
Uses template:
- outcomeT
Field components:
-
Uses template:
Id. - Contains the following components: id, partial, name, sales_activity_type_id, position.
-
Uses template:
- saleAccountT
Field components:
-
Uses template:
Id. - Contains the following components: id, name, address, city, state, zipcode, country, number_of_employees, annual_revenue, website, phone, open_deals_amount, last_contacted, last_contacted_mode, facebook, twitter, linkedin, links, updated_at, open_deals_count, avatar, model_class_name, user_id, is_default, is_public, selected_ids.
-
Uses template:
- contactT
Field components:
-
Uses template:
Id. - Contains the following components: id, first_name, last_name, display_name, avatar, job_title, city, state, zipcode, country, email, time_zone, work_number, mobile_number, address, last_seen, lead_score, last_contacted, open_deals_amount, links, updated_at, keyword, medium, facebook, twitter, linkedin, emails, owner_id, model_class_name, user_id, is_default, is_public, selected_ids, composite_id, action_type, created_at, user_activity, targetable_type, targetable_id, actionable_type, actionable_id, targetable_name, partial, recent_note, sales_accounts.
-
Uses template:
- userT
Field components:
-
Uses template:
ShortText. - Contains the following components: partial, id, display_name, avatar, email, user_profile_attributes, uuid.
-
Uses template:
- productT
Field components:
-
Uses template:
Id. - Contains the following components: id, product_id, cpq_document_id, currency_code, billing_cycle, billing_type, unit_price, setup_fee, quantity, discount, item_id, name, pricing_type, avatar, owner_id.
-
Uses template:
Knowledge Base
What's New
- New: Introduced connection.
Related documentation
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.