Overview
A configuration is provided for establishing connections with the Close 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 Close 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.
Congratulations! You have now established a connection to your Close instance.
In this guide, we will show how to read data from the Close service resource using the COZYROC REST Source component.
In this guide, we will show how to write data to the Close service resource using the COZYROC REST Destination component.
Configuration
Base URL address: https://api.close.com/api/v1
.
- Basic
-
The authentication uses a parameters-based authentication.
The authentication has the following user-defined parameters:
- APIKey:
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Basic {{=Base64.encode(connection.user.APIKey + ':')}}
Documentation: https://en.wikipedia.org/wiki/Basic_access_authentication.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/lead/
.Documentation: https://developer.close.com/#leads-list-or-search-for-leads.
- [Create] action
-
Endpoint URL address:
/lead/
.Documentation: https://developer.close.com/#leads-create-a-new-lead.
- [Update] action
-
Endpoint URL address:
/lead/{{=item.id}}/
.Documentation: https://developer.close.com/#leads-update-an-existing-lead.
- [Delete] action
-
Endpoint URL address:
/lead/{{=item.id}}/
.Documentation: https://developer.close.com/#leads-delete-a-lead.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- status_id
Template: ShortText.
- status_label
Template: ShortText.
- tasks
Template: LongText. A composite field.
- display_name
Template: ShortText.
- addresses
Field components:
- An array.
-
Uses template:
Address
.
- contacts
Field components:
- An array.
-
Uses template:
Contact
.
- description
Template: LongText.
- html_url
Template: ShortText.
- organization_id
Template: ShortText.
- url
Template: ShortText.
- opportunities
Field components:
- An array.
-
Uses template:
Opportunity
.
- created_by
Template: ShortText.
- date_created
Template: DateTime. A read-only field.
- updated_by
Template: ShortText.
- date_updated
Template: DateTime.
- [External]
-
The external fields URL address:
/custom_fields/lead/
. The external fields list is extracted from:{{=response.data}}
.- custom.{{=external.name}}
Data type: {{=Close.getDataType(external.type)}} ( length 255 )
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/contact/
.Documentation: https://developer.close.com/#contacts-list-contacts.
- [Create] action
-
Endpoint URL address:
/contact/
.Documentation: https://developer.close.com/#contacts-create-a-new-contact.
- [Update] action
-
Endpoint URL address:
/contact/{{=item.id}}/
.Documentation: https://developer.close.com/#contacts-update-an-existing-contact.
- [Delete] action
-
Endpoint URL address:
/contact/{{=item.id}}/
.Documentation: https://developer.close.com/#contacts-delete-a-contact.
The resource includes the fields from the Contact template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/activity/
.Documentation: https://developer.close.com/#activities-list-or-filter-all-activity-types.
- [Read created] action
-
Endpoint URL address:
/activity/created/
.Documentation: https://developer.close.com/#activities-list-or-filter-all-created-activities.
- [Read note] action
-
Endpoint URL address:
/activity/note/
.Documentation: https://developer.close.com/#activities-list-or-filter-all-note-activities.
- [Read emailthread] action
-
Endpoint URL address:
/activity/emailthread/
.Documentation: https://developer.close.com/#activities-list-or-filter-all-emailthread-activities.
- [Read email] action
-
Endpoint URL address:
/activity/email/
.Documentation: https://developer.close.com/#activities-list-or-filter-all-email-activities.
- [Read sms] action
-
Endpoint URL address:
/activity/sms/
.Documentation: https://developer.close.com/#activities-list-or-filter-all-sms-activities.
- [Read call] action
-
Endpoint URL address:
/activity/call/
.Documentation: https://developer.close.com/#activities-list-or-filter-all-call-activities.
- [Read meeting] action
-
Endpoint URL address:
/activity/meeting/
.Documentation: https://developer.close.com/#activities-list-or-filter-all-meeting-activities.
- [Read lead_status_change] action
-
Endpoint URL address:
/activity/status_change/lead/
.Documentation: https://developer.close.com/#activities-list-or-filter-all-leadstatuschange-activities.
- [Read opportunity_status_change] action
-
Endpoint URL address:
/activity/status_change/opportunity/
.Documentation: https://developer.close.com/#activities-list-or-filter-all-opportunitystatuschange-activities.
- [Read task_completed] action
-
Endpoint URL address:
/activity/task_completed/
.Documentation: https://developer.close.com/#activities-list-or-filter-all-taskcompleted-activities.
- [Create] action
-
Endpoint URL address:
/activity/{{=item._type}}/
.
- [Update] action
-
Endpoint URL address:
/activity/{{=item._type}}/{{=item.id}}/
.
- [Delete] action
-
Endpoint URL address:
/activity/{{=item._type}}/{{=item.id}}/
.
- id
A key field. Template: ShortText.
- _type
Template: ShortText.
- user_id
Template: ShortText.
- user_name
Template: ShortText.
- organization_id
Template: ShortText.
- source
Template: ShortText.
- contact_id
Template: ShortText.
- lead_id
Template: ShortText.
- import_id
Template: ShortText.
- users
Template: LongText. A composite field.
- note
Template: LongText.
- latest_normalized_subject
Template: ShortText.
- n_emails
Data type: DT_I4
- participants
Field components:
- An array.
-
Uses template:
EmailAddress
.
- emails
Field components:
- An array.
-
Uses template:
Email
.
- status
Template: ShortText.
- sender
Template: ShortText.
- subject
Template: ShortText.
- to
Template: LongText. A composite field.
- cc
Template: LongText. A composite field.
- bcc
Template: LongText. A composite field.
- direction
Template: ShortText.
- envelope
Template: Envelope.
- opens
Template: LongText. A composite field.
- send_attempts
Template: LongText. A composite field.
- template_id
Template: ShortText.
- attachments
Field components:
- An array.
-
Uses template:
Attachment
.
- sequence_subscription_id
Template: ShortText.
- sequence_id
Template: ShortText.
- sequence_name
Template: ShortText.
- cost
Template: ShortText.
- local_phone
Template: ShortText.
- local_phone_formatted
Template: ShortText.
- local_country_iso
Template: ShortText.
- remote_phone
Template: ShortText.
- remote_phone_formatted
Template: ShortText.
- remote_country_iso
Template: ShortText.
- text
Template: ShortText.
- voicemail_url
Template: ShortText.
- recording_url
Template: ShortText.
- voicemail_duration
Template: ShortText.
- disposition
Template: ShortText.
- phone
Template: ShortText.
- duration
Data type: DT_I4
- call_method
Template: ShortText.
- dialer_id
Template: ShortText.
- dialer_saved_search_id
Template: ShortText.
- attendees
Field components:
- An array.
- Contains the following components: status, user_id, name, contact_id, is_organizer, email.
- title
Template: ShortText.
- calendar_event_link
Template: ShortText.
- location
Template: ShortText.
- ends_at
Template: DateTime.
- connected_account_id
Template: ShortText.
- is_recurring
Data type: DT_BOOL
- starts_at
Template: DateTime.
- new_status_id
Template: ShortText.
- new_status_label
Template: ShortText.
- old_status_id
Template: ShortText.
- old_status_label
Template: ShortText.
- new_status_type
Template: ShortText.
- new_pipeline_id
Template: ShortText.
- old_status_type
Template: ShortText.
- opportunity_date_won
Template: DateTime.
- opportunity_id
Template: ShortText.
- opportunity_value
Data type: DT_R8
- opportunity_value_formatted
Template: ShortText.
- opportunity_value_currency
Template: ShortText.
- task_id
Template: ShortText.
- task_text
Template: ShortText.
- created_by
Template: ShortText. A read-only field.
- created_by_name
Template: ShortText. A read-only field.
- date_created
Template: DateTime. A read-only field.
- updated_by
Template: ShortText. A read-only field.
- updated_by_name
Template: ShortText. A read-only field.
- date_updated
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/opportunity/
.Documentation: https://developer.close.com/#opportunities-list-or-filter-opportunities.
- [Create] action
-
Endpoint URL address:
/opportunity/
.Documentation: https://developer.close.com/#opportunities-create-an-opportunity.
- [Update] action
-
Endpoint URL address:
/opportunity/{{=item.id}}/
.Documentation: https://developer.close.com/#opportunities-update-an-opportunity.
- [Delete] action
-
Endpoint URL address:
/opportunity/{{=item.id}}/
.Documentation: https://developer.close.com/#opportunities-delete-an-opportunity.
The resource includes the fields from the Opportunity template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/task/
.Documentation: https://developer.close.com/#tasks-list-or-filter-tasks.
- [Create] action
-
Endpoint URL address:
/task/
.Documentation: https://developer.close.com/#tasks-create-a-task.
- [Update] action
-
Endpoint URL address:
/task/{{=item.id}}/
.Documentation: https://developer.close.com/#tasks-update-a-task.
- [Delete] action
-
Endpoint URL address:
/task/{{=item.id}}/
.Documentation: https://developer.close.com/#tasks-delete-a-task.
The resource includes the fields from the Task template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/user/
.Documentation: https://developer.close.com/#users-list-all-the-users-who-are-members-of-the-same-organizations-as-you-are.
- id
A key field. Template: ShortText.
Template: ShortText.
- first_name
Template: ShortText.
- last_name
Template: ShortText.
- image
Template: ShortText.
- organizations
Template: LongText. A composite field.
- date_created
Template: DateTime. A composite field.
- date_updated
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/role/
.Documentation: https://developer.close.com/#roles-list-all-the-roles-defined-for-your-organization.
- [Create] action
-
Endpoint URL address:
/role/
.Documentation: https://developer.close.com/#roles-create-a-new-role.
- [Update] action
-
Endpoint URL address:
/role/{{=item.id}}/
.Documentation: https://developer.close.com/#roles-update-existing-role.
- [Delete] action
-
Endpoint URL address:
/role/{{=item.id}}/
.Documentation: https://developer.close.com/#roles-delete-a-role.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- editable
Data type: DT_BOOL
- permissions
Template: LongText. A composite field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/pipeline/
.Documentation: https://developer.close.com/#pipelines-list-pipelines-for-your-organization.
- [Create] action
-
Endpoint URL address:
/pipeline/
.Documentation: https://developer.close.com/#pipelines-create-a-pipeline.
- [Update] action
-
Endpoint URL address:
/pipeline/{{=item.id}}/
.Documentation: https://developer.close.com/#pipelines-update-a-pipeline.
- [Delete] action
-
Endpoint URL address:
/pipeline/{{=item.id}}/
.Documentation: https://developer.close.com/#pipelines-delete-a-pipeline.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- statuses
Field components:
- An array.
- Contains the following components: id, label, type.
- organization_id
Template: ShortText.
- created_by
Template: ShortText. A read-only field.
- date_created
Template: DateTime. A read-only field.
- updated_by
Template: ShortText. A read-only field.
- date_updated
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/email_template/
.Documentation: https://developer.close.com/#email-templates-list-email-templates.
- [Create] action
-
Endpoint URL address:
/email_template/
.Documentation: https://developer.close.com/#email-templates-create-an-email-template.
- [Update] action
-
Endpoint URL address:
/email_template/{{=item.id}}/
.Documentation: https://developer.close.com/#email-templates-update-an-email-template.
- [Delete] action
-
Endpoint URL address:
/email_template/{{=item.id}}/
.Documentation: https://developer.close.com/#email-templates-delete-an-email-template.
- id
A key field. Template: ShortText.
- organization_id
Template: ShortText.
- name
Template: ShortText.
- subject
Template: ShortText.
- body
Template: LongText.
- is_shared
Data type: DT_BOOL
- attachments
Field components:
- An array.
-
Uses template:
Attachment
.
- is_archived
Data type: DT_BOOL
- created_by
Template: ShortText. A read-only field.
- date_created
Template: DateTime. A read-only field.
- updated_by
Template: ShortText. A read-only field.
- date_updated
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/sequence/
.Documentation: https://developer.close.com/#email-sequences-list-sequences.
- [Create] action
-
Endpoint URL address:
/sequence/
.Documentation: https://developer.close.com/#email-sequences-create-an-email-sequence.
- [Update] action
-
Endpoint URL address:
/sequence/{{=item.id}}/
.Documentation: https://developer.close.com/#email-sequences-update-an-email-sequence.
- [Delete] action
-
Endpoint URL address:
/sequence/{{=item.id}}/
.Documentation: https://developer.close.com/#email-sequences-delete-an-email-sequence.
- id
A key field. Template: ShortText.
- organization_id
Template: ShortText.
- name
Template: ShortText.
- status
Template: ShortText.
- schedule_id
Template: ShortText.
- timezone
Template: ShortText.
- steps
Field components:
- An array.
- Contains the following components: id, delay, email_template_id, threading, created_by_id, date_created, updated_by_id, date_updated.
- created_by_id
Template: ShortText. A read-only field.
- date_created
Template: DateTime. A read-only field.
- updated_by_id
Template: ShortText. A read-only field.
- date_updated
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/dialer/
.Documentation: https://developer.close.com/#dialer-list-or-filter-all-dialer-sessions.
- id
A key field. Template: ShortText.
- type
Template: ShortText.
- status
Template: ShortText.
- user_id
Template: ShortText.
- users
Field components:
- An array.
- Contains the following components: is_active, state, user_id.
- saved_search_id
Template: ShortText.
- caller_id
Template: ShortText.
- organization_id
Template: ShortText.
- ring_mode
Template: ShortText.
- saved_search_is_user_dependent
Data type: DT_BOOL
- music_preference
Template: ShortText.
- date_created
Template: DateTime. A read-only field.
- date_updated
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/saved_search/
.Documentation: https://developer.close.com/#smart-views-list-smart-views.
- [Create] action
-
Endpoint URL address:
/saved_search/
.Documentation: https://developer.close.com/#smart-views-create-a-smart-view.
- [Update] action
-
Endpoint URL address:
/saved_search/{{=item.id}}/
.Documentation: https://developer.close.com/#smart-views-update-a-smart-view.
- [Delete] action
-
Endpoint URL address:
/saved_search/{{=item.id}}
.Documentation: https://developer.close.com/#smart-views-delete-a-smart-view.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- user_id
Template: ShortText.
- is_shared
Data type: DT_BOOL
- used_recently
Data type: DT_BOOL
- organization_id
Template: ShortText.
- query
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/integration_link/
.Documentation: https://developer.close.com/#integration-links-get-all-integration-links-for-your-organization.
- [Create] action
-
Endpoint URL address:
/integration_link/
.Documentation: https://developer.close.com/#integration-links-create-an-integration-link.
- [Update] action
-
Endpoint URL address:
/integration_link/{{=item.id}}/
.Documentation: https://developer.close.com/#integration-links-update-an-integration-link.
- [Delete] action
-
Endpoint URL address:
/integration_link/{{=item.id}}/
.Documentation: https://developer.close.com/#integration-links-delete-an-integration-link.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- type
Template: ShortText.
- organization_id
Template: ShortText.
- url
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/export/
.Documentation: https://developer.close.com/#exports-list-all-the-exports.
- id
A key field. Template: ShortText.
- status
Template: ShortText.
- download_url
Template: ShortText.
- type
Template: ShortText.
- query
Template: ShortText.
- format
Template: ShortText.
- fields
Template: LongText. A composite field.
- n_docs
Data type: DT_I4
- n_docs_processed
Data type: DT_I4
- organization_id
Template: ShortText.
- send_done_email
Data type: DT_BOOL
- created_by
Template: ShortText. A read-only field.
- date_created
Template: DateTime. A read-only field.
- updated_by
Template: ShortText. A read-only field.
- date_updated
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/phone_number/
.Documentation: https://developer.close.com/#phone-numbers-list-or-search-for-phone-numbers.
- [Update] action
-
Endpoint URL address:
/phone_number/{{=item.id}}/
.Documentation: https://developer.close.com/#phone-numbers-update-a-phone-number.
- [Delete] action
-
Endpoint URL address:
/phone_number/{{=item.id}}/
.Documentation: https://developer.close.com/#phone-numbers-delete-a-phone-number.
- id
A key field. Template: ShortText.
- organization_id
Template: ShortText.
- user_id
Template: ShortText.
- is_group_number
Data type: DT_BOOL
- label
Template: ShortText.
- number
Template: ShortText.
- number_formatted
Template: ShortText.
- type
Template: ShortText.
- sms_enabled
Data type: DT_BOOL
- supports_sms_to_countries
Template: LongText. A composite field.
- voicemail_greeting_url
Template: ShortText.
- forward_to
Template: ShortText.
- forward_to_enabled
Data type: DT_BOOL
- forward_to_formatted
Template: ShortText.
- date_created
Template: DateTime. A read-only field.
- date_updated
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/event/
.Documentation: https://developer.close.com/#event-log-retrieve-a-list-of-events.
- id
A key field. Template: ShortText.
- action
Template: ShortText.
- changed_fields
Template: LongText. A composite field.
- data
Field components:
-
Uses template:
ShortText
. - Contains the following components: _type, contact_id, id, lead_id, note, organization_id, user_id, user_name, users, created_by, created_by_name, date_created, updated_by, updated_by_name, date_updated.
-
Uses template:
- date_created
Template: DateTime. A read-only field.
- date_updated
Template: DateTime. A read-only field.
- lead_id
Template: ShortText.
- meta
Field components:
-
Uses template:
ShortText
. - Contains the following components: request_method, request_path.
-
Uses template:
- object_id
Template: ShortText.
- object_type
Template: ShortText.
- organization_id
Template: ShortText.
- previous_data
Template: LongText. A composite field.
- request_id
Template: ShortText.
- user_id
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/webhook/
.Documentation: https://developer.close.com/#webhook-subscriptions-list-webhook-subscriptions.
- [Create] action
-
Endpoint URL address:
/webhook/
.Documentation: https://developer.close.com/#webhook-subscriptions-create-new-webhook-subscription.
- [Update] action
-
Endpoint URL address:
/webhook/{{=item.id}}/
.Documentation: https://developer.close.com/#webhook-subscriptions-update-existing-webhook-subscription.
- [Delete] action
-
Endpoint URL address:
/webhook/{{=item.id}}/
.Documentation: https://developer.close.com/#webhook-subscriptions-delete-webhook-subscription.
- id
A key field. Template: ShortText.
- status
Template: ShortText.
- verify_ssl
Data type: DT_BOOL
- events
Field components:
- An array.
- Contains the following components: action, object_type.
- url
Template: ShortText.
- created_by
Template: ShortText. A read-only field.
- date_created
Template: DateTime. A read-only field.
- updated_by
Template: ShortText. A read-only field.
- date_updated
Template: DateTime. A read-only field.
- [Read] action
-
The result is extracted from:{{=response.data}}
.
The result is paginated.The following request parameters will be automatically processed:
-
_skip:
{{=parameters.iterator}}
-
_limit:
{{=parameters.batchSize}}
-
_fields:
{{='custom,' + _.filter(parameters.fields, function(field) { return !_.startsWith(field, 'custom.'); }).join()}}
-
_includeUserParameters:
{{=parameters}}
-
_skip:
- [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
- Address
Field components:
-
Uses template:
ShortText
. - Contains the following components: label, address_1, address_2, city, state, zipcode, country.
-
Uses template:
- EmailAddress
Field components:
-
Uses template:
ShortText
. - Contains the following components: name, email.
-
Uses template:
- Contact
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, name, title, display_name, phones, organization_id, lead_id, emails, integration_links, created_by, date_created, updated_by, date_updated.
-
Uses template:
- Opportunity
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, organization_id, lead_id, lead_name, status_id, status_label, status_type, value, value_period, value_formatted, value_currency, expected_value, annualized_value, annualized_expected_value, date_won, confidence, note, user_id, user_name, contact_id, created_by, date_created, updated_by, date_updated.
-
Uses template:
- Task
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, text, contact_id, contact_name, lead_id, lead_name, object_id, object_type, is_dateless, due_date, _type, organization_id, assigned_to, assigned_to_name, date, is_complete, view, created_by, created_by_name, date_created, updated_by, updated_by_name, date_updated.
-
Uses template:
- Envelope
Field components:
-
Uses template:
LongText
. - Contains the following components: bcc, cc, date, from, in_reply_to, message_id, reply_to, sender, subject, to.
-
Uses template:
- Attachment
Field components:
-
Uses template:
ShortText
. - Contains the following components: url, filename, size, content_type.
-
Uses template:
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, _type, status, sender, subject, body_preview, to, cc, bcc, direction, date_sent, contact_id, email_account_id, envelope, body_text, body_html, body_text_quoted, in_reply_to_id, lead_id, message_ids, need_smtp_credentials, opens, opens_summary, organization_id, references, send_attempts, template_id, template_name, thread_id, user_id, user_name, users, attachments, sequence_subscription_id, sequence_id, sequence_name, created_by, created_by_name, date_created, updated_by, updated_by_name, date_updated.
-
Uses template:
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.