Overview
Configuration is provided for establishing connections with Infusionsoft 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.
Demonstration
Quick Start
In this task, we will show you step-by-step how to create a connection to InfusionSoft 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 InfusionSoft. Then click New in the Token File parameter to create a new token file.
Step 3: Provide Email and Password. Then press 'Login' button.
Step 4: Save generated access token to file. Specify token protection password. Click OK.
Step 5. Click "Test Connection" to test your connection.
Congratulations! You have now established a connection to your InfusionSoft instance.
In this guide, we will show how to read data from the InfusionSoft 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 InfusionSoft connection from the combo. Select from available InfusionSoft 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 InfusionSoft 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 InfusionSoft service.
In this guide, we will show how to write data to the InfusionSoft 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 InfusionSoft connection from the combo. Also, select resource action and InfusionSoft 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 InfusionSoft resource.
Configuration
Base URL address: https://api.infusionsoft.com/crm/rest/v1.
- OAuth 2
-
The authentication uses an authorized token. The token will be refreshed with the following expression:
{{=Date.now() + (response.expires_in - 300) * 1000}}.The authentication has the following user-defined parameters:
- Scope:
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
Documentation: https://developer.infusionsoft.com/getting-started-oauth-keys/.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/account/profile.
The result is extracted from:{{=[response]}}.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Account_Info/getAccountProfileUsingGET.
- [Update] action
-
Endpoint URL address:
/account/profile.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Account_Info/updateAccountInfoUsingPUT.
- address
Template: Address.
- business_goals
Template: LongText. A composite field.
- business_primary_color
Template: ShortText.
- business_secondary_color
Template: ShortText.
- business_type
Template: ShortText.
- currency_code
Template: ShortText.
Template: ShortText.
- language_tag
Template: ShortText.
- logo_url
Template: ShortText.
- name
Template: ShortText.
- phone
Template: ShortText.
- phone_ext
Template: ShortText.
- time_zone
Template: ShortText.
- website
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/affiliates.
The result is extracted from:{{=response.affiliates}}.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Affiliate/listAffiliatesUsingGET.
- [Read single] action
-
Endpoint URL address:
/affiliates/{{=parameters.id}}.
The result is extracted from:{{= [response] }}.The action has the following user-defined parameters:
- id: Required. Please specify the affiliate identifier.
- [Create] action
-
Endpoint URL address:
/affiliates.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Affiliate/createAffiliateUsingPOST.
- id
A key field. Data type: DT_I4
- code
Template: ShortText.
- contact_id
Data type: DT_I4
- name
Template: ShortText.
- notify_on_lead
Data type: DT_BOOL
- notify_on_sale
Data type: DT_BOOL
- parent_id
Data type: DT_I4
- status
Template: ShortText.
- track_leads_for
Data type: DT_I4
- password
Template: ShortText.
- clawbacks
The value is gathered from
/affiliates/{{=item.id}}/clawbacksaddress. The gathered value is processed with{{=response.clawbacks}}expression. Field components:- An array.
- Contains the following components: amount, contact_id, date_earned, description, family_name, given_name, invoice_id, product_name, sale_affiliate_id, sold_by_family_name, sold_by_given_name, subscription_plan_name.
- payments
The value is gathered from
/affiliates/{{=item.id}}/paymentsaddress. The gathered value is processed with{{=response.payments}}expression. Field components:- An array.
- Contains the following components: id, amount, date, notes, type.
- summaries
The value is gathered from
/affiliates/summariesaddress. The gathered value is processed with{{=response.summaries}}expression. Field components:- An array.
- Contains the following components: affiliate_id, amount_earned, balance, clawbacks.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/affiliates/commissions.
The result is extracted from:{{=response.commissions}}.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Affiliate/listCommissionsUsingGET.
- amount_earned
Data type: DT_R8
- contact_first_name
Template: ShortText.
- contact_id
Data type: DT_I4
- contact_last_name
Template: ShortText.
- date_earned
Data type: DT_DBTIMESTAMP A read-only field.
- description
Template: ShortText.
- invoice_id
Data type: DT_I4
- product_name
Template: ShortText.
- sales_affiliate_id
Data type: DT_I4
- sold_by_first_name
Template: ShortText.
- sold_by_last_name
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/affiliates/programs.
The result is extracted from:{{=response.programs}}.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Affiliate/listProgramsUsingGET.
- id
A key field. Data type: DT_I4
- affiliate_id
Data type: DT_I4
- name
Template: ShortText.
- notes
Template: ShortText.
- priority
Data type: DT_I4
Based on resource template Base.
- [Read Redirects] action
-
Endpoint URL address:
/affiliates/redirectlinks.
The result is extracted from:{{= response.redirects }}.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Affiliate/listAffiliateRedirectLinksUsingGET.
- id
A key field. Data type: DT_I4
- affiliate_id
Data type: DT_I4
- local_url_code
Template: ShortText.
- name
Template: ShortText.
- program_ids
Template: LongText. A composite field.
- redirect_url
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/appointments.
The result is extracted from:{{=response.appointments}}.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Appointment/listAppointmentsUsingGET.
- [Read single] action
-
Endpoint URL address:
/appointments/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Please specify the appointmentID
Documentation: https://developer.infusionsoft.com/docs/rest/#!/Appointment/getAppointmentUsingGET.
- [Create] action
-
Endpoint URL address:
/appointments.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Appointment/createAppointmentUsingPOST.
- [Update] action
-
Endpoint URL address:
/appointments/{{=item.appointmentid}}.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Appointment/updatePropertiesOnAppointmentUsingPATCH.
- [Delete] action
-
Endpoint URL address:
/appointments/{{=item.appointmentid}}.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Appointment/deleteAppointmentUsingDELETE.
- contact_id
A key field. Data type: DT_I4
- description
Template: ShortText.
- end_date
Template: DateTime.
- location
Template: ShortText.
- remind_time
Data type: DT_I4
- start_date
Template: DateTime.
- title
Template: ShortText.
- user
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/campaigns.
The result is extracted from:{{=response.campaigns}}.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Campaign/listCampaignsUsingGET.
- [Read single] action
-
Endpoint URL address:
/campaigns/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Please specify the campaignID
Documentation: https://developer.infusionsoft.com/docs/rest/#!/Campaign/getCampaignUsingGET.
- [Create] action
-
Endpoint URL address:
/campaigns/{{=item.id}}/sequences/{{=item.sequence_id}}/contacts/{{=item.contact_id}}.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Campaign/addContactToCampaignSequenceUsingPOST.
- [Delete] action
-
Endpoint URL address:
/campaigns/{{=item.id}}/sequences/{{=item.sequence_id}}/contacts/{{=item.contact_id}}.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Campaign/removeContactFromCampaignSequenceUsingDELETE.
- id
A key field. Data type: DT_I4
- active_contact_count
Data type: DT_I4
- completed_contact_count
Data type: DT_I4
- created_by_global_id
Data type: DT_I4
- date_created
Template: DateTime.
- error_message
Template: ShortText.
- goals
Field components:
- An array.
- Contains the following components: id, historical_contact_counts, name, next_sequence_ids, previous_sequence_ids, type.
- locked
Data type: DT_BOOL
- name
Template: ShortText.
- published_date
Template: DateTime.
- published_status
Data type: DT_BOOL
- published_time_zone
Template: ShortText.
- sequences
Field components:
- An array.
- Contains the following components: id, active_contact_count, active_contact_count_completed, historical_contact_count, name, paths.
- time_zone
Template: ShortText.
- sequence_id
A key field. Data type: DT_I4
- contact_id
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/companies.
The result is extracted from:{{=response.companies}}.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Company/listCompaniesUsingGET.
- [Read single] action
-
Endpoint URL address:
/companies/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Please specify the companyID
Documentation: https://developer.infusionsoft.com/docs/rest/#!/Company/getCompanyUsingGET.
- [Read tag] action
-
Endpoint URL address:
/tags/{{=parameters.tag_id}}/companies.
The result is extracted from:{{=_.map(response.companies, function(item) { return { id: item.company.id, company_name: item.company.company_name, email_address: item.company.email, date_applied: item.date_applied }; })}}.The action has the following user-defined parameters:
- tag_id: Required. Specify tag identifier.
Documentation: https://developer.infusionsoft.com/docs/rest/#!/Tags/listCompaniesForTagIdUsingGET.
- [Create] action
-
Endpoint URL address:
/companies.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Company/createCompanyUsingPOST.
- [Update] action
-
Endpoint URL address:
/companies/{{=item.id}}.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Company/updatePropertiesOnContactUsingPATCH.
- id
A key field. Data type: DT_I4
- address
Template: Address.
- company_name
Template: ShortText.
- email_address
Template: ShortText.
- email_opted_in
Data type: DT_BOOL
- email_status
Template: ShortText.
- fax_number
Template: PhoneNum.
- notes
Template: ShortText.
- phone_number
Template: PhoneNum.
- website
Template: ShortText.
- [External]
-
The external fields URL address:
/companies/model. The external fields list is extracted from:{{=response.custom_fields}}.- custom.{{=external.label}}
Data type: {{=IS.getDataType(external.field_type)}} ( length 255 ) The gathered value is processed with
{{=item[field.external.id]}}expression.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/contacts.
The result is extracted from:{{=response.contacts}}.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Contact/listContactsUsingGET.
- [Read single] action
-
Endpoint URL address:
/contacts/{{=parameters.id}}.
The result is extracted from:{{= [response] }}.The action has the following user-defined parameters:
- id: Required. Please specify the contactID
Documentation: https://developer.infusionsoft.com/docs/rest/#!/Contact/getContactUsingGET.
- [Read tag] action
-
Endpoint URL address:
/tags/{{=parameters.tag_id}}/contacts.
The result is extracted from:{{=_.map(response.contacts, function(item) { return { id: item.contact.id, email: item.contact.email, given_name: item.contact.first_name, family_name: item.contact.last_name, date_applied: item.date_applied }; })}}.The action has the following user-defined parameters:
- tag_id: Required. Specify tag identifier.
Documentation: https://developer.infusionsoft.com/docs/rest/#!/Tags/listContactsForTagIdUsingGET.
- [Create] action
-
Endpoint URL address:
/contacts.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Contact/createContactUsingPOST.
- [Update] action
-
Endpoint URL address:
/contacts/{{=item.id}}.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Contact/updatePropertiesOnContactUsingPATCH_2.
- [Delete] action
-
Endpoint URL address:
/contacts/{{=item.id}}.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Contact/deleteContactUsingDELETE.
- id
A key field. Data type: DT_I4
- ScoreValue
Template: ShortText.
- addresses
Field components:
- An array.
-
Uses template:
Address.
- anniversary
Template: DateTime.
- birthday
Template: DateTime.
- company
Field components:
-
Uses template:
ShortText. - Contains the following components: company_name, id.
-
Uses template:
- company_name
Template: ShortText.
- contact_type
Template: ShortText.
- date_created
Template: DateTime. A read-only field.
- email_addresses
Field components:
- An array.
- Contains the following components: email, field.
- email_opted_in
Data type: DT_BOOL
- email_status
Template: ShortText.
- family_name
Template: ShortText.
- fax_numbers
Field components:
- An array.
-
Uses template:
PhoneNum.
- given_name
Template: ShortText.
- job_title
Template: ShortText.
- last_updated
Template: DateTime.
- lead_source_id
Data type: DT_I4
- middle_name
Template: ShortText.
- owner_id
Data type: DT_I4
- phone_numbers
Field components:
- An array.
-
Uses template:
PhoneNum.
- preferred_locale
Template: ShortText.
- preferred_name
Template: ShortText.
- prefix
Template: ShortText.
- social_accounts
Field components:
- An array.
- Contains the following components: name, type.
- source_type
Template: ShortText.
- spouse_name
Template: ShortText.
- suffix
Template: ShortText.
- time_zone
Template: ShortText.
- website
Template: ShortText.
- emails
The gathered value is processed with
{{=connection.resourceManager['Email'].getData({ endpoint: 'contact', parameters: ['contact_id=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
Email.
- tags
The value is gathered from
/contacts/{{=item.id}}/tagsaddress. The gathered value is processed with{{=response.tags}}expression. Field components:- An array.
- Contains the following components: date_applied, tag.
- [External]
-
The external fields URL address:
/contacts/model. The external fields list is extracted from:{{=response.custom_fields}}.- custom.{{=external.label}}
Data type: {{=IS.getDataType(external.field_type)}} ( length 255 ) The value is gathered from
/contacts/{{=item.id}}address. The gathered value is processed with{{=item[field.external.id]}}expression.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/orders.
The result is extracted from:{{=response.orders}}.Documentation: https://developer.infusionsoft.com/docs/rest/#!/E-Commerce/getOrderUsingGET.
- [Read single] action
-
Endpoint URL address:
/orders/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Please specify the orderID
Documentation: https://developer.infusionsoft.com/docs/rest/#!/E-Commerce/getOrderUsingGET.
- [Create] action
-
Endpoint URL address:
/orders.Documentation: https://developer.infusionsoft.com/docs/rest/#!/E-Commerce/createOrderUsingPOST.
- [Delete] action
-
Endpoint URL address:
/orders/{{=item.id}}.Documentation: https://developer.infusionsoft.com/docs/rest/#!/E-Commerce/deleteOrderUsingDELETE.
The resource includes the fields from the Order template.
- order_title
Template: ShortText.
- contact_id
Data type: DT_I4
- shipping_address
Template: ShippingInfo.
- order_type
Template: ShortText.
- payments
The value is gathered from
/orders/{{=item.id}}/paymentsaddress. Field components:- An array.
-
Uses template:
Payment.
- transactions
The gathered value is processed with
{{=connection.resourceManager['E-Commerce Transaction'].getData({ endpoint: 'order', parameters: ['order_id=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
Transaction.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/orders/{{=parameters.order_id}}.
The result is extracted from:{{=response.order_items}}.The action has the following user-defined parameters:
- order_id: Required. Specify order identifier.
Documentation: https://developer.infusionsoft.com/docs/rest/#!/E-Commerce/getOrderUsingGET.
- [Create] action
-
Endpoint URL address:
/orders/{{=item.orderId}}/items.Documentation: https://developer.infusionsoft.com/docs/rest/#!/E-Commerce/createOrderItemsOnOrderUsingPOST.
- [Delete] action
-
Endpoint URL address:
/orders/{{=item.order_id}}/items/{{=item.id}}.Documentation: https://developer.infusionsoft.com/docs/rest/#!/E-Commerce/deleteOrderOrderItemUsingDELETE.
The resource includes the fields from the OrderItem template.
- product_id
A key field. Data type: DT_I4
- order_id
A key field. Data type: DT_I4
- product
Template: Product. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/orders/{{=parameters.order_id}}/payments.
The result is extracted from:{{= response }}.The action has the following user-defined parameters:
- order_id: Required. Please specify the order identifier.
Documentation: https://developer.infusionsoft.com/docs/rest/#!/E-Commerce/listOrderPaymentsUsingGET.
- [Create] action
-
Endpoint URL address:
/orders/{{=item.order_id}}/payments.Documentation: https://developer.infusionsoft.com/docs/rest/#!/E-Commerce/createPaymentOnOrderUsingPOST.
The resource includes the fields from the Payment template.
- apply_to_commissions
Data type: DT_BOOL
- charge_now
Data type: DT_BOOL
- credit_card_id
Data type: DT_I4
- date
Template: DateTime.
- notes
Template: ShortText.
- payment_amount
Data type: DT_R8
- payment_gateway_id
Template: ShortText.
- payment_method_type
Template: ShortText.
- order_id
A key field. Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/subscriptions.
The result is extracted from:{{=response.subscriptions}}.Documentation: https://developer.infusionsoft.com/docs/rest/#!/E-Commerce/listSubscriptionsUsingGET.
- [Create] action
-
Endpoint URL address:
/subscriptions.Documentation: https://developer.infusionsoft.com/docs/rest/#!/E-Commerce/createSubscriptionUsingPOST.
- id
A key field. Data type: DT_I4
- active
Data type: DT_BOOL A read-only field.
- allow_tax
Data type: DT_BOOL
- auto_charge
Data type: DT_BOOL
- billing_amount
Data type: DT_R8
- billing_cycle
Template: ShortText. A read-only field.
- billing_frequency
Data type: DT_I4 A read-only field.
- contact_id
Data type: DT_I4
- credit_card_id
Data type: DT_I4
- end_date
Template: DateTime. A read-only field.
- next_bill_date
Template: DateTime. A read-only field.
- payment_gateway_id
Data type: DT_I4
- product_id
Data type: DT_I4 A read-only field.
- quantity
Data type: DT_I4
- sale_affiliate_id
Data type: DT_I4
- start_date
Template: DateTime. A read-only field.
- subscription_plan_id
Data type: DT_I4
- use_default_payment_gateway
Data type: DT_BOOL A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/transactions.
The result is extracted from:{{=response.transactions}}.Documentation: https://developer.infusionsoft.com/docs/rest/#!/E-Commerce/listTransactionsUsingGET.
- [Read single] action
-
Endpoint URL address:
/transactions/{{=parameters.id}}.
The result is extracted from:{{= [response] }}.The action has the following user-defined parameters:
- id: Required. Please specify the transactionID
Documentation: https://developer.infusionsoft.com/docs/rest/#!/E-Commerce/getTransactionUsingGET.
- [Read order] action
-
Endpoint URL address:
/orders/{{=parameters.order_id}}/transactions.
The result is extracted from:{{=response.transactions}}.The action has the following user-defined parameters:
- order_id: Required, Please specify the order identifier.
Documentation: https://developer.infusionsoft.com/docs/rest/#!/E-Commerce/listTransactionsForOrderUsingGET.
The resource includes the fields from the Transaction template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/emails.
The result is extracted from:{{=response.emails}}.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Email/listEmailsUsingGET.
- [Read single] action
-
Endpoint URL address:
/emails/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Please specify the email identifier.
Documentation: https://developer.infusionsoft.com/docs/rest/#!/Email/getEmailUsingGET.
- [Read contact] action
-
Endpoint URL address:
/contacts/{{=parameters.contact_id}}/emails.
The result is extracted from:{{=response.emails}}.The action has the following user-defined parameters:
- contact_id: Required. Please specify the contact identifier.
Documentation: https://developer.infusionsoft.com/docs/rest/#!/Contact/listEmailsForContactUsingGET.
- [Create] action
-
Endpoint URL address:
/emails.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Email/createEmailUsingPOST.
- [Update] action
-
Endpoint URL address:
/emails/{{=item.id}}.
The action uses PUT method.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Email/updateEmailUsingPUT.
- [Delete] action
-
Endpoint URL address:
/emails/{{=item.id}}.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Email/deleteEmailUsingDELETE.
The resource includes the fields from the Email template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/files.
The result is extracted from:{{=response.files}}.Documentation: https://developer.infusionsoft.com/docs/rest/#!/File/listFilesUsingGET.
- [Read single] action
-
The result is extracted from:{{=[response]}}.Documentation: https://developer.infusionsoft.com/docs/rest/#!/File/getFileUsingGET.
- [Create] action
-
Endpoint URL address:
/files.Documentation: https://developer.infusionsoft.com/docs/rest/#!/File/createFileUsingPOST.
- [Update] action
-
Endpoint URL address:
/files/{{=item.id}}.
The action uses PUT method.Documentation: https://developer.infusionsoft.com/docs/rest/#!/File/updateFileUsingPUT.
- [Delete] action
-
Endpoint URL address:
/files/{{=item.id}}.Documentation: https://developer.infusionsoft.com/docs/rest/#!/File/deleteFileUsingDELETE.
- id
A key field. Data type: DT_I4
- file_data
Data type: DT_IMAGE The value is gathered from
/files/{{=item.id}}address. The gathered value is processed with{{=response.file_data}}expression. Before setting, the value is processed with{{=getClrType('System.Convert').ToBase64String(value.readAll())}}expression.- category
Template: ShortText.
- contact_id
Data type: DT_I4
- created_by
Data type: DT_I4
- date_created
Template: DateTime.
- download_url
Template: ShortText.
- file_box_type
Template: ShortText.
- file_name
Template: ShortText.
- file_size
Data type: DT_I4
- last_updated
Template: DateTime.
- public
Data type: DT_BOOL
- remote_file_key
Template: ShortText.
- file_association
Template: ShortText.
- is_public
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/locales/countries.
The result is extracted from:{{=_.map(response.countries, function(v, k) { return { code: k, name: v }; })}}.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Locale/listCountriesUsingGET.
- code
Template: ShortText.
- name
Template: ShortText.
- provinces
The value is gathered from
/locales/countries/{{=item.code}}/provincesaddress. The gathered value is processed with{{=_.map(response.provinces, function(v, k) { return { code: k, name: v }; })}}expression. Field components:- An array.
- Contains the following components: code, name.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/merchants.
The result is extracted from:{{=response.merchant_accounts.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Merchant/getMerchantAccountsUsingGET.
- id
Data type: DT_I4
- account_name
Template: ShortText.
- is_test
Data type: DT_BOOL
- type
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/notes.
The result is extracted from:{{=response.notes}}.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Note/listNotesUsingGET.
- [Read single] action
-
Endpoint URL address:
/notes/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Please specify the noteID
Documentation: https://developer.infusionsoft.com/docs/rest/#!/Note/getNoteUsingGET.
- [Create] action
-
Endpoint URL address:
/notes.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Note/createNoteUsingPOST.
- [Update] action
-
Endpoint URL address:
/notes/{{=item.id}}.
The action uses PATCH method.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Note/updatePropertiesOnNoteUsingPATCH.
- [Delete] action
-
Endpoint URL address:
/notes/{{= item.id }}.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Note/deleteNoteUsingDELETE.
- id
A key field. Data type: DT_I4
- body
Template: ShortText.
- contact_id
Data type: DT_I4
- date_created
Template: DateTime. A read-only field.
- last_updated
Template: DateTime. A read-only field.
- last_updated_by
A read-only field. Field components:
-
Uses template:
ShortText. - Contains the following components: family_name, given_name, user_id.
-
Uses template:
- title
Template: ShortText.
- type
Template: ShortText.
- user_id
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/opportunities.
The result is extracted from:{{=response.opportunities}}.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Opportunity/listOpportunitiesUsingGET.
- [Read single] action
-
Endpoint URL address:
/opportunities/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Please specify the opportunityID
Documentation: https://developer.infusionsoft.com/docs/rest/#!/Opportunity/getOpportunityUsingGET.
- [Read Stage Pipeline] action
-
Endpoint URL address:
/opportunity/stage_pipeline.
The result is extracted from:{{= response }}.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Opportunity/listOpportunityStagePipelinesUsingGET.
- [Create] action
-
Endpoint URL address:
/opportunities.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Opportunity/createOpportunityUsingPOST.
- [Update] action
-
Endpoint URL address:
/opportunities/{{=item.id}}.
The action uses PATCH method.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Opportunity/updatePropertiesOnOpportunityUsingPATCH.
- id
A key field. Data type: DT_I4
- affiliate_id
Data type: DT_I4
- contact
Template: Contact.
- date_created
Template: DateTime.
- estimated_close_date
Template: DateTime.
- include_in_forecast
Data type: DT_I4
- last_updated
Template: DateTime.
- next_action_date
Template: DateTime.
- next_action_notes
Template: ShortText.
- opportunity_notes
Template: ShortText.
- opportunity_title
Template: ShortText.
- projected_revenue_high
Data type: DT_I4
- projected_revenue_low
Data type: DT_I4
- stage
Field components:
-
Uses template:
ShortText. - Contains the following components: details, id, name, reasons.
-
Uses template:
- user
Field components:
-
Uses template:
ShortText. - Contains the following components: first_name, id, last_name.
-
Uses template:
- [External]
-
The external fields URL address:
/opportunities/model. The external fields list is extracted from:{{=response.custom_fields}}.- custom.{{=external.label}}
Data type: {{=IS.getDataType(external.field_type)}} ( length 255 ) The gathered value is processed with
{{=item[field.external.id]}}expression.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/opportunity/stage_pipeline.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Opportunity/listOpportunityStagePipelinesUsingGET.
- end_stage
Data type: DT_BOOL
- is_default
Data type: DT_BOOL
- stage_count
Data type: DT_I4
- stage_id
Data type: DT_I4
- stage_name
Template: ShortText.
- stage_order
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/products.
The result is extracted from:{{=response.products}}.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Product/listProductsUsingGET.
- [Read single] action
-
Endpoint URL address:
/products/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Please specify the productID
Documentation: https://developer.infusionsoft.com/docs/rest/#!/Product/retrieveProductUsingGET.
- [Read Product Subscription] action
-
Endpoint URL address:
/products/{{= parameters.id }}/subscriptions/{{= parameters.subscriptionid}}.
The result is extracted from:{{= [response] }}.The action has the following user-defined parameters:
- id: Required. Please specify the productID
- subscriptionid: Required. Please specify the subscriptionID
Documentation: https://developer.infusionsoft.com/docs/rest/#!/Product/retrieveProductSubscriptionUsingGET.
- [Read Synced Products] action
-
Endpoint URL address:
/products/sync.
The result is extracted from:{{= _.values(response.product_statuses) }}.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Product/listProductsFromSyncTokenUsingGET.
- [Create] action
-
Endpoint URL address:
/products.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Product/createProductUsingPOST.
- [Update] action
-
Endpoint URL address:
/products/{{= item.id}}.
The action uses PATCH method.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Product/updateProductUsingPATCH.
- [Delete] action
-
Endpoint URL address:
/products/{{=item.id}}.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Product/deleteProductUsingDELETE.
The resource includes the fields from the Product template.
- active
Data type: DT_BOOL
- image
Before setting, the value is processed with
{{=IS.setProductImage(item)}}expression. Field components:-
Uses template:
ShortText. - Contains the following components: name, content.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/products/{{=parameters.product_id}}.
The result is extracted from:{{=response.subscription_plans}}.The action has the following user-defined parameters:
- product_id: Required. Specify product identifier.
Documentation: https://developer.infusionsoft.com/docs/rest/#!/Product/retrieveProductUsingGET.
- [Create] action
-
Endpoint URL address:
/products/{{=item.product_id}}/subscriptions.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Product/createProductSubscriptionUsingPOST.
- [Delete] action
-
Endpoint URL address:
/products/{{=item.product_id}}/subscriptions/{{=item.id}}.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Product/deleteProductSubscriptionUsingDELETE.
- id
A key field. Data type: DT_I4
- active
Data type: DT_BOOL
- cycle_type
Template: ShortText.
- frequency
Data type: DT_I4
- number_of_cycles
Data type: DT_I4
- plan_price
Data type: DT_I4
- subscription_plan_index
Data type: DT_I4
- product_id
A key field. Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/hooks.
The result is extracted from:{{=response}}.Documentation: https://developer.infusionsoft.com/docs/rest/#!/REST_Hooks/list_stored_hook_subscriptions.
- [Read single] action
-
Endpoint URL address:
/hooks/{{=parameters.key}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- key: Required. Please specify the key to retrieve Hook Subscription
Documentation: https://developer.infusionsoft.com/docs/rest/#!/REST_Hooks/retrieve_a_hook_subscription.
- [Create] action
-
Endpoint URL address:
/hooks.Documentation: https://developer.infusionsoft.com/docs/rest/#!/REST_Hooks/create_a_hook_subscription.
- [Update] action
-
Endpoint URL address:
/hooks/{{=item.key}}.
The action uses PUT method.Documentation: https://developer.infusionsoft.com/docs/rest/#!/REST_Hooks/update_a_hook_subscription.
- [Delete] action
-
Endpoint URL address:
/hooks/{{=parameters.key}}.Documentation: https://developer.infusionsoft.com/docs/rest/#!/REST_Hooks/delete_a_hook_subscription.
- key
A key field. Template: ShortText.
- eventKey
Template: ShortText.
- hookUrl
Template: ShortText.
- status
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/setting/application/configuration.
The result is extracted from:{{=[response]}}.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Setting/getConfigurationUsingGET.
- affiliate
Field components:
-
Uses template:
ShortText. - Contains the following components: choose_affiliate, commission, custom_affiliate_url, display_affiliate_ip_address, do_not_notify_affiliate, skip_pay_if_unused, use_referral_history_if_no_tracking_cookie.
-
Uses template:
- application
Field components:
-
Uses template:
ShortText. - Contains the following components: company, default_view_locale, features_enabled, time_zone.
-
Uses template:
- appointment
Field components:
-
Uses template:
ShortText. - Contains the following components: appointment_types, share_opportunity_with_related_user.
-
Uses template:
- contact
Field components:
-
Uses template:
ShortText. - Contains the following components: address_labels, contact_types, default_new_contact_form, disable_contact_edit_in_client_login, fax_types, phone_types, suffix_types, title_types.
-
Uses template:
- ecommerce
Field components:
-
Uses template:
ShortText. - Contains the following components: credit_card_types, currency, default_charge_max_retry_attempts, default_country, default_merchant, default_number_of_days_between_charge_attempts, default_tax, default_to_auto_charge, merchant_account_max_retry_attempts, payment_types, promo_codes, track_cost_per_unit, track_inventory.
-
Uses template:
Field components:
-
Uses template:
ShortText. - Contains the following components: append_contact_key_to_links, default_opt_in_link, default_opt_out_link, hide_emails_to_and_from_domains, whitelisted_domains.
-
Uses template:
- forms
Field components:
- Contains the following components: spam_filters_enabled.
- fulfillment
Field components:
-
Uses template:
ShortText. - Contains the following components: default_message_fields, default_message_to.
-
Uses template:
- invoice
Field components:
-
Uses template:
ShortText. - Contains the following components: tax_label.
-
Uses template:
- note
Field components:
-
Uses template:
ShortText. - Contains the following components: appointment_types, share_opportunity_with_related_user.
-
Uses template:
- opportunity
Field components:
-
Uses template:
ShortText. - Contains the following components: default_stage, states.
-
Uses template:
- task
Field components:
-
Uses template:
ShortText. - Contains the following components: appointment_types, share_opportunity_with_related_user.
-
Uses template:
- template
Field components:
- Contains the following components: default_country_code, default_user_id.
- enabled
Data type: DT_BOOL The value is gathered from
/setting/application/enabledaddress. The gathered value is processed with{{=response.value}}expression.- contactTypes
Template: ShortText. The value is gathered from
/setting/contact/optionTypesaddress. The gathered value is processed with{{=response.value}}expression.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/tags.
The result is extracted from:{{= response.tags }}.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Tags/listTagsUsingGET.
- [Read single] action
-
Endpoint URL address:
/tags/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Please specify the tagID
Documentation: https://developer.infusionsoft.com/docs/rest/#!/Tags/getTagUsingGET.
- [Read Tagged Contacts] action
-
Endpoint URL address:
/tags/{{=parameters.id}}/contacts.
The result is extracted from:{{=response.contacts}}.The action has the following user-defined parameters:
- id: Required. Please specify the tagID
Documentation: https://developer.infusionsoft.com/docs/rest/#!/Tags/listContactsForTagIdUsingGET.
- [Create] action
-
Endpoint URL address:
/tags.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Tags/createTagUsingPOST.
- id
A key field. Data type: DT_I4
- category
Field components:
-
Uses template:
ShortText. - Contains the following components: id, description, name.
-
Uses template:
- description
Template: ShortText.
- name
Template: ShortText.
- companies
The gathered value is processed with
{{=connection.resourceManager['Company'].getData({ endpoint: 'tag', parameters: ['tag_id=' + item.id] })}}expression. Field components:- An array.
- Contains the following components: id, company_name, email_address, date_applied.
- contacts
The gathered value is processed with
{{=connection.resourceManager['Contact'].getData({ endpoint: 'tag', parameters: ['tag_id=' + item.id] })}}expression. Field components:- An array.
- Contains the following components: id, email, given_name, family_name, date_applied.
- contactid
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/tasks.
The result is extracted from:{{=response.tasks}}.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Task/getTaskUsingGET.
- [Read single] action
-
Endpoint URL address:
/tasks/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Please specify the taskID
Documentation: https://developer.infusionsoft.com/docs/rest/#!/Task/getTaskUsingGET.
- [Read search] action
-
Endpoint URL address:
/tasks/search.
The result is extracted from:{{=response.tasks}}.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Task/getTaskUsingGET.
- [Create] action
-
Endpoint URL address:
/tasks.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Task/createTaskUsingPOST.
- [Update] action
-
Endpoint URL address:
/tasks/{{=item.id}}.
The action uses PATCH method.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Task/updatePropertiesOnTaskUsingPATCH.
- [Delete] action
-
Endpoint URL address:
/tasks/{{=item.id}}.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Task/deleteTaskUsingDELETE.
- id
A key field. Data type: DT_I4
- completed
Data type: DT_BOOL
- completion_date
Template: DateTime.
- contact
Field components:
-
Uses template:
ShortText. - Contains the following components: email, first_name, id, last_name.
-
Uses template:
- creation_date
Template: DateTime. A read-only field.
- description
Template: ShortText.
- due_date
Template: DateTime. A read-only field.
- modification_date
Template: DateTime. A read-only field.
- priority
Data type: DT_I4
- remind_time
Data type: DT_I4
- title
Template: ShortText.
- type
Template: ShortText.
- url
Template: ShortText.
- user_id
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/users.
The result is extracted from:{{= response.users }}.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Users/listUsersUsingGET.
- [Read current] action
-
Endpoint URL address:
/oauth/connect/userinfo.
The result is extracted from:{{=[response]}}.Documentation: https://developer.infusionsoft.com/docs/rest/#!/User_Info/getUserInfoUsingGET.
- [Create] action
-
Endpoint URL address:
/users.Documentation: https://developer.infusionsoft.com/docs/rest/#!/Users/createUserUsingPOST.
- id
A key field. Data type: DT_I4
- address
Template: Address.
- company_name
Template: ShortText.
- created_by
Data type: DT_I4
- date_created
Template: DateTime. A read-only field.
- email_address
Template: ShortText.
- family_name
Template: ShortText.
- fax_numbers
Field components:
- An array.
- Contains the following components: field, number, type.
- given_name
Template: ShortText.
- global_user_id
Data type: DT_I4
- infusionsoft_id
Template: ShortText.
- job_title
Template: ShortText.
- last_updated
Template: DateTime.
- last_updated_by
Data type: DT_I4
- middle_name
Template: ShortText.
- partner
Data type: DT_BOOL
- phone_numbers
Field components:
- An array.
-
Uses template:
PhoneNum.
- preferred_name
Template: ShortText.
- status
Template: ShortText.
- time_zone
Template: ShortText.
- website
Template: ShortText.
- admin
Template: ShortText.
Template: ShortText.
- sub
Template: ShortText.
- signature
Template: LongText. The value is gathered from
/users/{{=item.id}}/signatureaddress.
- [Read] action
-
The result is paginated.The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}} -
_includeUserParameters:
{{=parameters}}
-
offset:
- [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 PATCH 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
- CustomField
Field components:
-
Uses template:
ShortText. - Contains the following components: id, field_type, label, options, record_type.
-
Uses template:
- Address
Field components:
-
Uses template:
ShortText. - Contains the following components: country_code, field, line1, line2, locality, postal_code, region, zip_code, zip_four.
-
Uses template:
- ShippingInfo
Template: Address. Field components:
-
Uses template:
ShortText. - Contains the following components: company, first_name, last_name, middle_name, phone.
-
Uses template:
- PhoneNum
Field components:
-
Uses template:
ShortText. - Contains the following components: extension, field, number, type.
-
Uses template:
Field components:
-
Uses template:
DateTime. - Contains the following components: id, clicked_date, contact_id, headers, opened_date, original_provider, original_provider_id, received_date, sent_date, sent_from_address, sent_from_reply_address, sent_to_address, sent_to_bcc_addresses, sent_to_cc_addresses, subject, html_content, plain_content.
-
Uses template:
- ProductOption
Field components:
-
Uses template:
ShortText. - Contains the following components: id, allow_spaces, can_contain_character, can_contain_number, can_end_with_character, can_end_with_number, can_start_with_character, can_start_with_number, display_index, label, max_chars, min_chars, name, required, text_message, type, values.
-
Uses template:
- SubscriptionPlan
Field components:
-
Uses template:
ShortText. - Contains the following components: id, active, cycle, frequency, number_of_cycles, plan_price, subscription_plan_index, subscription_plan_name, url.
-
Uses template:
- PaymentPlan
Field components:
-
Uses template:
DateTime. - Contains the following components: auto_charge, credit_card_id, days_between_payments, initial_payment_amount, initial_payment_date, number_of_payments, payment_gateway, plan_start_date.
-
Uses template:
- Contact
Field components:
-
Uses template:
ShortText. - Contains the following components: company_name, email, first_name, id, job_title, last_name, phone_number.
-
Uses template:
- Product
Field components:
-
Uses template:
ShortText. - Contains the following components: id, product_desc, product_name, product_options, product_price, product_short_desc, sku, status, subscription_only, subscription_plans, url.
-
Uses template:
- OrderItem
Field components:
-
Uses template:
ShortText. - Contains the following components: id, cost, description, discount, name, notes, price, product, quantity, type.
-
Uses template:
- Order
Field components:
-
Uses template:
Contact. - Contains the following components: id, allow_payment, allow_paypal, contact, creation_date, lead_affiliate_id, modification_date, notes, order_date, order_items, payment_plan, recurring, refund_total, sales_affiliate_id, shipping_information, source_type, status, terms, title, total, total_due, total_paid.
-
Uses template:
- Transaction
Field components:
-
Uses template:
ShortText. - Contains the following components: id, amount, collection_method, contact_id, currency, errors, gateway, gateway_account_name, order_ids, orders, status, test, transaction_date, type.
-
Uses template:
- Payment
A read-only field. Field components:
-
Uses template:
DateTime. - Contains the following components: id, amount, invoice_id, last_updated, note, pay_date, pay_status, payment_id, refund_invoice_payment_id, skip_commission.
-
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.