Overview
A configuration is provided for establishing connections with the Copper 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 Copper REST API using COZYROC's REST Connection Manager.
Step 1. You have to generate an API key to connect to the service. Please review the instructions posted here on how to generate the key.
Step 2. 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 3. From the drop-down menu Configuration select Copper. Enter the Copper API key you have acquired and also enter the associated email address.
Step 4. Click "Test Connection" to test your connection.
Congratulations! You have now established a connection to your Copper instance.
In this guide, we will show how to read data from the Copper 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 Copper connection from the combo. Select from available Copper 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 Copper 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 Copper service.
In this guide, we will show how to write data to the Copper 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 Copper connection from the combo. Also, select resource action and Copper 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 Copper resource.
Configuration
Base URL address: https://api.prosperworks.com/developer_api/v1.
-
The authentication uses a parameters-based authentication.
The authentication has the following user-defined parameters:
- Email:
- APIKey:
The following request parameters will be automatically processed during the authentication process:
-
X-PW-UserEmail:
{{=connection.user.Email}} -
X-PW-AccessToken:
{{=connection.user.APIKey}} -
X-PW-Application:
developer_api
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/users/search.Documentation: https://developer.copper.com/account-and-users/list-users.html.
- id
A key field. Template: Id.
- name
Template: ShortText.
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/leads/search.Documentation: https://developer.copper.com/leads/list-leads-search.html.
- [Create] action
-
Endpoint URL address:
/leads.Documentation: https://developer.copper.com/leads/create-a-new-lead.html.
- [Update] action
-
Endpoint URL address:
/leads/{{=item.id}}.Documentation: https://developer.copper.com/leads/update-a-lead.html.
- [Upsert] action
-
Endpoint URL address:
/leads/upsert.
The action uses PUT method.The action has the following user-defined parameters:
- Match: Specifies match field.
The following request parameters will be automatically processed:
-
application/json:
{{={ properties: item, match: { field_name: parameters.Match, field_value: item[parameters.Match] } } }}
Documentation: https://developer.copper.com/leads/upsert-a-lead.html.
- [Delete] action
-
Endpoint URL address:
/leads/{{=item.id}}.Documentation: https://developer.copper.com/leads/delete-a-lead.html.
- id
A key field. Template: Id.
- name
Template: ShortText.
- prefix
Template: ShortText.
- first_name
Template: ShortText.
- last_name
Template: ShortText.
- middle_name
Template: ShortText.
- suffix
Template: ShortText.
- address
Template: Address.
- assignee_id
Template: Id.
- company_name
Template: ShortText.
- customer_source_id
Template: Id.
- details
Template: LongText.
Field components:
-
Uses template:
ShortText. - Contains the following components: email, category.
-
Uses template:
- interaction_count
Data type: DT_I4
- monetary_unit
Template: ShortText.
- monetary_value
Data type: DT_R8
- converted_unit
Template: ShortText.
- converted_value
Data type: DT_R8
- socials
Template: UrlList.
- status
Template: ShortText.
- status_id
Template: Id.
- tags
Template: LongText. A composite field.
- title
Template: ShortText.
- websites
Template: UrlList.
- phone_numbers
Template: PhoneList.
- date_created
Template: UnixTime. A read-only field.
- date_modified
Template: UnixTime. A read-only field.
- date_last_contacted
Template: UnixTime. A read-only field.
- converted_opportunity_id
Template: Id.
- converted_at
Template: UnixTime. A read-only field.
- [External]
-
The external fields URL address:
/custom_field_definitions. The external fields list is extracted from:{{=_.filter(response, function(item) { return _.contains(item.available_on, 'lead'); })}}.- custom.{{=external.name}}
Data type: {{=Copper.getDataType(external.data_type)}} ( length 255 ) The gathered value is processed with
{{=item[field.external.id]}}expression. Before setting, the value is processed with{{=value && { custom_field_definition_id: field.external.id, value: value } }}expression.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/people/search.Documentation: https://developer.copper.com/people/list-people-search.html.
- [Create] action
-
Endpoint URL address:
/people.Documentation: https://developer.copper.com/people/create-a-new-person.html.
- [Update] action
-
Endpoint URL address:
/people/{{=item.id}}.Documentation: https://developer.copper.com/people/update-a-person.html.
- [Delete] action
-
Endpoint URL address:
/people/{{=item.id}}.Documentation: https://developer.copper.com/people/delete-a-person.html.
- id
A key field. Template: Id.
- name
Template: ShortText.
- prefix
Template: ShortText.
- first_name
Template: ShortText.
- middle_name
Template: ShortText.
- last_name
Template: ShortText.
- suffix
Template: ShortText.
- address
Template: Address.
- assignee_id
Template: Id.
- company_id
Template: Id.
- company_name
Template: ShortText.
- contact_type_id
Template: Id.
- details
Template: LongText.
- emails
Template: EmailList.
- phone_numbers
Template: PhoneList.
- socials
Template: UrlList.
- tags
Template: LongText. A composite field.
- title
Template: ShortText.
- websites
Template: UrlList.
- date_created
Template: UnixTime. A read-only field.
- date_modified
Template: UnixTime. A read-only field.
- date_last_contacted
Template: UnixTime.
- interaction_count
Data type: DT_I4
- leads_converted_from
Template: LongText. A composite field.
- date_lead_created
Template: UnixTime.
- [External]
-
The external fields URL address:
/custom_field_definitions. The external fields list is extracted from:{{=_.filter(response, function(item) { return _.contains(item.available_on, 'person'); })}}.- custom.{{=external.name}}
Data type: {{=Copper.getDataType(external.data_type)}} ( length 255 ) The gathered value is processed with
{{=item[field.external.id]}}expression. Before setting, the value is processed with{{=value && { custom_field_definition_id: field.external.id, value: value } }}expression.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/companies/search.Documentation: https://developer.copper.com/companies/list-companies-search.html.
- [Create] action
-
Endpoint URL address:
/companies.Documentation: https://developer.copper.com/companies/create-a-new-company.html.
- [Update] action
-
Endpoint URL address:
/companies/{{=item.id}}.Documentation: https://developer.copper.com/companies/update-a-company.html.
- [Delete] action
-
Endpoint URL address:
/companies/{{=item.id}}.Documentation: https://developer.copper.com/companies/delete-a-company.html.
- id
A key field. Template: Id.
- name
Template: ShortText.
- address
Template: Address.
- assignee_id
Template: Id.
- contact_type_id
Template: Id.
- details
Template: LongText.
- email_domain
Template: ShortText.
- phone_numbers
Template: PhoneList.
- socials
Template: UrlList.
- tags
Template: LongText. A composite field.
- websites
Template: UrlList.
- interaction_count
Data type: DT_I4
- date_created
Template: UnixTime. A read-only field.
- date_modified
Template: UnixTime. A read-only field.
- [External]
-
The external fields URL address:
/custom_field_definitions. The external fields list is extracted from:{{=_.filter(response, function(item) { return _.contains(item.available_on, 'company'); })}}.- custom.{{=external.name}}
Data type: {{=Copper.getDataType(external.data_type)}} ( length 255 ) The gathered value is processed with
{{=item[field.external.id]}}expression. Before setting, the value is processed with{{=value && { custom_field_definition_id: field.external.id, value: value } }}expression.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/opportunities/search.Documentation: https://developer.copper.com/opportunities/list-opportunities-search.html.
- [Create] action
-
Endpoint URL address:
/opportunities.Documentation: https://developer.copper.com/opportunities/create-a-new-opportunity.html.
- [Update] action
-
Endpoint URL address:
/opportunities/{{=item.id}}.Documentation: https://developer.copper.com/opportunities/update-an-opportunity.html.
- [Delete] action
-
Endpoint URL address:
/opportunities/{{=item.id}}.Documentation: https://developer.copper.com/opportunities/delete-an-opportunity.html.
- id
A key field. Template: Id.
- name
Template: ShortText.
- assignee_id
Template: Id.
- close_date
Template: DateTime.
- company_id
Template: Id.
- company_name
Template: ShortText.
- customer_source_id
Template: Id.
- details
Template: LongText.
- loss_reason_id
Template: Id.
- pipeline_id
Template: Id.
- pipeline_stage_id
Template: Id.
- primary_contact_id
Template: Id.
- priority
Template: ShortText.
- status
Template: ShortText.
- tags
Template: LongText. A composite field.
- interaction_count
Data type: DT_I4
- monetary_value
Data type: DT_R8
- win_probability
Data type: DT_R8
- date_last_contacted
Template: UnixTime.
- leads_converted_from
Template: LongText. A composite field.
- date_lead_created
Template: UnixTime. A read-only field.
- date_created
Template: UnixTime. A read-only field.
- date_modified
Template: UnixTime. A read-only field.
- [External]
-
The external fields URL address:
/custom_field_definitions. The external fields list is extracted from:{{=_.filter(response, function(item) { return _.contains(item.available_on, 'opportunity'); })}}.- custom.{{=external.name}}
Data type: {{=Copper.getDataType(external.data_type)}} ( length 255 ) The gathered value is processed with
{{=item[field.external.id]}}expression. Before setting, the value is processed with{{=value && { custom_field_definition_id: field.external.id, value: value } }}expression.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/projects/search.Documentation: https://developer.copper.com/projects/list-projects-search.html.
- [Create] action
-
Endpoint URL address:
/projects.Documentation: https://developer.copper.com/projects/create-a-new-project.html.
- [Update] action
-
Endpoint URL address:
/projects/{{=item.id}}.Documentation: https://developer.copper.com/projects/update-a-project.html.
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.id}}.Documentation: https://developer.copper.com/projects/delete-a-project.html.
- id
A key field. Template: Id.
- name
Template: ShortText.
- related_resource
Template: Resource.
- assignee_id
Template: Id.
- status
Template: ShortText.
- details
Template: LongText.
- tags
Template: LongText. A composite field.
- date_created
Template: UnixTime. A read-only field.
- date_modified
Template: UnixTime. A read-only field.
- [External]
-
The external fields URL address:
/custom_field_definitions. The external fields list is extracted from:{{=_.filter(response, function(item) { return _.contains(item.available_on, 'project'); })}}.- custom.{{=external.name}}
Data type: {{=Copper.getDataType(external.data_type)}} ( length 255 ) The gathered value is processed with
{{=item[field.external.id]}}expression. Before setting, the value is processed with{{=value && { custom_field_definition_id: field.external.id, value: value } }}expression.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/tasks/search.Documentation: https://developer.copper.com/tasks/list-tasks-search.html.
- [Create] action
-
Endpoint URL address:
/tasks.Documentation: https://developer.copper.com/tasks/create-a-new-task.html.
- [Update] action
-
Endpoint URL address:
/tasks/{{=item.id}}.Documentation: https://developer.copper.com/tasks/update-a-task.html.
- [Delete] action
-
Endpoint URL address:
/tasks/{{=item.id}}.Documentation: https://developer.copper.com/tasks/delete-a-task.html.
- id
A key field. Template: Id.
- name
Template: ShortText.
- related_resource
Template: Resource.
- assignee_id
Template: Id.
- due_date
Template: DateTime.
- reminder_date
Template: DateTime.
- completed_date
Template: DateTime.
- priority
Template: ShortText.
- status
Template: ShortText.
- details
Template: LongText.
- tags
Template: LongText. A composite field.
- date_created
Template: UnixTime. A read-only field.
- date_modified
Template: UnixTime. A read-only field.
- [External]
-
The external fields URL address:
/custom_field_definitions. The external fields list is extracted from:{{=_.filter(response, function(item) { return _.contains(item.available_on, 'task'); })}}.- custom.{{=external.name}}
Data type: {{=Copper.getDataType(external.data_type)}} ( length 255 ) The gathered value is processed with
{{=item[field.external.id]}}expression. Before setting, the value is processed with{{=value && { custom_field_definition_id: field.external.id, value: value } }}expression.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/activities/search.Documentation: https://developer.copper.com/activities/list-activities-search.html.
- [Create] action
-
Endpoint URL address:
/activities.Documentation: https://developer.copper.com/activities/create-a-new-activity.html.
- [Delete] action
-
Endpoint URL address:
/activities/{{=item.id}}.Documentation: https://developer.copper.com/activities/delete-an-activity.html.
- id
A key field. Template: Id.
- parent
Template: Resource.
- type
Field components:
-
Uses template:
Id. - Contains the following components: id, category.
-
Uses template:
- user_id
Template: Id.
- details
Template: LongText.
- activity_date
Template: UnixTime.
- old_value
Template: ShortText.
- new_value
Template: ShortText.
- date_created
Template: UnixTime. A read-only field.
- date_modified
Template: UnixTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/webhooks.Documentation: https://developer.copper.com/webhooks/list-all-subscriptions.html.
- [Create] action
-
Endpoint URL address:
/webhooks.Documentation: https://developer.copper.com/webhooks/create-new-subscription.html.
- [Delete] action
-
Endpoint URL address:
/webhooks/{{=item.id}}.Documentation: https://developer.copper.com/webhooks/delete-subscription-unsubscribe.html.
- id
A key field. Template: Id.
- target
Template: ShortText.
- type
Template: ShortText.
- event
Template: ShortText.
- secret
Field components:
-
Uses template:
ShortText. - Contains the following components: secret, key.
-
Uses template:
- created_at
Template: UnixTime. A read-only field.
- [Read] action
-
The action uses POST method.
The result is paginated.The following request parameters will be automatically processed:
-
application/json:
{{=_.extend({ page_number: parameters.iterator, page_size: parameters.batchSize }, parameters)}}
-
application/json:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
application/json:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
application/json:
- [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
- Id
Data type: DT_I8
- UnixTime
Data type: DT_DBTIMESTAMP The gathered value is processed with
{{=value && new Date(value * 1000).toUTCString()}}expression.- UrlList
Field components:
- An array.
- Contains the following components: url, category.
- EmailList
Field components:
- An array.
- Contains the following components: email, category.
- PhoneList
Field components:
- An array.
- Contains the following components: number, category.
- Address
Field components:
-
Uses template:
ShortText. - Contains the following components: street, city, state, postal_code, country.
-
Uses template:
- Resource
Field components:
-
Uses template:
Id. - Contains the following components: id, type.
-
Uses template:
What's New
- New: Configure array for parameters with suffix _ids.
- 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.