Overview
Configuration is provided for establishing connections with the ActiveCampaign 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.
Demonstration
Quick Start
In this task, we will show you step-by-step how to create a connection to ActiveCampaign REST API using COZYROC's REST Connection Manager.
Step 1. Go to ActiveCampaign Developer Settings page by following the instructions posted here. You have to grab the following parameters:
- URL
- 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 ActiveCampaign. Enter the ActiveCampaign parameters you have acquired from the "Developer Settings" page in the places shown in the screenshot.
Step 4. Click "Test Connection" to test your connection.
Congratulations! You have now established a connection to your ActiveCampaign instance.
In this guide, we will show how to read data from ActiveCampaign service resource using 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 ActiveCampaign connection from the combo. Select from available ActiveCampaign 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 ActiveCampaign 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 ActiveCampaign service.
In this guide, we will show how to write data to ActiveCampaign 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 ActiveCampaign connection from the combo. Also, select resource action and ActiveCampaign 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 ActiveCampaign resource.
Configuration
Base URL address: https://[account].api-us1.com/api/3.
-
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:
-
Api-Token:
{{=connection.user.apiKey}}
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/accounts.Documentation: https://developers.activecampaign.com/reference#list-all-accounts.
- [Create] action
-
Endpoint URL address:
/accounts.Documentation: https://developers.activecampaign.com/reference#create-an-account.
- [Update] action
-
Endpoint URL address:
/accounts/{{=item.id}}.Documentation: https://developers.activecampaign.com/reference#update-an-account.
- [Delete] action
-
Endpoint URL address:
/accounts/bulk_delete.The following request parameters will be automatically processed:
-
ids:
{{=_.pluck(batch, 'id').join()}}
Documentation: https://developers.activecampaign.com/reference#bulk-delete-accounts.
-
ids:
- id
A key field. Template: Id.
- name
Template: ShortText.
- accountUrl
Template: ShortText.
- createdTimestamp
Template: DateTime. A read-only field.
- updatedTimestamp
Template: DateTime. A read-only field.
- contactCount
Data type: DT_I4
- dealCount
Data type: DT_I4
- links
Field components:
-
Uses template:
ShortText. - Contains the following components: notes, accountCustomFieldData, accountContacts.
-
Uses template:
- [External]
-
The external fields URL address:
/accountCustomFieldMeta. The external fields list is extracted from:{{=response.accountCustomFieldMeta}}.- custom.{{=external.fieldLabel}}
Data type: {{=ActiveCampaign.getDataType(external.fieldType)}} ( length 255 ) The value is gathered from
/accounts/{{=item.id}}/accountCustomFieldDataaddress. The gathered value is processed with{{=response[field.external.id]}}expression.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/accountContacts.Documentation: https://developers.activecampaign.com/reference#list-all-associations-1.
- [Create] action
-
Endpoint URL address:
/accountContacts.Documentation: https://developers.activecampaign.com/reference#create-an-account-1.
- [Update] action
-
Endpoint URL address:
/accountContacts/{{=item.id}}.Documentation: https://developers.activecampaign.com/reference#update-an-association-1.
- [Delete] action
-
Endpoint URL address:
/accountContacts/{{=item.id}}.Documentation: https://developers.activecampaign.com/reference#delete-an-association-1.
- id
A key field. Template: Id.
- account
Data type: DT_I4
- contact
Data type: DT_I4
- jobTitle
Template: ShortText.
- createdTimestamp
Template: DateTime. A read-only field.
- updatedTimestamp
Template: DateTime. A read-only field.
- links
Field components:
-
Uses template:
ShortText. - Contains the following components: account, contact.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/addresses.Documentation: https://developers.activecampaign.com/reference#list-all-addresses.
- [Create] action
-
Endpoint URL address:
/addresses.Documentation: https://developers.activecampaign.com/reference#create-an-address-2.
- [Update] action
-
Endpoint URL address:
/addresses/{{=item.id}}.Documentation: https://developers.activecampaign.com/reference#update-an-address-2.
- [Delete] action
-
Endpoint URL address:
/addresses/{{=item.id}}.Documentation: https://developers.activecampaign.com/reference#delete-an-address.
- id
A key field. Template: Id.
- companyName
Template: ShortText.
- address1
Template: ShortText.
- address2
Template: ShortText.
- city
Template: ShortText.
- state
Template: ShortText.
- district
Template: ShortText.
- zip
Template: ShortText.
- country
Template: ShortText.
- allgroup
Template: ShortText.
- isDefault
Template: ShortText.
- links
Field components:
-
Uses template:
ShortText. - Contains the following components: addressGroup, addressList, forms.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/automations.Documentation: https://developers.activecampaign.com/reference#list-all-automations.
- id
A key field. Template: Id.
- name
Template: ShortText.
- cdate
Template: ShortText.
- mdate
Template: ShortText.
- userid
Template: Id.
- status
Template: ShortText.
- entered
Template: ShortText.
- exited
Template: ShortText.
- hidden
Template: ShortText.
- defaultscreenshot
Template: ShortText.
- screenshot
Template: ShortText.
- links
Field components:
-
Uses template:
ShortText. - Contains the following components: campaigns, contactGoals, contactAutomations, blocks, goals, sms, sitemessages.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/brandings.Documentation: https://developers.activecampaign.com/reference#brandings.
- [Update] action
-
Endpoint URL address:
/brandings/{{=item.id}}.Documentation: https://developers.activecampaign.com/reference#update-branding.
- id
A key field. Template: Id.
- groupid
Template: Id.
- siteName
Template: ShortText.
- siteLogo
Template: ShortText.
- siteLogoSmall
Template: ShortText.
- headerTextValue
Template: LongText.
- headerHtmlValue
Template: LongText.
- footerTextValue
Template: LongText.
- footerHtmlValue
Template: LongText.
- copyright
Template: ShortText.
- version
Template: ShortText.
- license
Template: ShortText.
- links
Template: LongText. A composite field.
- help
Template: ShortText.
- adminTemplateHtm
Template: LongText.
- adminTemplateCss
Template: LongText.
- publicTemplateHtm
Template: LongText.
- publicTemplateCss
Template: LongText.
- favicon
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/calendars.Documentation: https://developers.activecampaign.com/reference#list-all-calendar-feeds.
- [Create] action
-
Endpoint URL address:
/calendars.Documentation: https://developers.activecampaign.com/reference#create-a-calendar-feed.
- [Update] action
-
Endpoint URL address:
/calendars/{{=item.id}}.Documentation: https://developers.activecampaign.com/reference#update-a-calendar-feed.
- [Delete] action
-
Endpoint URL address:
/calendars/{{=item.id}}.Documentation: https://developers.activecampaign.com/reference#remove-a-calendar-feed.
- id
A key field. Template: Id.
- userid
Template: Id.
- title
Template: ShortText.
- type
Template: ShortText.
- token
Template: ShortText.
- notification
Template: ShortText.
- cdate
Template: ShortText.
- mdate
Template: ShortText.
- links
Field components:
-
Uses template:
ShortText. - Contains the following components: calendarRels, calendarUsers.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/campaigns.Documentation: https://developers.activecampaign.com/reference#list-all-campaigns.
- id
A key field. Template: Id.
- type
Template: ShortText.
- userid
Template: Id.
- segmentid
Template: Id.
- bounceid
Template: Id.
- realcid
Template: Id.
- sendid
Template: Id.
- threadid
Template: Id.
- seriesid
Template: Id.
- formid
Template: Id.
- basetemplateid
Template: Id.
- basemessageid
Template: Id.
- addressid
Template: Id.
- source
Template: ShortText.
- name
Template: ShortText.
- cdate
Template: DateTime.
- mdate
Template: DateTime.
- sdate
Template: DateTime.
- ldate
Template: DateTime.
- send_amt
Template: ShortText.
- total_amt
Template: ShortText.
- opens
Template: ShortText.
- uniqueopens
Template: ShortText.
- linkclicks
Template: ShortText.
- uniquelinkclicks
Template: ShortText.
- subscriberclicks
Template: ShortText.
- forwards
Template: ShortText.
- uniqueforwards
Template: ShortText.
- hardbounces
Template: ShortText.
- softbounces
Template: ShortText.
- unsubscribes
Template: ShortText.
- unsubreasons
Template: ShortText.
- updates
Template: ShortText.
- socialshares
Template: ShortText.
- replies
Template: ShortText.
- uniquereplies
Template: ShortText.
- status
Template: ShortText.
- public
Template: ShortText.
- mail_transfer
Template: ShortText.
- mail_send
Template: ShortText.
- mail_cleanup
Template: ShortText.
- mailer_log_file
Template: ShortText.
- tracklinks
Template: ShortText.
- tracklinksanalytics
Template: ShortText.
- trackreads
Template: ShortText.
- trackreadsanalytics
Template: ShortText.
- analytics_campaign_name
Template: ShortText.
- tweet
Template: ShortText.
Template: ShortText.
- survey
Template: ShortText.
- embed_images
Template: ShortText.
- htmlunsub
Template: ShortText.
- textunsub
Template: ShortText.
- htmlunsubdata
Template: ShortText.
- textunsubdata
Template: ShortText.
- recurring
Template: ShortText.
- willrecur
Template: ShortText.
- split_type
Template: ShortText.
- split_content
Template: ShortText.
- split_offset
Template: ShortText.
- split_offset_type
Template: ShortText.
- split_winner_messageid
Template: Id.
- split_winner_awaiting
Template: ShortText.
- responder_offset
Template: ShortText.
- responder_type
Template: ShortText.
- responder_existing
Template: ShortText.
- reminder_field
Template: ShortText.
- reminder_format
Template: ShortText.
- reminder_type
Template: ShortText.
- reminder_offset
Template: ShortText.
- reminder_offset_type
Template: ShortText.
- reminder_offset_sign
Template: ShortText.
- reminder_last_cron_run
Template: ShortText.
- activerss_interval
Template: ShortText.
- activerss_url
Template: ShortText.
- activerss_items
Template: ShortText.
- ip4
Template: ShortText.
- laststep
Template: ShortText.
- managetext
Template: ShortText.
- schedule
Template: ShortText.
- scheduleddate
Template: ShortText.
- waitpreview
Template: ShortText.
- deletestamp
Template: ShortText.
- replysys
Template: ShortText.
- links
Field components:
-
Uses template:
ShortText. - Contains the following components: user, automation, campaignMessage, links.
-
Uses template:
- user
Template: ShortText.
- automation
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/messages.Documentation: https://developers.activecampaign.com/reference#list-all-messages.
- [Create] action
-
Endpoint URL address:
/messages.Documentation: https://developers.activecampaign.com/reference#create-a-new-message.
- [Update] action
-
Endpoint URL address:
/messages/{{=item.id}}.Documentation: https://developers.activecampaign.com/reference#update-a-message.
- [Delete] action
-
Endpoint URL address:
/messages/{{=item.id}}.Documentation: https://developers.activecampaign.com/reference#delete-a-message.
- id
A key field. Template: Id.
- userid
Template: Id.
- ed_instanceid
Template: ShortText.
- ed_version
Data type: DT_I4
- cdate
Template: DateTime.
- mdate
Template: DateTime.
- name
Template: ShortText.
- fromname
Template: ShortText.
- fromemail
Template: ShortText.
- reply2
Template: ShortText.
- priority
Template: ShortText.
- charset
Template: ShortText.
- encoding
Template: ShortText.
- format
Template: ShortText.
- subject
Template: ShortText.
- preheader_text
Template: ShortText.
- text
Template: LongText.
- html
Template: LongText.
- htmlfetch
Template: ShortText.
- textfetch
Template: ShortText.
- hidden
Template: ShortText.
- preview_mime
Template: ShortText.
- preview_data
Template: ShortText.
- links
Field components:
-
Uses template:
ShortText. - Contains the following components: user.
-
Uses template:
- user
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/contacts.Documentation: https://developers.activecampaign.com/reference#list-all-contacts.
- [Create] action
-
Endpoint URL address:
/contacts.Documentation: https://developers.activecampaign.com/reference#create-contact.
- [Update] action
-
Endpoint URL address:
/contacts/{{=item.id}}.Documentation: https://developers.activecampaign.com/reference#update-a-contact.
- [Delete] action
-
Endpoint URL address:
/contacts/{{=item.id}}.Documentation: https://developers.activecampaign.com/reference#delete-contact.
- id
A key field. Template: Id.
- cdate
Template: DateTime.
Template: ShortText.
- phone
Template: ShortText.
- firstName
Template: ShortText.
- lastName
Template: ShortText.
- orgid
Template: Id.
- segmentio_id
Template: ShortText.
- bounced_hard
Template: ShortText.
- bounced_soft
Template: ShortText.
- bounced_date
Template: ShortText.
- ip
Template: ShortText.
- ua
Template: ShortText.
- hash
Template: ShortText.
- socialdata_lastcheck
Template: ShortText.
- email_local
Template: ShortText.
- email_domain
Template: ShortText.
- sentcnt
Template: ShortText.
- rating_tstamp
Template: ShortText.
- gravatar
Template: ShortText.
- deleted
Template: ShortText.
- adate
Template: DateTime.
- udate
Template: DateTime.
- edate
Template: DateTime.
- scoreValues
Template: LongText. A composite field.
- links
Field components:
-
Uses template:
ShortText. - Contains the following components: bounceLogs, contactAutomations, contactData, contactGoals, contactLists, contactLogs, contactTags, contactDeals, deals, fieldValues, geoIps, notes, organization, plusAppend, trackingLogs, scoreValues.
-
Uses template:
- organization
Template: ShortText.
- [External]
-
The external fields URL address:
/fields. The external fields list is extracted from:{{=response.fields}}.- custom.{{=external.title}}
Data type: {{=ActiveCampaign.getDataType(external.type)}} ( length 255 ) The value is gathered from
/contacts/{{=item.id}}/fieldValuesaddress. The gathered value is processed with{{=response[field.external.id]}}expression.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/deals.Documentation: https://developers.activecampaign.com/reference#list-all-deals.
- [Create] action
-
Endpoint URL address:
/deals.Documentation: https://developers.activecampaign.com/reference#create-a-deal.
- [Update] action
-
Endpoint URL address:
/deals/{{=item.id}}.Documentation: https://developers.activecampaign.com/reference#update-a-deal.
- [Delete] action
-
Endpoint URL address:
/deals/{{=item.id}}.Documentation: https://developers.activecampaign.com/reference#delete-a-deal.
- id
A key field. Template: Id.
- activitycount
Data type: DT_I4
- cdate
Template: DateTime.
- contact
Template: Id.
- currency
Template: ShortText.
- edate
Template: DateTime.
- group
Template: ShortText.
- hash
Template: ShortText.
- links
Field components:
-
Uses template:
ShortText. - Contains the following components: dealActivities, contact, contactDeals, group, nextTask, notes, organization, owner, scoreValues, stage, tasks.
-
Uses template:
- mdate
Template: DateTime.
- nextTask
Template: ShortText.
- nextdate
Template: DateTime.
- nextdealid
Template: Id.
- nexttaskid
Template: Id.
- organization
Template: ShortText.
- owner
Template: Id.
- percent
Template: ShortText.
- stage
Template: ShortText.
- status
Template: ShortText.
- title
Template: ShortText.
- description
Template: ShortText.
- value
Template: ShortText.
- [External]
-
The external fields URL address:
/dealCustomFieldMeta. The external fields list is extracted from:{{=response.dealCustomFieldMeta}}.- custom.{{=external.fieldLabel}}
Data type: {{=ActiveCampaign.getDataType(external.fieldType)}} ( length 255 ) The value is gathered from
/deals/{{=item.id}}/dealCustomFieldDataaddress. The gathered value is processed with{{=response[field.external.id]}}expression.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/dealGroups.Documentation: https://developers.activecampaign.com/reference#list-all-pipelines.
- [Create] action
-
Endpoint URL address:
/dealGroups.Documentation: https://developers.activecampaign.com/reference#create-a-pipeline.
- [Update] action
-
Endpoint URL address:
/dealGroups/{{=item.id}}.Documentation: https://developers.activecampaign.com/reference#update-a-pipeline.
- [Delete] action
-
Endpoint URL address:
/dealGroups/{{=item.id}}.Documentation: https://developers.activecampaign.com/reference#delete-a-pipeline.
- id
A key field. Template: Id.
- allgroups
Template: ShortText.
- allusers
Template: ShortText.
- autoassign
Template: ShortText.
- cdate
Template: DateTime.
- currency
Template: ShortText.
- links
Field components:
-
Uses template:
ShortText. - Contains the following components: dealGroupGroups, dealGroupUsers, stages.
-
Uses template:
- stages
Template: LongText. A composite field.
- title
Template: ShortText.
- udate
Template: DateTime.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/dealStages.Documentation: https://developers.activecampaign.com/reference#list-all-deal-stages.
- [Create] action
-
Endpoint URL address:
/dealStages.Documentation: https://developers.activecampaign.com/reference#create-a-deal-stage.
- [Update] action
-
Endpoint URL address:
/dealStages/{{=item.id}}.Documentation: https://developers.activecampaign.com/reference#update-a-deal-stage.
- [Delete] action
-
Endpoint URL address:
/dealStages/{{=item.id}}.Documentation: https://developers.activecampaign.com/reference#delete-a-deal-stage.
- id
A key field. Template: Id.
- cardRegion1
Template: ShortText.
- cardRegion2
Template: ShortText.
- cardRegion3
Template: ShortText.
- cardRegion4
Template: ShortText.
- cardRegion5
Template: ShortText.
- cdate
Template: DateTime.
- color
Template: ShortText.
- dealOrder
Template: ShortText.
- group
Template: ShortText.
- links
Field components:
-
Uses template:
ShortText. - Contains the following components: group.
-
Uses template:
- order
Template: ShortText.
- title
Template: ShortText.
- udate
Template: DateTime.
- width
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/connections.Documentation: https://developers.activecampaign.com/reference#list-all-connections.
- [Create] action
-
Endpoint URL address:
/connections.Documentation: https://developers.activecampaign.com/reference#create-connection.
- [Update] action
-
Endpoint URL address:
/connections/{{=item.id}}.Documentation: https://developers.activecampaign.com/reference#update-connection.
- [Delete] action
-
Endpoint URL address:
/connections/{{=item.id}}.Documentation: https://developers.activecampaign.com/reference#delete-connection.
- id
A key field. Template: Id.
- service
Template: ShortText.
- externalid
Template: Id.
- name
Template: ShortText.
- isInternal
Template: ShortText.
- status
Template: ShortText.
- syncStatus
Template: ShortText.
- lastSync
Template: DateTime.
- logoUrl
Template: ShortText.
- linkUrl
Template: ShortText.
- cdate
Template: DateTime.
- udate
Template: DateTime.
- links
Field components:
-
Uses template:
ShortText. - Contains the following components: customers.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/ecomCustomers.Documentation: https://developers.activecampaign.com/reference#list-all-customers.
- [Create] action
-
Endpoint URL address:
/ecomCustomers.Documentation: https://developers.activecampaign.com/reference#create-customer.
- [Update] action
-
Endpoint URL address:
/ecomCustomers/{{=item.id}}.Documentation: https://developers.activecampaign.com/reference#update-customer.
- [Delete] action
-
Endpoint URL address:
/ecomCustomers/{{=item.id}}.Documentation: https://developers.activecampaign.com/reference#delete-customer.
- id
A key field. Template: Id.
- connectionid
Template: Id.
- externalid
Template: Id.
Template: ShortText.
- totalRevenue
Data type: DT_R8
- totalOrders
Data type: DT_I4
- totalProducts
Data type: DT_I4
- avgRevenuePerOrder
Data type: DT_R8
- avgProductCategory
Template: ShortText.
- tstamp
Template: DateTime.
- links
Field components:
-
Uses template:
ShortText. - Contains the following components: connection, orders.
-
Uses template:
- connection
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/ecomOrders.Documentation: https://developers.activecampaign.com/reference#list-all-orders.
- [Create] action
-
Endpoint URL address:
/ecomOrders.Documentation: https://developers.activecampaign.com/reference#create-order.
- [Update] action
-
Endpoint URL address:
/ecomOrders/{{=item.id}}.Documentation: https://developers.activecampaign.com/reference#update-order.
- [Delete] action
-
Endpoint URL address:
/ecomOrders/{{=item.id}}.Documentation: https://developers.activecampaign.com/reference#delete-order.
- id
A key field. Template: Id.
- externalid
Template: Id.
- source
Template: ShortText.
Template: ShortText.
- currency
Template: ShortText.
- connectionid
Template: Id.
- customerid
Template: Id.
- orderUrl
Template: ShortText.
- shippingMethod
Template: ShortText.
- totalPrice
Data type: DT_R8
- shippingAmount
Data type: DT_R8
- taxAmount
Data type: DT_R8
- discountAmount
Data type: DT_R8
- externalCreatedDate
Template: DateTime.
- totalProducts
Data type: DT_I4
- createdDate
Template: DateTime.
- updatedDate
Template: DateTime.
- state
Data type: DT_I4
- connection
Template: ShortText.
- orderProducts
Template: LongText. A composite field.
- customer
Template: ShortText.
- orderDate
Template: DateTime.
- tstamp
Template: DateTime.
- links
Field components:
-
Uses template:
ShortText. - Contains the following components: connection, customer, orderProducts, orderActivities.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/ecomOrderProducts.Documentation: https://developers.activecampaign.com/reference#list-ecomorderproducts.
- id
A key field. Template: Id.
- orderid
Template: Id.
- connectionid
Template: Id.
- externalid
Template: Id.
- sku
Template: ShortText.
- name
Template: ShortText.
- description
Template: ShortText.
- price
Data type: DT_R8
- quantity
Data type: DT_I4
- category
Template: ShortText.
- imageUrl
Template: ShortText.
- productUrl
Template: ShortText.
- createdDate
Template: DateTime.
- updatedDate
Template: DateTime.
- tstamp
Template: DateTime.
- links
Field components:
-
Uses template:
ShortText. - Contains the following components: ecomOrder.
-
Uses template:
- ecomOrder
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/forms.Documentation: https://developers.activecampaign.com/reference#forms-1.
- id
A key field. Template: Id.
- name
Template: ShortText.
- action
Template: ShortText.
- actiondata
Field components:
- Contains the following components: actions.
- submit
Template: ShortText.
- submitdata
Field components:
-
Uses template:
ShortText. - Contains the following components: url.
-
Uses template:
- url
Template: ShortText.
- layout
Template: ShortText.
- title
Template: ShortText.
- body
Template: ShortText.
- button
Template: ShortText.
- thanks
Template: ShortText.
- style
Field components:
-
Uses template:
ShortText. - Contains the following components: background, dark, fontcolor, layout, border, width, ac_branding, button.
-
Uses template:
- options
Field components:
-
Uses template:
ShortText. - Contains the following components: blanks_overwrite, confaction, sendoptin, optin_id, optin_created, confform.
-
Uses template:
- cfields
Field components:
- An array.
- Contains the following components: type, header, class.
- parentformid
Template: Id.
- userid
Template: Id.
- addressid
Template: Id.
- cdate
Template: DateTime.
- udate
Template: DateTime.
- entries
Template: ShortText.
- aid
Template: Id.
- defaultscreenshot
Template: ShortText.
- recent
Template: LongText. A composite field.
- contacts
Data type: DT_I4
- deals
Data type: DT_I4
- links
Field components:
-
Uses template:
ShortText. - Contains the following components: address.
-
Uses template:
- address
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/lists.Documentation: https://developers.activecampaign.com/reference#retrieve-all-lists.
- [Create] action
-
Endpoint URL address:
/lists.Documentation: https://developers.activecampaign.com/reference#create-new-list.
- [Delete] action
-
Endpoint URL address:
/lists/{{=item.id}}.Documentation: https://developers.activecampaign.com/reference#delete-a-list.
- id
A key field. Template: Id.
- stringid
Template: Id.
- userid
Template: Id.
- name
Template: ShortText.
- cdate
Template: DateTime.
- p_use_tracking
Template: ShortText.
- p_use_analytics_read
Template: ShortText.
- p_use_analytics_link
Template: ShortText.
- p_use_twitter
Template: ShortText.
- p_use_facebook
Template: ShortText.
- p_embed_image
Template: ShortText.
- p_use_captcha
Template: ShortText.
- send_last_broadcast
Template: ShortText.
- private
Template: ShortText.
- analytics_domains
Template: ShortText.
- analytics_source
Template: ShortText.
- analytics_ua
Template: ShortText.
- twitter_token
Template: ShortText.
- twitter_token_secret
Template: ShortText.
- facebook_session
Template: ShortText.
- carboncopy
Template: ShortText.
- subscription_notify
Template: ShortText.
- unsubscription_notify
Template: ShortText.
- require_name
Template: ShortText.
- get_unsubscribe_reason
Template: ShortText.
- to_name
Template: ShortText.
- optinoptout
Template: ShortText.
- sender_name
Template: ShortText.
- sender_addr1
Template: ShortText.
- sender_addr2
Template: ShortText.
- sender_city
Template: ShortText.
- sender_state
Template: ShortText.
- sender_zip
Template: ShortText.
- sender_country
Template: ShortText.
- sender_phone
Template: ShortText.
- sender_url
Template: ShortText.
- sender_reminder
Template: ShortText.
- fulladdress
Template: ShortText.
- optinmessageid
Template: Id.
- optoutconf
Template: ShortText.
- deletestamp
Template: DateTime.
- udate
Template: DateTime.
- links
Field components:
-
Uses template:
ShortText. - Contains the following components: contactGoalLists, user, addressLists.
-
Uses template:
- user
Template: ShortText.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/notes.Documentation: https://developers.activecampaign.com/reference#create-a-note.
- [Update] action
-
Endpoint URL address:
/notes/{{=item.id}}.Documentation: https://developers.activecampaign.com/reference#update-a-note.
- [Delete] action
-
Endpoint URL address:
/notes/{{=item.id}}.Documentation: https://developers.activecampaign.com/reference#delete-note.
- id
A key field. Template: Id.
- relid
Template: Id.
- reltype
Template: ShortText.
- userid
Template: Id.
- cdate
Template: DateTime.
- mdate
Template: DateTime.
- note
Template: LongText.
- links
Field components:
-
Uses template:
ShortText. - Contains the following components: activities, user, mentions, notes, owner.
-
Uses template:
- user
Template: ShortText.
- owner
Field components:
-
Uses template:
ShortText. - Contains the following components: type, id.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/savedResponses.Documentation: https://developers.activecampaign.com/reference#list-all-saved-responses.
- [Create] action
-
Endpoint URL address:
/savedResponses.Documentation: https://developers.activecampaign.com/reference#saved-responses.
- [Update] action
-
Endpoint URL address:
/savedResponses/{{=item.id}}.Documentation: https://developers.activecampaign.com/reference#update-a-saved-response.
- [Delete] action
-
Endpoint URL address:
/savedResponses/{{=item.id}}.Documentation: https://developers.activecampaign.com/reference#retrieve-a-savedresponse.
- id
A key field. Template: Id.
- title
Template: ShortText.
- subject
Template: ShortText.
- body
Template: LongText.
- ldate
Template: DateTime.
- last_sent_user_id
Template: Id.
- cdate
Template: DateTime.
- mdate
Template: DateTime.
- links
Field components:
-
Uses template:
ShortText. - Contains the following components: user, savedResponseCategorySavedResponse.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/scores.Documentation: https://developers.activecampaign.com/reference#list-all-scores.
- id
A key field. Template: Id.
- reltype
Template: ShortText.
- name
Template: ShortText.
- descript
Template: ShortText.
- status
Template: ShortText.
- cdate
Template: DateTime.
- mdate
Template: DateTime.
- links
Template: LongText. A composite field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/segments.Documentation: https://developers.activecampaign.com/reference#list-all-segments.
- id
A key field. Template: Id.
- name
Template: ShortText.
- logic
Template: ShortText.
- hidden
Template: ShortText.
- seriesid
Template: Id.
- links
Template: LongText. A composite field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/tags.Documentation: https://developers.activecampaign.com/reference#retrieve-all-tags.
- [Create] action
-
Endpoint URL address:
/tags.Documentation: https://developers.activecampaign.com/reference#create-a-new-tag.
- [Update] action
-
Endpoint URL address:
/tags/{{=item.id}}.Documentation: https://developers.activecampaign.com/reference#update-a-tag.
- [Delete] action
-
Endpoint URL address:
/tags/{{=item.id}}.Documentation: https://developers.activecampaign.com/reference#remove-a-tag.
- id
A key field. Template: Id.
- tagType
Template: ShortText.
- tag
Template: ShortText.
- description
Template: LongText.
- cdate
Template: DateTime. A read-only field.
- links
Field components:
-
Uses template:
ShortText. - Contains the following components: contactGoalTags.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/dealTasks.Documentation: https://developers.activecampaign.com/reference#list-all-tasks.
- [Create] action
-
Endpoint URL address:
/dealTasks.Documentation: https://developers.activecampaign.com/reference#create-task.
- [Update] action
-
Endpoint URL address:
/dealTasks/{{=item.id}}.Documentation: https://developers.activecampaign.com/reference#update-task.
- [Delete] action
-
Endpoint URL address:
/dealTasks/{{=item.id}}.Documentation: https://developers.activecampaign.com/reference#delete-task.
- id
A key field. Template: Id.
- duedate
Template: DateTime.
- edate
Template: DateTime.
- status
Data type: DT_I4
- title
Template: ShortText.
- note
Template: ShortText.
- relid
Template: Id.
- reltype
Template: ShortText.
- dealTasktype
Template: ShortText.
- cdate
Template: DateTime.
- udate
Template: DateTime.
- automation
Template: ShortText.
- doneAutomation
Template: ShortText.
- user
Template: ShortText.
- assignee
Template: ShortText.
- owner
Field components:
-
Uses template:
ShortText. - Contains the following components: type, id.
-
Uses template:
- links
Field components:
-
Uses template:
ShortText. - Contains the following components: activities, automation, dealTasktype, doneAutomation, notes, owner, taskNotifications, user, assignee.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/dealTasktypes.Documentation: https://developers.activecampaign.com/reference#list-all-deal-task-types.
- [Create] action
-
Endpoint URL address:
/dealTasktypes.Documentation: https://developers.activecampaign.com/reference#create-a-deal-task-type.
- [Update] action
-
Endpoint URL address:
/dealTasktypes/{{=item.id}}.Documentation: https://developers.activecampaign.com/reference#update-a-deal-task-type.
- [Delete] action
-
Endpoint URL address:
/dealTasktypes/{{=item.id}}.Documentation: https://developers.activecampaign.com/reference#delete-a-deal-task-type.
- id
A key field. Template: Id.
- cdate
Template: DateTime.
- defduration
Template: ShortText.
- links
Template: LongText. A composite field.
- status
Template: ShortText.
- title
Template: ShortText.
- udate
Template: DateTime.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/users.Documentation: https://developers.activecampaign.com/reference#list-all-users.
- [Create] action
-
Endpoint URL address:
/users.Documentation: https://developers.activecampaign.com/reference#create-user.
- [Update] action
-
Endpoint URL address:
/users/{{item.id}}.Documentation: https://developers.activecampaign.com/reference#update-user.
- [Delete] action
-
Endpoint URL address:
/users/{{item.id}}.Documentation: https://developers.activecampaign.com/reference#delete-user.
- id
A key field. Template: Id.
- username
Template: ShortText.
- firstName
Template: ShortText.
- lastName
Template: ShortText.
Template: ShortText.
- phone
Template: ShortText.
- signature
Template: ShortText.
- links
Field components:
-
Uses template:
ShortText. - Contains the following components: lists, userGroup, dealGroupTotals, dealGroupUsers, configs.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/groups.Documentation: https://developers.activecampaign.com/reference#list-all-groups.
- [Create] action
-
Endpoint URL address:
/groups.Documentation: https://developers.activecampaign.com/reference#create-a-new-group.
- [Update] action
-
Endpoint URL address:
/groups/{{=item.id}}.Documentation: https://developers.activecampaign.com/reference#update-a-group.
- [Delete] action
-
Endpoint URL address:
/groups/{{=item.id}}.Documentation: https://developers.activecampaign.com/reference#delete-a-group-1.
- id
A key field. Template: Id.
- title
Template: ShortText.
- descript
Template: ShortText.
- unsubscribelink
Template: ShortText.
- optinconfirm
Template: ShortText.
- p_admin
Template: ShortText.
- pgListAdd
Template: ShortText.
- pgListEdit
Template: ShortText.
- pgListDelete
Template: ShortText.
- pgListHeaders
Template: ShortText.
- pgListEmailaccount
Template: ShortText.
- pgListBounce
Template: ShortText.
- pgMessageAdd
Template: ShortText.
- pgMessageEdit
Template: ShortText.
- pgMessageDelete
Template: ShortText.
- pgMessageSend
Template: ShortText.
- pgContactAdd
Template: ShortText.
- pgContactEdit
Template: ShortText.
- pgContactDelete
Template: ShortText.
- pgContactMerge
Template: ShortText.
- pgContactImport
Template: ShortText.
- pgContactApprove
Template: ShortText.
- pgContactExport
Template: ShortText.
- pgContactSync
Template: ShortText.
- pgContactFilters
Template: ShortText.
- pgContactActions
Template: ShortText.
- pgContactFields
Template: ShortText.
- pg_user_add
Template: ShortText.
- pg_user_edit
Template: ShortText.
- pg_user_delete
Template: ShortText.
- pgGroupAdd
Template: ShortText.
- pgGroupEdit
Template: ShortText.
- pgGroupDelete
Template: ShortText.
- pgTemplateAdd
Template: ShortText.
- pgTemplateEdit
Template: ShortText.
- pgTemplateDelete
Template: ShortText.
- pgPersonalizationAdd
Template: ShortText.
- pgPersonalizationEdit
Template: ShortText.
- pgPersonalizationDelete
Template: ShortText.
- pgAutomationManage
Template: ShortText.
- pgFormEdit
Template: ShortText.
- pgReportsCampaign
Template: ShortText.
- pgReportsList
Template: ShortText.
- pgReportsUser
Template: ShortText.
- pgReportsTrend
Template: ShortText.
- pgStartupReports
Template: ShortText.
- pgStartupGettingstarted
Template: ShortText.
- pgDeal
Template: ShortText.
- pgDealDelete
Template: ShortText.
- pgDealReassign
Template: ShortText.
- pgDealGroupAdd
Template: ShortText.
- pgDealGroupEdit
Template: ShortText.
- pgDealGroupDelete
Template: ShortText.
- pgSavedResponsesManage
Template: ShortText.
- sdate
Template: DateTime.
- reqApproval
Template: ShortText.
- reqApproval1st
Template: ShortText.
- reqApprovalNotify
Template: ShortText.
- socialdata
Template: ShortText.
- links
Field components:
-
Uses template:
ShortText. - Contains the following components: userGroups, groupLimit, dealGroupGroups, listGroups, addressGroups, automationGroups.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/webhooks.Documentation: https://developers.activecampaign.com/reference#get-a-list-of-webhooks.
- [Create] action
-
Endpoint URL address:
/webhooks.Documentation: https://developers.activecampaign.com/reference#create-webhook.
- [Update] action
-
Endpoint URL address:
/webhooks/{{=item.id}}.Documentation: https://developers.activecampaign.com/reference#update-webhook.
- [Delete] action
-
Endpoint URL address:
/webhooks/{{=item.id}}.Documentation: https://developers.activecampaign.com/reference#delete-webhook.
- id
A key field. Template: Id.
- cdate
Template: DateTime.
- listid
Template: Id.
- name
Template: ShortText.
- url
Template: ShortText.
- events
Template: LongText. A composite field.
- sources
Template: LongText. A composite field.
- links
Template: LongText. A composite field.
- [Read] action
-
The result is extracted from:{{=response[resource.objects]}}.
The result is paginated.The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}}
-
offset:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{=function(item) { var result = {}; result[resource.object] = item; return result; }(item)}}
-
application/json:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
application/json:
{{=function(item) { var result = {}; result[resource.object] = item; return result; }(item)}}
-
application/json:
- [Delete] action
-
The action uses DELETE method.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- Id
Data type: DT_I4
- DateTime
Data type: DT_DBTIMESTAMP
What's New
- Fixed: Failure to create/update records (Thank you, Marc).
- 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.