ActiveCampaign Connector Objects
Name | Description |
---|---|
AccountContacts | Usage information for the operation AccountContacts.rsd. |
AccountCustomFieldData | Create, modify, delete and query the available deal custom field data in ActiveCampaign. |
Accounts | View many or all contacts by including their ID's or various filters. |
Addresses | Usage information for the operation Addresses.rsd. |
Automations | Usage information for the operation Automations.rsd. |
Campaigns | Query the campaigns information in ActiveCampaign. |
ContactAutomations | View many or all contacts by including their ID's or various filters. |
ContactCustomFieldData | Create, modify, delete and query the available contact custom field data in ActiveCampaign. |
ContactLists | Retrieve ContactList for each contact Group or for the specific Contact group. |
Contacts | View many or all contacts by including their ID's or various filters. |
ContactTags | Retrieve tags added for each contact or for the specific Contact Id |
DealActivities | Retrieve Deal Activities for each Deal or for the specific Deal Id. |
DealCustomFieldData | Create, modify, delete and query the available deal custom field data in ActiveCampaign. |
DealGroups | Lists all existing accounts. |
Deals | Usage information for the operation Deals.rsd. |
DealStages | Usage information for the operation DealStages.rsd. |
Lists | Usage information for the operation Lists.rsd. |
Scores | View many or all contacts by including their ID's or various filters. |
Tags | View many or all tags by including their ID's or various filters. |
Tasks | Lists all existing accounts. |
TrackingLogs | Retrieve trackingLogs for the specific contact or all contacts |
Users | Usage information for the operation Users.rsd. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id of the account-contact association. | |
AccountId | String | False | Accounts.Id | No | The account Id. |
ContactId | String | False | Contacts.Id | No | The contact Id. |
CreatedTimestamp | Datetime | True | No | Datetime value which indicates when the assosiaction was created. | |
JobTitle | String | False | No | Job Title of the contact at the account. | |
AccountLink | String | True | No | Account link. | |
ContactLink | String | True | No | Contact link. | |
UpdatedTimestamp | Datetime | True | No | Datetime value which indicates when the assosiaction was last updated. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id of the account custom field data. | |
AccountCustomFieldMetumId | Integer | True | No | The custom field metum Id. | |
AccountId | Integer | False | No | The ID of the account the field value relates to. | |
CreatedTimestamp | Datetime | True | No | Datetime value that indicates when the custom field value was set. | |
CustomFieldId | Integer | False | No | The ID of the custom field metum the field value relates to. | |
CustomFieldName | String | True | No | The name of the custom field metum the field value relates to. | |
FieldValue | String | False | No | Values for the field. (For currency field only, this needs to be in cents: eg, 10050 = 100.5). | |
AccountLink | String | True | No | Account link. | |
AccountCustomFieldMetumLink | String | True | No | AccountCustomFieldMetum link. | |
UpdatedTimestamp | Datetime | True | No | Datetime value which indicates when the custom field data was last updated. | |
FieldCurrency | String | False | No | Value of the custom field currency type for a specific contact. This field is required when inserting currency custom fields. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id column of the Accounts table. | |
AccountUrl | String | False | No | Account's website. | |
ContactCount | Integer | True | No | The ContactCount column of the Accounts table. | |
CreatedTimestamp | Datetime | True | No | The CreatedTimestamp column of the Accounts table. | |
DealCount | Integer | True | No | The DealCount column of the Accounts table. | |
AccountContactsLink | String | True | No | The AccountContactsLink column of the Accounts table. | |
AccountCustomFieldDataLink | String | True | No | The AccountCustomFieldDataLink column of the Accounts table. | |
ContactEmailsLink | String | True | No | The ContactEmailsLink column of the Accounts table. | |
EmailActivitiesLink | String | True | No | The EmailActivitiesLink column of the Accounts table. | |
NotesLink | String | True | No | The NotesLink column of the Accounts table. | |
Name | String | False | No | Account's name. | |
UpdatedTimestamp | Datetime | True | No | The UpdatedTimestamp column of the Accounts table. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id | String | True | No | The Id column of the Addresses table. | |
Address1 | String | True | No | The Address1 column of the Addresses table. | |
Address2 | String | True | No | The Address2 column of the Addresses table. | |
Allgroup | String | True | No | The Allgroup column of the Addresses table. | |
City | String | True | No | The City column of the Addresses table. | |
CompanyName | String | True | No | The CompanyName column of the Addresses table. | |
Country | String | True | No | The Country column of the Addresses table. | |
District | String | True | No | The District column of the Addresses table. | |
isDefault | String | True | No | The isDefault column of the Addresses table. | |
AddressGroupLink | String | True | No | The AddressGroupLink column of the Addresses table. | |
AddressListLink | String | True | No | The AddressListLink column of the Addresses table. | |
FormsLink | String | True | No | The FormsLink column of the Addresses table. | |
State | String | True | No | The State column of the Addresses table. | |
Zip | String | True | No | The Zip column of the Addresses table. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id | String | True | No | The Id column of the Automations table. | |
Cdate | Datetime | True | No | The Cdate column of the Automations table. | |
DefaultScreenshot | String | True | No | The DefaultScreenshot column of the Automations table. | |
Entered | String | True | No | The Entered column of the Automations table. | |
Exited | String | True | No | The Exited column of the Automations table. | |
Hidden | String | True | No | The Hidden column of the Automations table. | |
BlocksLink | String | True | No | The BlocksLink column of the Automations table. | |
CampaignsLink | String | True | No | The CampaignsLink column of the Automations table. | |
ContactAutomationsLink | String | True | No | The ContactAutomationsLink column of the Automations table. | |
ContactGoalsLink | String | True | No | The ContactGoalsLink column of the Automations table. | |
GoalsLink | String | True | No | The GoalsLink column of the Automations table. | |
SiteMessagesLink | String | True | No | The SiteMessagesLink column of the Automations table. | |
SmsLink | String | True | No | The SmsLink column of the Automations table. | |
Mdate | Datetime | True | No | The Mdate column of the Automations table. | |
Name | String | True | No | The Name column of the Automations table. | |
Screenshot | String | True | No | The Screenshot column of the Automations table. | |
Status | String | True | No | The Status column of the Automations table. | |
UserId | String | True | No | The UserId column of the Automations table. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id column of the Campaigns table. | |
ActiveRssInterval | String | True | No | The ActiveRssInterval column of the Campaigns table. | |
ActiveRssItems | String | True | No | The ActiveRssItems column of the Campaigns table. | |
ActiveRssUrl | String | True | No | The ActiveRssUrl column of the Campaigns table. | |
AddressId | String | True | No | The AddressId column of the Campaigns table. | |
AnalyticsCampaignName | String | True | No | The AnalyticsCampaignName column of the Campaigns table. | |
Automation | String | True | No | The Automation column of the Campaigns table. | |
BaseMessageId | String | True | No | The BaseMessageId column of the Campaigns table. | |
BaseTemplateId | String | True | No | The BaseTemplateId column of the Campaigns table. | |
BounceId | String | True | No | The BounceId column of the Campaigns table. | |
CanSkipApproval | String | True | No | The can_skip_approval column of the Campaigns table. | |
Cdate | Datetime | True | No | The Cdate column of the Campaigns table. | |
CreatedBy | String | True | No | The Created By column of the Campaigns table. | |
CreatedTimestamp | Datetime | True | No | The Created Timestamp column of the Campaigns table. | |
DeleteStamp | String | True | No | The DeleteStamp column of the Campaigns table. | |
EmbedImages | String | True | No | The EmbedImages column of the Campaigns table. | |
String | True | No | The Facebook column of the Campaigns table. | ||
FormId | String | True | No | The FormId column of the Campaigns table. | |
Forwards | String | True | No | The Forwards column of the Campaigns table. | |
HardBounces | String | True | No | The HardBounces column of the Campaigns table. | |
HasPredictiveContent | Bit | True | No | The HasPredictiveContent column of the Campaigns table. | |
HtmlUnsub | String | True | No | The HtmlUnsub column of the Campaigns table. | |
HtmlUnsubdata | String | True | No | The HtmlUnsubdata column of the Campaigns table. | |
Ip | String | True | No | The Ip column of the Campaigns table. | |
Ip4 | String | True | No | The Ip4 column of the Campaigns table. | |
LastStep | String | True | No | The LastStep column of the Campaigns table. | |
Ldate | String | True | No | The Ldate column of the Campaigns table. | |
LinkClicks | String | True | No | The LinkClicks column of the Campaigns table. | |
AutomationLink | String | True | No | The AutomationLink column of the Campaigns table. | |
CampaignAggregateRevenuesLink | String | True | No | The AggregateRevenues column of the Campaigns table. | |
CampaignListsLink | String | True | No | The CampaignListsLink column of the Campaigns table. | |
CampaignMessageLink | String | True | No | The CampaignMessageLink column of the Campaigns table. | |
CampaignMessagesLink | String | True | No | The CampaignMessagesLink column of the Campaigns table. | |
LinksLink | String | True | No | The LinksLink column of the Campaigns table. | |
LinksSegment | String | True | No | The Segment column of the Campaigns table. | |
UserLink | String | True | No | The UserLink column of the Campaigns table. | |
MailCleanup | String | True | No | The MailCleanup column of the Campaigns table. | |
MailSend | String | True | No | The MailSend column of the Campaigns table. | |
MailTransfer | String | True | No | The MailTransfer column of the Campaigns table. | |
MailerLogFile | String | True | No | The MailerLogFile column of the Campaigns table. | |
ManageText | String | True | No | The ManageText column of the Campaigns table. | |
Mdate | Datetime | True | No | The Mdate column of the Campaigns table. | |
Name | String | True | No | The Name column of the Campaigns table. | |
Opens | String | True | No | The Opens column of the Campaigns table. | |
Public | String | True | No | The Public column of the Campaigns table. | |
RealCid | String | True | No | The RealCid column of the Campaigns table. | |
Recurring | String | True | No | The Recurring column of the Campaigns table. | |
ReminderField | String | True | No | The ReminderField column of the Campaigns table. | |
ReminderFormat | String | True | No | The ReminderFormat column of the Campaigns table. | |
ReminderLastCronRun | String | True | No | The ReminderLastCronRun column of the Campaigns table. | |
ReminderOffset | String | True | No | The ReminderOffset column of the Campaigns table. | |
ReminderOffsetSign | String | True | No | The ReminderOffsetSign column of the Campaigns table. | |
ReminderOffsetType | String | True | No | The ReminderOffsetType column of the Campaigns table. | |
ReminderType | String | True | No | The ReminderType column of the Campaigns table. | |
Replies | String | True | No | The Replies column of the Campaigns table. | |
ReplySys | String | True | No | The ReplySys column of the Campaigns table. | |
ResponderExisting | String | True | No | The ResponderExisting column of the Campaigns table. | |
ResponderOffset | String | True | No | The ResponderOffset column of the Campaigns table. | |
ResponderType | String | True | No | The ResponderType column of the Campaigns table. | |
Schedule | String | True | No | The Schedule column of the Campaigns table. | |
ScheduledDate | String | True | No | The ScheduledDate column of the Campaigns table. | |
Screenshot | String | True | No | The Screenshot column of the Campaigns table. | |
Sdate | String | True | No | The Sdate column of the Campaigns table. | |
SegmentId | String | True | No | The SegmentId column of the Campaigns table. | |
SegmentName | String | True | No | The SegmentName column of the Campaigns table. | |
SendAmt | String | True | No | The SendAmt column of the Campaigns table. | |
SendId | String | True | No | The SendId column of the Campaigns table. | |
SeriesId | String | True | No | The SeriesId column of the Campaigns table. | |
Series Send Lock Time | String | True | No | The SeriesSendLockTime column of the Campaigns table. | |
SocialShares | String | True | No | The SocialShares column of the Campaigns table. | |
SoftBounces | String | True | No | The SoftBounces column of the Campaigns table. | |
Source | String | True | No | The Source column of the Campaigns table. | |
SplitContent | String | True | No | The SplitContent column of the Campaigns table. | |
SplitOffset | String | True | No | The SplitOffset column of the Campaigns table. | |
SplitOffsetType | String | True | No | The SplitOffsetType column of the Campaigns table. | |
SplitType | String | True | No | The SplitType column of the Campaigns table. | |
SplitWinnerAwaiting | String | True | No | The SplitWinnerAwaiting column of the Campaigns table. | |
SplitWinnerMessageId | String | True | No | The SplitWinnerMessageId column of the Campaigns table. | |
Status | String | True | No | The Status column of the Campaigns table. | |
SubscriberClicks | String | True | No | The SubscriberClicks column of the Campaigns table. | |
Survey | String | True | No | The Survey column of the Campaigns table. | |
TextUnsub | String | True | No | The TextUnsub column of the Campaigns table. | |
TextUnsubData | String | True | No | The TextUnsubData column of the Campaigns table. | |
ThreadId | String | True | No | The ThreadId column of the Campaigns table. | |
TotalAmt | String | True | No | The TotalAmt column of the Campaigns table. | |
TrackLinks | String | True | No | The TrackLinks column of the Campaigns table. | |
TrackLinksAnalytics | String | True | No | The TrackLinksAnalytics column of the Campaigns table. | |
TrackReads | String | True | No | The TrackReads column of the Campaigns table. | |
TrackReadsAnalytics | String | True | No | The TrackReadsAnalytics column of the Campaigns table. | |
Tweet | String | True | No | The Tweet column of the Campaigns table. | |
Type | String | True | No | The Type column of the Campaigns table. | |
UniqueForwards | String | True | No | The UniqueForwards column of the Campaigns table. | |
UniqueLinkClicks | String | True | No | The UniqueLinkClicks column of the Campaigns table. | |
UniqueOpens | String | True | No | The UniqueOpens column of the Campaigns table. | |
UniqueReplies | String | True | No | The UniqueReplies column of the Campaigns table. | |
UnsubReasons | String | True | No | The UnsubReasons column of the Campaigns table. | |
Unsubscribes | String | True | No | The Unsubscribes column of the Campaigns table. | |
Updated By | String | True | No | The UpdatedBy column of the Campaigns table. | |
Updated Timestamp | String | True | No | The UpdatedTimestamp column of the Campaigns table. | |
Updates | String | True | No | The Updates column of the Campaigns table. | |
User | String | True | No | The User column of the Campaigns table. | |
UserId | String | True | No | The UserId column of the Campaigns table. | |
WaitPreview | String | True | No | The WaitPreview column of the Campaigns table. | |
WillRecur | String | True | No | The WillRecur column of the Campaigns table. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id | String | True | No | The Id column of the ContactAutomations table. | |
Adddate | Datetime | True | No | The Adddate column of the ContactAutomations table. | |
Automation | String | True | No | The Automation column of the ContactAutomations table. | |
Batchid | Unknown | True | No | The Batchid column of the ContactAutomations table. | |
CompleteValue | Integer | True | No | The CompleteValue column of the ContactAutomations table. | |
Completed | Integer | True | No | The Completed column of the ContactAutomations table. | |
CompletedElements | String | True | No | The CompletedElements column of the ContactAutomations table. | |
ContactId | String | True | Contacts.Id | No | The ContactId column of the ContactAutomations table. |
Lastblock | String | True | No | The Lastblock column of the ContactAutomations table. | |
Lastdate | Datetime | True | No | The Lastdate column of the ContactAutomations table. | |
LastLogId | String | True | No | The LastLogId column of the ContactAutomations table. | |
AutomationLink | String | True | No | The AutomationLink column of the ContactAutomations table. | |
ContactLink | String | True | No | The ContactLink column of the ContactAutomations table. | |
ContactGoalsLink | String | True | No | The ContactGoalsLink column of the ContactAutomations table. | |
Remdate | Datetime | True | No | The Remdate column of the ContactAutomations table. | |
SeriesId | String | True | No | The SeriesId column of the ContactAutomations table. | |
StartId | String | True | No | The StartId column of the ContactAutomations table. | |
Status | String | True | No | The Status column of the ContactAutomations table. | |
TimeSpan | String | True | No | The TimeSpan column of the ContactAutomations table. | |
TotalElements | String | True | No | The TotalElements column of the ContactAutomations table. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | The Id column of the ContactCustomFieldData table. | |
CDate | Datetime | False | No | The CDate column of the ContactCustomFieldData table. | |
ContactId | String | False | No | The ContactId column of the ContactCustomFieldData table. | |
CustomFieldName | String | True | No | The name of the custom field metum the field value relates to. | |
FieldId | String | False | No | ID of the field the value belongs to. | |
FieldLink | String | False | No | The FieldLink column of the ContactCustomFieldData table. | |
OwnerLink | String | False | No | The OwnerLink column of the ContactCustomFieldData table. | |
Owner | String | False | No | The Owner column of the ContactCustomFieldData table. | |
Udate | Datetime | False | No | The Udate column of the ContactCustomFieldData table. | |
FieldValue | String | False | No | Value of the custom field for a specific contact. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id column of the ContactLists table. | |
ContactId | String | True | Contacts.Id | No | The ContactId column of the ContactLists table. |
AutomationId | String | True | Automations.Id | No | The AutomationId column of the ContactLists table. |
AutosyncLog | String | True | No | The AutosyncLog column of the ContactLists table. | |
Campaign | String | True | No | The Campaign column of the ContactLists table. | |
CreatedBy | String | True | No | The CreatedBy column of the ContactLists table. | |
CreatedTimestamp | Datetime | True | No | The CreatedTimestamp column of the ContactLists table. | |
FirstName | String | True | No | The FirstName column of the ContactLists table. | |
Form | String | True | No | The Form column of the ContactLists table. | |
Ip4Sub | String | True | No | The Ip4Sub column of the ContactLists table. | |
Ip4Unsub | String | True | No | The Ip4Unsub column of the ContactLists table. | |
Ip4Last | String | True | No | The Ip4Last column of the ContactLists table. | |
LastName | String | True | No | The LastName column of the ContactLists table. | |
AutomationLink | String | True | No | The AutomationLink column of the ContactLists table. | |
AutosyncLogLink | String | True | No | The AutosyncLogLink column of the ContactLists table. | |
CampaignLink | String | True | No | The CampaignLink column of the ContactLists table. | |
ContactLink | String | True | No | The ContactLink column of the ContactLists table. | |
FormLink | String | True | No | The FormLink column of the ContactLists table. | |
ListLink | String | True | No | The ListLink column of the ContactLists table. | |
MessageLink | String | True | No | The MessageLink column of the ContactLists table. | |
UnsubscribeAutomationLink | String | True | No | The UnsubscribeAutomationLink column of the ContactLists table. | |
ListId | String | True | Lists.Id | No | The ListId column of the ContactLists table. |
Message | String | True | No | The Message column of the ContactLists table. | |
Responder | String | True | No | The Responder column of the ContactLists table. | |
Sdate | Datetime | True | No | The Sdate column of the ContactLists table. | |
SeriesId | String | True | No | The SeriesId column of the ContactLists table. | |
Status | String | True | No | The Status column of the ContactLists table. | |
SourceId | String | True | No | The SourceId column of the ContactLists table. | |
Sync | String | True | No | The Sync column of the ContactLists table. | |
Unsubreason | String | True | No | The Unsubreason column of the ContactLists table. | |
UnsubscribeAutomation | String | True | No | The UnsubscribeAutomation column of the ContactLists table. | |
UpdatedBy | String | True | No | The UpdatedBy column of the ContactLists table. | |
UpdatedTimestamp | Datetime | True | No | The UpdatedTimestamp column of the ContactLists table. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id column of the Contacts table. | |
Adate | Datetime | True | No | The Adate column of the Contacts table. | |
Anonymized | String | True | No | The Anonymized column of the Contacts table. | |
BouncedDate | String | True | No | The BouncedDate column of the Contacts table. | |
BouncedHard | String | True | No | The BouncedHard column of the Contacts table. | |
BouncedSoft | String | True | No | The BouncedSoft column of the Contacts table. | |
Cdate | Datetime | True | No | The Cdate column of the Contacts table. | |
CreatedBy | String | True | No | The CreatedBy column of the Contacts table. | |
CreatedTimestamp | Datetime | True | No | The CreatedTimestamp column of the Contacts table. | |
CreatedUtcTimestamp | Datetime | True | No | The CreatedUtcTimestamp column of the Contacts table. | |
Deleted | String | True | No | The Deleted column of the Contacts table. | |
DeletedAt | String | True | No | The DeletedAt column of the Contacts table. | |
Edate | Datetime | True | No | The Edate column of the Contacts table. | |
String | False | No | The Email column of the Contacts table. | ||
EmailDomain | String | True | No | The EmailDomain column of the Contacts table. | |
EmailEmpty | Boolean | True | No | The EmailEmpty column of the Contacts table. | |
EmailLocal | String | True | No | The EmailLocal column of the Contacts table. | |
FirstName | String | False | No | The FirstName column of the Contacts table. | |
Gravatar | String | True | No | The Gravatar column of the Contacts table. | |
Hash | String | True | No | The Hash column of the Contacts table. | |
Ip | String | True | No | The Ip column of the Contacts table. | |
LastName | String | False | No | The LastName column of the Contacts table. | |
AccountContactsLink | String | True | No | The AccountContactsLink column of the Contacts table. | |
AutomationEntryCountsLink | String | True | No | The AutomationEntryCountsLink column of the Contacts table. | |
BounceLogsLink | String | True | No | The BounceLogsLink column of the Contacts table. | |
ContactAutomationsLink | String | True | No | The ContactAutomationsLink column of the Contacts table. | |
ContactDataLink | String | True | No | The ContactDataLink column of the Contacts table. | |
ContactDealsLink | String | True | No | The ContactDealsLink column of the Contacts table. | |
ContactGoalsLink | String | True | No | The ContactGoalsLink column of the Contacts table. | |
ContactListsLink | String | True | No | The ContactListsLink column of the Contacts table. | |
ContactLogsLink | String | True | No | The ContactLogsLink column of the Contacts table. | |
ContactTagsLink | String | True | No | The ContactTagsLink column of the Contacts table. | |
DealsLink | String | True | No | The DealsLink column of the Contacts table. | |
FieldValuesLink | String | True | No | The FieldValuesLink column of the Contacts table. | |
GeoIpsLink | String | True | No | The GeoIpsLink column of the Contacts table. | |
NotesLink | String | True | No | The NotesLink column of the Contacts table. | |
OrganizationLink | String | True | No | The OrganizationLink column of the Contacts table. | |
PlusAppendLink | String | True | No | The PlusAppendLink column of the Contacts table. | |
ScoreValuesLink | String | True | No | The ScoreValuesLink column of the Contacts table. | |
TrackingLogsLink | String | True | No | The TrackingLogsLink column of the Contacts table. | |
Organization | String | True | No | The Organization column of the Contacts table. | |
Orgname | String | True | No | The Orgname column of the Contacts table. | |
Phone | String | False | No | The Phone column of the Contacts table. | |
RatingTStamp | String | True | No | The RatingTStamp column of the Contacts table. | |
SegmentioId | String | True | No | The SegmentioId column of the Contacts table. | |
Sentcnt | String | True | No | The Sentcnt column of the Contacts table. | |
SocialdataLastcheck | String | True | No | The SocialdataLastcheck column of the Contacts table. | |
Ua | String | True | No | The Ua column of the Contacts table. | |
Udate | Datetime | True | No | The Udate column of the Contacts table. | |
UpdatedTimestamp | String | True | No | The UpdatedTimestamp column of the Contacts table. | |
Updated_by | String | True | No | The Updated_by column of the Contacts table. | |
SubscribeTo | String | False | No | Comma-separated list of list Ids to subscribe a contact to. | |
UnsubscribeFrom | String | False | No | Comma-separated list of list Ids to unsubscribe a contact from. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id column of the ContactTags table. | |
ContactId | String | True | Contacts.Id | No | The ContactId column of the ContactTags table. |
Cdate | Datetime | True | No | The Cdate column of the ContactTags table. | |
CreatedBy | String | True | No | The CreatedBy column of the ContactTags table. | |
CreatedTimestamp | Datetime | True | No | The CreatedTimestamp column of the ContactTags table. | |
ContactLink | String | True | No | The ContactLink column of the ContactTags table. | |
TagLink | String | True | No | The TagLink column of the ContactTags table. | |
Tag | String | True | No | The Tag column of the ContactTags table. | |
UpdatedBy | String | True | No | The UpdatedBy column of the ContactTags table. | |
UpdatedTimestamp | Datetime | True | No | The UpdatedTimestamp column of the ContactTags table. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id of the activity. | |
DealId | String | True | Deals.Id | No | The Id of the Deal to which the activity belongs to. |
StageId | String | True | DealStages.Id | No | The Id of the Stage to which the parent Deal of the activity belongs to. |
UserId | String | True | Users.Id | No | The Id of the User which triggered the activity. |
DataId | String | True | No | The Id for the related object (e.g. a Task or Note or similar), if relevant. | |
DataType | String | True | No | The type of the activity. Examples include 'userid' or 'subscriberid' or 'task' or 'note' or empty quotes ('') for the deal's initial creation. | |
DataAction | String | True | No | The action taken by this activity. Examples include 'add' or 'complete' or the new value ('100') if the value is changing. | |
DataOldVal | String | True | No | The previous value, if the value has changed (see DataAction); otherwise, empty quotes ('') | |
CreatedDate | Datetime | True | No | The creation date of the activity. | |
SortDate | Datetime | True | No | ||
IsAddTask | Boolean | True | No | Indicates whether the activity was adding a task to the deal. | |
Deleted | Boolean | True | No | Indicates whethere the activity was deleted or not. | |
SeriesId | String | True | No | ||
DealLink | String | True | No | The API endpoint to the Deal related to this activity. | |
StageLink | String | True | No | The API endpoint to the Stage related to this activity. | |
UserLink | String | True | No | The API endpoint to the User related to this activity. | |
AutomationLink | String | True | No | The API endpoint to the Automation related to this activity. | |
ActivityLink | String | True | No | The API endpoint to the Activity. | |
Deal | String | True | No | The related to this Activity. | |
Stage | String | True | No | The Stage column of the DealActivities table. | |
User | String | True | No | The User column of the DealActivities table. | |
Automation | String | True | No | The Automation which triggered this activity. | |
Exclude | String | False | Yes | Include this param to exclude 'email', 'connection_email', and 'LinkData' activity types. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | The Id column of the DealCustomFieldData table. | |
CreatedTimestamp | Datetime | False | No | The CreatedTimestamp column of the DealCustomFieldData table. | |
CustomFieldName | String | True | No | The name of the custom field metum the field value relates to. | |
CustomFieldId | Integer | False | No | The CustomFieldId column of the DealCustomFieldData table. | |
DealCustomFieldMetumId | Integer | False | No | The DealCustomFieldMetumId column of the DealCustomFieldData table. | |
DealId | Integer | False | No | The DealId column of the DealCustomFieldData table. | |
FieldValue | String | False | No | The FieldValue column of the DealCustomFieldData table. | |
DealLink | String | False | No | The DealLink column of the DealCustomFieldData table. | |
DealCustomFieldMetumLink | String | False | No | The DealCustomFieldMetumLink column of the DealCustomFieldData table. | |
UpdatedTimestamp | Datetime | False | No | The UpdatedTimestamp column of the DealCustomFieldData. | |
FieldCurrency | String | False | No | Value of the custom field currency type for a specific deal. This field is required when inserting currency custom fields. | |
FieldType | String | False | No | Value of the custom field currency type for a specific deal. This field is required when inserting currency custom fields. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The pipeline Id. | |
AllGroups | String | False | No | The AllGroups column of the DealGroups table. Indicates whether all user groups have permission to manage this pipeline. Can be either 1 or 0. If 1, all user groups can manage this pipeline. If 0, only user groups in dealGroup.groups parameter can manage this pipeline. | |
AllUsers | String | False | No | The AllUsers column of the DealGroups table. Indicates whether new deals get auto-assigned to all users. Can be either 1 or 0. If 1, new deals are auto-assigned to all users unless auto-assign is disabled. If 0, new deals are auto-assigned to only the users in dealGroup.users parameter. | |
AutoAssign | String | False | No | The AutoAssign column of the DealGroups table. Deal auto-assign option. Can be one of 0, 1, and 2. If 0, auto-assign is disabled. If 1, Round Robin method is used to auto-assign new deals. If 2, deals are distributed based on deal values. | |
Cdate | Datetime | True | No | The Cdate column of the DealGroups table. | |
Currency | String | False | No | The Currency column of the DealGroups table. | |
DealGroupGroupsLink | String | True | No | The DealGroupGroupsLink column of the DealGroups table. | |
DealGroupUsersLink | String | True | No | The DealGroupUsersLink column of the DealGroups table. | |
StagesLink | String | True | No | The StagesLink column of the DealGroups table. | |
Stages | String | True | No | The Stages column of the DealGroups table. | |
Title | String | False | No | Pipeline's title. | |
Udate | Datetime | True | No | The Udate column of the DealGroups table. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id column of the Deals table. | |
AccountId | String | False | No | The AccountId column of the Deals table. | |
ActivityCount | String | True | No | The ActivityCount column of the Deals table. | |
Cdate | Datetime | True | No | The Cdate column of the Deals table. | |
ContactId | String | False | No | Deal's primary contact's Id. | |
Currency | String | False | No | Deal's currency in 3-digit ISO format, lowercased. | |
CustomerAccount | String | True | No | The CustomerAccount column of the Deals table. | |
Description | String | False | No | The Description column of the Deals table. | |
Edate | String | True | No | The Edate column of the Deals table. | |
Group | String | False | No | Deal's pipeline Id. Required if deal.stage is not provided. If deal.group is not provided, the stage's pipeline will be assigned to the deal automatically. | |
Hash | String | True | No | The Hash column of the Deals table. | |
IsDisabled | String | True | No | The IsDisabled column of the Deals table. | |
AccountLink | String | True | No | The AccountLink column of the Deals table. | |
ContactLink | String | True | No | The ContactLink column of the Deals table. | |
ContactDealsLink | String | True | No | The ContactDealsLink column of the Deals table. | |
CustomerAccountLink | String | True | No | The CustomerAccountLink column of the Deals table. | |
DealActivitiesLink | String | True | No | The DealActivitiesLink column of the Deals table. | |
DealCustomFieldDataLink | String | True | No | The DealCustomFieldDataLink column of the Deals table. | |
GroupLink | String | True | No | The GroupLink column of the Deals table. | |
NextTaskLink | String | True | No | The NextTaskLink column of the Deals table. | |
NotesLink | String | True | No | The NotesLink column of the Deals table. | |
OrganizationLink | String | True | No | The OrganizationLink column of the Deals table. | |
OwnerLink | String | True | No | The OwnerLink column of the Deals table. | |
ScoreValuesLink | String | True | No | The ScoreValuesLink column of the Deals table. | |
StageLink | String | True | No | The StageLink column of the Deals table. | |
TasksLink | String | True | No | The TasksLink column of the Deals table. | |
Mdate | Datetime | True | No | The Mdate column of the Deals table. | |
NextTask | String | True | No | The NextTask column of the Deals table. | |
NextDate | Datetime | True | No | The NextDate column of the Deals table. | |
NextDealId | String | True | No | The NextDealId column of the Deals table. | |
NextTaskId | String | True | No | The NextTaskId column of the Deals table. | |
Organization | String | True | No | The Organization column of the Deals table. | |
Owner | String | False | No | Deal's owner Id. Required if pipeline's auto-assign option is disabled. | |
Percent | String | False | No | The Percent column of the Deals table. | |
Stage | String | False | No | Deal's stage Id. Required if deal.group is not provided. If deal.stage is not provided, the deal will be assigned with the first stage in the pipeline provided in deal.group. | |
Status | String | False | No | The Status column of the Deals table. | |
Title | String | False | No | The Title column of the Deals table. | |
Value | String | False | No | Deal's value in cents. | |
WinProbability | Integer | True | No | The WinProbability column of the Deals table. | |
WinProbabilityMdate | Datetime | True | No | The WinProbabilityMdate column of the Deals table. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id column of the DealStages table. | |
CardRegion1 | String | False | No | The CardRegion1 column of the DealStages table. Indicates what to show in upper-left corner of Deal Cards. | |
CardRegion2 | String | False | No | The CardRegion2 column of the DealStages table. Indicates what to show in upper-right corner of Deal Cards. | |
CardRegion3 | String | False | No | The CardRegion3 column of the DealStages table. Indicates whether to show the avatar in Deal Cards. Can be one of show-avatar and hide-avatar. If set to show-avatar, deal cards will show the avatars. If set to hide-avatar, deal cards will hide the avatars. | |
CardRegion4 | String | False | No | The CardRegion4 column of the DealStages table. Indicates what to show next to the avatar in Deal Cards. | |
CardRegion5 | String | False | No | The CardRegion5 column of the DealStages table. Indicates what to show in lower-right corner of Deal Cards. | |
Cdate | Datetime | True | No | The Cdate column of the DealStages table. | |
Color | String | False | No | Deal Stage's color. 6-character HEX color code without the hashtag. e.g. 434343 to assign the hex color value #434343. | |
DealOrder | String | False | No | Option and direction to be used to sort deals in the deal stage. The option and direction should be delimited by a space. Direction can be either. | |
GroupId | String | False | No | The GroupId column of the DealStages table. | |
GroupLink | String | True | No | The GroupLink column of the DealStages table. | |
OrderId | String | False | No | The OrderId column of the DealStages table. | |
Title | String | False | No | The Title column of the DealStages table. | |
Udate | Datetime | True | No | The Udate column of the DealStages table. | |
Width | String | False | No | Deal stage's width in pixels, without px unit. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id column of the Lists table. | |
AnalyticsDomains | String | True | No | The AnalyticsDomains column of the Lists table. | |
AnalyticsSource | String | True | No | The AnalyticsSource column of the Lists table. | |
AnalyticsUa | String | True | No | The AnalyticsUa column of the Lists table. | |
CarbonCopy | String | True | No | The CarbonCopy column of the Lists table. | |
Cdate | Datetime | True | No | The Cdate column of the Lists table. | |
Udate | Datetime | True | No | The Udate column of the Lists table. | |
DeleteStamp | String | True | No | The DeleteStamp column of the Lists table. | |
FacebookSession | String | True | No | The FacebookSession column of the Lists table. | |
FullAddress | String | True | No | The FullAddress column of the Lists table. | |
UnsubscribeReason | String | True | No | The UnsubscribeReason column of the Lists table. | |
AddressListsLink | String | True | No | The AddressListsLink column of the Lists table. | |
ContactGoalListsLink | String | True | No | The ContactGoalListsLink column of the Lists table. | |
UserLink | String | True | No | The UserLink column of the Lists table. | |
Name | String | True | No | The Name column of the Lists table. | |
OptinMessageId | String | True | No | The OptinMessageId column of the Lists table. | |
OptinOptout | String | True | No | The OptinOptout column of the Lists table. | |
OptoutConf | String | True | No | The OptoutConf column of the Lists table. | |
EmbedImage | String | True | No | The EmbedImage column of the Lists table. | |
UseAnalyticsLink | String | True | No | The UseAnalyticsLink column of the Lists table. | |
UseAnalyticsRead | String | True | No | The UseAnalyticsRead column of the Lists table. | |
UseCaptcha | String | True | No | The UseCaptcha column of the Lists table. | |
UseFacebook | String | True | No | The UseFacebook column of the Lists table. | |
UseTracking | String | True | No | The UseTracking column of the Lists table. | |
UseTwitter | String | True | No | The UseTwitter column of the Lists table. | |
Private | String | True | No | The Private column of the Lists table. | |
RequireName | String | True | No | The RequireName column of the Lists table. | |
SendLastBroadcast | String | True | No | The SendLastBroadcast column of the Lists table. | |
SenderAddr1 | String | True | No | The SenderAddr1 column of the Lists table. | |
SenderAddr2 | String | True | No | The SenderAddr2 column of the Lists table. | |
SenderCity | String | True | No | The SenderCity column of the Lists table. | |
SenderCountry | String | True | No | The SenderCountry column of the Lists table. | |
SenderName | String | True | No | The SenderName column of the Lists table. | |
SenderPhone | String | True | No | The SenderPhone column of the Lists table. | |
SenderReminder | String | True | No | The SenderReminder column of the Lists table. | |
SenderState | String | True | No | The SenderState column of the Lists table. | |
SenderUrl | String | True | No | The SenderUrl column of the Lists table. | |
SenderZip | String | True | No | The SenderZip column of the Lists table. | |
StringId | String | True | No | The StringId column of the Lists table. | |
SubscriptionNotify | String | True | No | The SubscriptionNotify column of the Lists table. | |
ToName | String | True | No | The ToName column of the Lists table. | |
TwitterToken | String | True | No | The TwitterToken column of the Lists table. | |
TwitterTokenSecret | String | True | No | The TwitterTokenSecret column of the Lists table. | |
UnsubscriptionNotify | String | True | No | The UnsubscriptionNotify column of the Lists table. | |
ListsUser | String | True | No | The ListsUser column of the Lists table. | |
ListsUserid | String | True | No | The ListsUserid column of the Lists table. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id | String | True | No | The Id column of the Scores table. | |
Cdate | Datetime | True | No | The Cdate column of the Scores table. | |
Descript | String | True | No | The Descript column of the Scores table. | |
Mdate | Datetime | True | No | The Mdate column of the Scores table. | |
Name | String | True | No | The Name column of the Scores table. | |
RelType | String | True | No | The RelType column of the Scores table. | |
Status | String | True | No | The Status column of the Scores table. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id column of the Tags table. | |
Tag | String | True | No | The Tag column of the Tags table. | |
TagType | String | True | No | The TagType column of the Tags table. | |
Description | String | True | No | The Description column of the Tags table. | |
Cdate | Datetime | True | No | The Cdate column of the Tags table. | |
ContactGoalTagsLink | String | True | No | The ContactGoalTagsLink column of the Tags table. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id column of the Tasks table. | |
Assignee | String | False | No | The Assignee column of the Tasks table. | |
Automation | String | True | No | The Automation column of the Tasks table. | |
Cdate | Datetime | True | No | The Cdate column of the Tasks table. | |
DealTaskType | String | False | No | The type of the task based on the available Task Types in the account. | |
DoneAutomation | String | False | No | The DoneAutomation column of the Tasks table. | |
DueDate | Datetime | False | No | Due date of the task. | |
Edate | Datetime | True | No | The Edate column of the Tasks table. | |
ActivitiesLink | String | True | No | The ActivitiesLink column of the Tasks table. | |
AssigneeLink | String | True | No | The AssigneeLink column of the Tasks table. | |
AutomationLink | String | True | No | The AutomationLink column of the Tasks table. | |
DealTasktypeLink | String | True | No | The DealTasktypeLink column of the Tasks table. | |
DoneAutomationLink | String | True | No | The DoneAutomationLink column of the Tasks table. | |
NotesLink | String | True | No | The NotesLink column of the Tasks table. | |
OwnerLink | String | True | No | The OwnerLink column of the Tasks table. | |
TaskNotificationsLink | String | True | No | The TaskNotificationsLink column of the Tasks table. | |
UserLink | String | True | No | The UserLink column of the Tasks table. | |
Note | String | False | No | The content describing the task. | |
OutcomeId | Integer | False | No | The OutcomeId column of the Tasks table. | |
OutcomeInfo | String | False | No | The OutcomeInfo column of the Tasks table. | |
OwnerId | String | True | No | The OwnerId column of the Tasks table. | |
OwnerType | String | False | No | The name of the relating object. Valid values are contact or deal. | |
Relid | String | False | No | The Id of the relational object for this task. | |
Reltype | String | True | No | The Reltype column of the Tasks table. | |
Status | Integer | False | No | The Status column of the Tasks table. 1 is complete and 0 is incomplete.. | |
Title | String | False | No | The Title column of the Tasks table. | |
Udate | Datetime | True | No | The Udate column of the Tasks table. | |
User | String | True | No | The User column of the Tasks table. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The Id column of the TrackingLogs table. | |
ContactId | String | True | Contacts.Id | No | The ContactId column of the TrackingLogs table. |
Hash | String | True | No | The Hash column of the TrackingLogs table. | |
ContactLink | String | True | No | The ContactLink column of the TrackingLogs table. | |
SubscriberidLink | String | True | No | The SubscriberidLink column of the TrackingLogs table. | |
TstampLink | Datetime | True | No | The TstampLink column of the TrackingLogs table. | |
TypeLink | String | True | No | The TypeLink column of the TrackingLogs table. | |
ValueLink | String | True | No | The ValueLink column of the TrackingLogs table. | |
UDateLink | Datetime | False | Yes |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id | String | True | No | The Id column of the Users table. | |
String | True | No | The Email column of the Users table. | ||
FirstName | String | True | No | The FirstName column of the Users table. | |
LastName | String | True | No | The LastName column of the Users table. | |
ConfigsLink | String | True | No | The ConfigsLinks column of the Users table. | |
DealGroupTotalsLink | String | True | No | The DealGroupTotalsLink column of the Users table. | |
DealGroupUsersLink | String | True | No | The DealGroupUsersLink column of the Users table. | |
ListsLink | String | True | No | The ListsLink column of the Users table. | |
UserGroupLink | String | True | No | The UserGroupLink column of the Users table. | |
Phone | Unknown | True | No | The Phone column of the Users table. | |
Signature | Unknown | True | No | The Signature column of the Users table. | |
Username | String | True | No | The Username column of the Users table. |