MarketingAPI | connectwise-rest

Marketing module

Hierarchy

default
- MarketingAPI

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new MarketingAPI(props: CWMOptions): MarketingAPI

Overrides Manage.constructor
- Defined in src/Manage/MarketingAPI.ts:54
Parameters
- props: CWMOptions
Returns MarketingAPI

Properties

config

config: ManageConfig

paginate

paginate: (apiMethod: Function, paginateArgs: PaginationOptions, ...methodArgs: Record<string, unknown>[]) => Promise<unknown[]>

Type declaration

- (apiMethod: Function, paginateArgs: PaginationOptions, ...methodArgs: Record<string, unknown>[]): Promise<unknown[]>
- example
  cwm.paginate(cwm.FinanceAPI.getFinanceAgreements, {startPage: 1, pageSize: 500}, {conditions: 'inactiveFlag = false'})
  Parameters
  - apiMethod: Function
  - paginateArgs: PaginationOptions
  - Rest ...methodArgs: Record<string, unknown>[]
  Returns Promise<unknown[]>

request

request: (args: RequestOptions) => Promise<any>

Type declaration

- (args: RequestOptions): Promise<any>
- Parameters
  - args: RequestOptions
  Returns Promise<any>

Methods

deleteMarketingCampaignsById

deleteMarketingCampaignsById(id: number): Promise<undefined>

- Defined in src/Manage/MarketingAPI.ts:82
Parameters
- id: number
Returns Promise<undefined>

deleteMarketingCampaignsByParentIdAuditsById

deleteMarketingCampaignsByParentIdAuditsById(id: number, parentId: number): Promise<undefined>

- Defined in src/Manage/MarketingAPI.ts:186
Parameters
- id: number
- parentId: number
Returns Promise<undefined>

deleteMarketingCampaignsByParentIdEmailsOpenedById

deleteMarketingCampaignsByParentIdEmailsOpenedById(id: number, parentId: number): Promise<undefined>

- Defined in src/Manage/MarketingAPI.ts:265
Parameters
- id: number
- parentId: number
Returns Promise<undefined>

deleteMarketingCampaignsByParentIdFormsSubmittedById

deleteMarketingCampaignsByParentIdFormsSubmittedById(id: number, parentId: number): Promise<undefined>

- Defined in src/Manage/MarketingAPI.ts:344
Parameters
- id: number
- parentId: number
Returns Promise<undefined>

deleteMarketingCampaignsByParentIdLinksClickedById

deleteMarketingCampaignsByParentIdLinksClickedById(id: number, parentId: number): Promise<undefined>

- Defined in src/Manage/MarketingAPI.ts:423
Parameters
- id: number
- parentId: number
Returns Promise<undefined>

deleteMarketingCampaignsStatusesById

deleteMarketingCampaignsStatusesById(id: number): Promise<undefined>

- Defined in src/Manage/MarketingAPI.ts:503
Parameters
- id: number
Returns Promise<undefined>

deleteMarketingCampaignsSubTypesById

deleteMarketingCampaignsSubTypesById(id: number): Promise<undefined>

- Defined in src/Manage/MarketingAPI.ts:571
Parameters
- id: number
Returns Promise<undefined>

deleteMarketingCampaignsTypesById

deleteMarketingCampaignsTypesById(id: number): Promise<undefined>

- Defined in src/Manage/MarketingAPI.ts:632
Parameters
- id: number
Returns Promise<undefined>

deleteMarketingGroupsById

deleteMarketingGroupsById(id: number): Promise<undefined>

- Defined in src/Manage/MarketingAPI.ts:751
Parameters
- id: number
Returns Promise<undefined>

deleteMarketingGroupsByParentIdCompaniesById

deleteMarketingGroupsByParentIdCompaniesById(id: number, parentId: number): Promise<undefined>

- Defined in src/Manage/MarketingAPI.ts:827
Parameters
- id: number
- parentId: number
Returns Promise<undefined>

deleteMarketingGroupsByParentIdContactsById

deleteMarketingGroupsByParentIdContactsById(id: number, parentId: number): Promise<undefined>

- Defined in src/Manage/MarketingAPI.ts:906
Parameters
- id: number
- parentId: number
Returns Promise<undefined>

getMarketingCampaigns

getMarketingCampaigns(params?: CommonParameters): Promise<{ _info?: {}; actualCost?: null | number; actualGrossMargin?: null | number; actualROI?: null | number; actualRevenue?: null | number; budgetCost?: null | number; budgetGrossMargin?: null | number; budgetROI?: null | number; budgetRevenue?: null | number; defaultGroup?: { _info?: {}; id?: null | number; name?: string }; emailsSent?: null | number; endDate?: string; id?: number; impressions?: null | number; inactive?: null | boolean; inactiveDaysAfterEnd?: null | number; locationId?: null | number; marketingManagerDefaultTrackId?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; name: string; notes?: string; opportunityDefaultTrackId?: null | number; startDate: string; status?: { _info?: {}; id?: null | number; name?: string }; subType?: { _info?: {}; id?: null | number; name?: string }; type?: { _info?: {}; id?: null | number; name?: string } }[]>

- Defined in src/Manage/MarketingAPI.ts:58
Parameters
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; actualCost?: null | number; actualGrossMargin?: null | number; actualROI?: null | number; actualRevenue?: null | number; budgetCost?: null | number; budgetGrossMargin?: null | number; budgetROI?: null | number; budgetRevenue?: null | number; defaultGroup?: { _info?: {}; id?: null | number; name?: string }; emailsSent?: null | number; endDate?: string; id?: number; impressions?: null | number; inactive?: null | boolean; inactiveDaysAfterEnd?: null | number; locationId?: null | number; marketingManagerDefaultTrackId?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; name: string; notes?: string; opportunityDefaultTrackId?: null | number; startDate: string; status?: { _info?: {}; id?: null | number; name?: string }; subType?: { _info?: {}; id?: null | number; name?: string }; type?: { _info?: {}; id?: null | number; name?: string } }[]>

getMarketingCampaignsById

getMarketingCampaignsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; actualCost?: null | number; actualGrossMargin?: null | number; actualROI?: null | number; actualRevenue?: null | number; budgetCost?: null | number; budgetGrossMargin?: null | number; budgetROI?: null | number; budgetRevenue?: null | number; defaultGroup?: { _info?: {}; id?: null | number; name?: string }; emailsSent?: null | number; endDate?: string; id?: number; impressions?: null | number; inactive?: null | boolean; inactiveDaysAfterEnd?: null | number; locationId?: null | number; marketingManagerDefaultTrackId?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; name: string; notes?: string; opportunityDefaultTrackId?: null | number; startDate: string; status?: { _info?: {}; id?: null | number; name?: string }; subType?: { _info?: {}; id?: null | number; name?: string }; type?: { _info?: {}; id?: null | number; name?: string } }>

- Defined in src/Manage/MarketingAPI.ts:74
Parameters
- id: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; actualCost?: null | number; actualGrossMargin?: null | number; actualROI?: null | number; actualRevenue?: null | number; budgetCost?: null | number; budgetGrossMargin?: null | number; budgetROI?: null | number; budgetRevenue?: null | number; defaultGroup?: { _info?: {}; id?: null | number; name?: string }; emailsSent?: null | number; endDate?: string; id?: number; impressions?: null | number; inactive?: null | boolean; inactiveDaysAfterEnd?: null | number; locationId?: null | number; marketingManagerDefaultTrackId?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; name: string; notes?: string; opportunityDefaultTrackId?: null | number; startDate: string; status?: { _info?: {}; id?: null | number; name?: string }; subType?: { _info?: {}; id?: null | number; name?: string }; type?: { _info?: {}; id?: null | number; name?: string } }>

getMarketingCampaignsByIdActivities

getMarketingCampaignsByIdActivities(id: number, params?: CommonParameters): Promise<{ _info?: {}; id?: null | number; name?: string }[]>

- Defined in src/Manage/MarketingAPI.ts:108
Parameters
- id: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; id?: null | number; name?: string }[]>

getMarketingCampaignsByIdActivitiesCount

getMarketingCampaignsByIdActivitiesCount(id: number, params?: CommonParameters): Promise<{ count?: number }>

- Defined in src/Manage/MarketingAPI.ts:119
Parameters
- id: number
- params: CommonParameters = {}
Returns Promise<{ count?: number }>

getMarketingCampaignsByIdOpportunities

getMarketingCampaignsByIdOpportunities(id: number, params?: CommonParameters): Promise<{ _info?: {}; id?: null | number; name?: string }[]>

- Defined in src/Manage/MarketingAPI.ts:130
Parameters
- id: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; id?: null | number; name?: string }[]>

getMarketingCampaignsByIdOpportunitiesCount

getMarketingCampaignsByIdOpportunitiesCount(id: number, params?: CommonParameters): Promise<{ count?: number }>

- Defined in src/Manage/MarketingAPI.ts:141
Parameters
- id: number
- params: CommonParameters = {}
Returns Promise<{ count?: number }>

getMarketingCampaignsByParentIdAudits

getMarketingCampaignsByParentIdAudits(parentId: number, params?: CommonParameters): Promise<{ campaignId?: null | number; createdBy?: string; dateCreated?: string; documentsCreated?: null | number; emailSubject?: string; emailsSent: null | number; emailsUnsent?: null | number; group?: { _info?: {}; id?: null | number; name?: string }; id?: number }[]>

- Defined in src/Manage/MarketingAPI.ts:152
Parameters
- parentId: number
- params: CommonParameters = {}
Returns Promise<{ campaignId?: null | number; createdBy?: string; dateCreated?: string; documentsCreated?: null | number; emailSubject?: string; emailsSent: null | number; emailsUnsent?: null | number; group?: { _info?: {}; id?: null | number; name?: string }; id?: number }[]>

getMarketingCampaignsByParentIdAuditsById

getMarketingCampaignsByParentIdAuditsById(id: number, parentId: number, params?: CommonParameters): Promise<{ campaignId?: null | number; createdBy?: string; dateCreated?: string; documentsCreated?: null | number; emailSubject?: string; emailsSent: null | number; emailsUnsent?: null | number; group?: { _info?: {}; id?: null | number; name?: string }; id?: number }>

- Defined in src/Manage/MarketingAPI.ts:174
Parameters
- id: number
- parentId: number
- params: CommonParameters = {}
Returns Promise<{ campaignId?: null | number; createdBy?: string; dateCreated?: string; documentsCreated?: null | number; emailSubject?: string; emailsSent: null | number; emailsUnsent?: null | number; group?: { _info?: {}; id?: null | number; name?: string }; id?: number }>

getMarketingCampaignsByParentIdAuditsCount

getMarketingCampaignsByParentIdAuditsCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

- Defined in src/Manage/MarketingAPI.ts:220
Parameters
- parentId: number
- params: CommonParameters = {}
Returns Promise<{ count?: number }>

getMarketingCampaignsByParentIdEmailsOpened

getMarketingCampaignsByParentIdEmailsOpened(parentId: number, params?: CommonParameters): Promise<{ campaignId?: null | number; contactId: null | number; dateOpened?: string; id?: number }[]>

- Defined in src/Manage/MarketingAPI.ts:231
Parameters
- parentId: number
- params: CommonParameters = {}
Returns Promise<{ campaignId?: null | number; contactId: null | number; dateOpened?: string; id?: number }[]>

getMarketingCampaignsByParentIdEmailsOpenedById

getMarketingCampaignsByParentIdEmailsOpenedById(id: number, parentId: number, params?: CommonParameters): Promise<{ campaignId?: null | number; contactId: null | number; dateOpened?: string; id?: number }>

- Defined in src/Manage/MarketingAPI.ts:253
Parameters
- id: number
- parentId: number
- params: CommonParameters = {}
Returns Promise<{ campaignId?: null | number; contactId: null | number; dateOpened?: string; id?: number }>

getMarketingCampaignsByParentIdEmailsOpenedCount

getMarketingCampaignsByParentIdEmailsOpenedCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

- Defined in src/Manage/MarketingAPI.ts:299
Parameters
- parentId: number
- params: CommonParameters = {}
Returns Promise<{ count?: number }>

getMarketingCampaignsByParentIdFormsSubmitted

getMarketingCampaignsByParentIdFormsSubmitted(parentId: number, params?: CommonParameters): Promise<{ campaignId?: null | number; contactId: null | number; dateSubmitted?: string; id?: number; pageSubType?: string; pageType?: string; queryString?: string; status?: string; topic?: string; url: string; version?: string }[]>

- Defined in src/Manage/MarketingAPI.ts:310
Parameters
- parentId: number
- params: CommonParameters = {}
Returns Promise<{ campaignId?: null | number; contactId: null | number; dateSubmitted?: string; id?: number; pageSubType?: string; pageType?: string; queryString?: string; status?: string; topic?: string; url: string; version?: string }[]>

getMarketingCampaignsByParentIdFormsSubmittedById

getMarketingCampaignsByParentIdFormsSubmittedById(id: number, parentId: number, params?: CommonParameters): Promise<{ campaignId?: null | number; contactId: null | number; dateSubmitted?: string; id?: number; pageSubType?: string; pageType?: string; queryString?: string; status?: string; topic?: string; url: string; version?: string }>

- Defined in src/Manage/MarketingAPI.ts:332
Parameters
- id: number
- parentId: number
- params: CommonParameters = {}
Returns Promise<{ campaignId?: null | number; contactId: null | number; dateSubmitted?: string; id?: number; pageSubType?: string; pageType?: string; queryString?: string; status?: string; topic?: string; url: string; version?: string }>

getMarketingCampaignsByParentIdFormsSubmittedCount

getMarketingCampaignsByParentIdFormsSubmittedCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

- Defined in src/Manage/MarketingAPI.ts:378
Parameters
- parentId: number
- params: CommonParameters = {}
Returns Promise<{ count?: number }>

getMarketingCampaignsByParentIdLinksClicked

getMarketingCampaignsByParentIdLinksClicked(parentId: number, params?: CommonParameters): Promise<{ campaignId?: null | number; contactId: null | number; dateClicked?: string; id?: number; queryString?: string; url: string }[]>

- Defined in src/Manage/MarketingAPI.ts:389
Parameters
- parentId: number
- params: CommonParameters = {}
Returns Promise<{ campaignId?: null | number; contactId: null | number; dateClicked?: string; id?: number; queryString?: string; url: string }[]>

getMarketingCampaignsByParentIdLinksClickedById

getMarketingCampaignsByParentIdLinksClickedById(id: number, parentId: number, params?: CommonParameters): Promise<{ campaignId?: null | number; contactId: null | number; dateClicked?: string; id?: number; queryString?: string; url: string }>

- Defined in src/Manage/MarketingAPI.ts:411
Parameters
- id: number
- parentId: number
- params: CommonParameters = {}
Returns Promise<{ campaignId?: null | number; contactId: null | number; dateClicked?: string; id?: number; queryString?: string; url: string }>

getMarketingCampaignsByParentIdLinksClickedCount

getMarketingCampaignsByParentIdLinksClickedCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

- Defined in src/Manage/MarketingAPI.ts:457
Parameters
- parentId: number
- params: CommonParameters = {}
Returns Promise<{ count?: number }>

getMarketingCampaignsCount

getMarketingCampaignsCount(params?: CommonParameters): Promise<{ count?: number }>

- Defined in src/Manage/MarketingAPI.ts:468
Parameters
- params: CommonParameters = {}
Returns Promise<{ count?: number }>

getMarketingCampaignsStatuses

getMarketingCampaignsStatuses(params?: CommonParameters): Promise<{ _info?: {}; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string }[]>

- Defined in src/Manage/MarketingAPI.ts:476
Parameters
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string }[]>

getMarketingCampaignsStatusesById

getMarketingCampaignsStatusesById(id: number, params?: CommonParameters): Promise<{ _info?: {}; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string }>

- Defined in src/Manage/MarketingAPI.ts:492
Parameters
- id: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string }>

getMarketingCampaignsStatusesCount

getMarketingCampaignsStatusesCount(params?: CommonParameters): Promise<{ count?: number }>

- Defined in src/Manage/MarketingAPI.ts:532
Parameters
- params: CommonParameters = {}
Returns Promise<{ count?: number }>

getMarketingCampaignsSubTypes

getMarketingCampaignsSubTypes(params?: CommonParameters): Promise<{ _info?: {}; id?: number; name: string; type?: { _info?: {}; id?: null | number; name?: string } }[]>

- Defined in src/Manage/MarketingAPI.ts:540
Parameters
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; id?: number; name: string; type?: { _info?: {}; id?: null | number; name?: string } }[]>

getMarketingCampaignsSubTypesById

getMarketingCampaignsSubTypesById(id: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; name: string; type?: { _info?: {}; id?: null | number; name?: string } }>

- Defined in src/Manage/MarketingAPI.ts:560
Parameters
- id: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; id?: number; name: string; type?: { _info?: {}; id?: null | number; name?: string } }>

getMarketingCampaignsSubTypesCount

getMarketingCampaignsSubTypesCount(params?: CommonParameters): Promise<{ count?: number }>

- Defined in src/Manage/MarketingAPI.ts:600
Parameters
- params: CommonParameters = {}
Returns Promise<{ count?: number }>

getMarketingCampaignsTypes

getMarketingCampaignsTypes(params?: CommonParameters): Promise<{ _info?: {}; defaultFlag?: null | boolean; id?: number; name: string }[]>

- Defined in src/Manage/MarketingAPI.ts:608
Parameters
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; defaultFlag?: null | boolean; id?: number; name: string }[]>

getMarketingCampaignsTypesById

getMarketingCampaignsTypesById(id: number, params?: CommonParameters): Promise<{ _info?: {}; defaultFlag?: null | boolean; id?: number; name: string }>

- Defined in src/Manage/MarketingAPI.ts:624
Parameters
- id: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; defaultFlag?: null | boolean; id?: number; name: string }>

getMarketingCampaignsTypesByIdInfo

getMarketingCampaignsTypesByIdInfo(id: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; name?: string }>

- Defined in src/Manage/MarketingAPI.ts:658
Parameters
- id: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; id?: number; name?: string }>

getMarketingCampaignsTypesByParentIdSubTypes

getMarketingCampaignsTypesByParentIdSubTypes(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; name?: string; typeId?: null | number }[]>

- Defined in src/Manage/MarketingAPI.ts:669
Parameters
- parentId: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; id?: number; name?: string; typeId?: null | number }[]>

getMarketingCampaignsTypesByParentIdSubTypesById

getMarketingCampaignsTypesByParentIdSubTypesById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; name?: string; typeId?: null | number }>

- Defined in src/Manage/MarketingAPI.ts:680
Parameters
- id: number
- parentId: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; id?: number; name?: string; typeId?: null | number }>

getMarketingCampaignsTypesByParentIdSubTypesCount

getMarketingCampaignsTypesByParentIdSubTypesCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

- Defined in src/Manage/MarketingAPI.ts:692
Parameters
- parentId: number
- params: CommonParameters = {}
Returns Promise<{ count?: number }>

getMarketingCampaignsTypesCount

getMarketingCampaignsTypesCount(params?: CommonParameters): Promise<{ count?: number }>

- Defined in src/Manage/MarketingAPI.ts:703
Parameters
- params: CommonParameters = {}
Returns Promise<{ count?: number }>

getMarketingCampaignsTypesInfo

getMarketingCampaignsTypesInfo(params?: CommonParameters): Promise<{ _info?: {}; id?: number; name?: string }[]>

- Defined in src/Manage/MarketingAPI.ts:711
Parameters
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; id?: number; name?: string }[]>

getMarketingCampaignsTypesInfoCount

getMarketingCampaignsTypesInfoCount(params?: CommonParameters): Promise<{ count?: number }>

- Defined in src/Manage/MarketingAPI.ts:719
Parameters
- params: CommonParameters = {}
Returns Promise<{ count?: number }>

getMarketingGroups

getMarketingGroups(params?: CommonParameters): Promise<{ _info?: {}; id?: number; inactiveFlag?: null | boolean; name: string; publicDescription?: string; publicFlag?: null | boolean }[]>

- Defined in src/Manage/MarketingAPI.ts:727
Parameters
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; id?: number; inactiveFlag?: null | boolean; name: string; publicDescription?: string; publicFlag?: null | boolean }[]>

getMarketingGroupsById

getMarketingGroupsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; inactiveFlag?: null | boolean; name: string; publicDescription?: string; publicFlag?: null | boolean }>

- Defined in src/Manage/MarketingAPI.ts:743
Parameters
- id: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; id?: number; inactiveFlag?: null | boolean; name: string; publicDescription?: string; publicFlag?: null | boolean }>

getMarketingGroupsByIdUsages

getMarketingGroupsByIdUsages(id: number, params?: CommonParameters): Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

- Defined in src/Manage/MarketingAPI.ts:774
Parameters
- id: number
- params: CommonParameters = {}
Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getMarketingGroupsByIdUsagesList

getMarketingGroupsByIdUsagesList(id: number, params?: CommonParameters): Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

- Defined in src/Manage/MarketingAPI.ts:782
Parameters
- id: number
- params: CommonParameters = {}
Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getMarketingGroupsByParentIdCompanies

getMarketingGroupsByParentIdCompanies(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; allContactsFlag?: null | boolean; defaultContactFlag?: null | boolean; groupId?: null | number; id?: number; unsubscribeFlag?: null | boolean }[]>

- Defined in src/Manage/MarketingAPI.ts:793
Parameters
- parentId: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; allContactsFlag?: null | boolean; defaultContactFlag?: null | boolean; groupId?: null | number; id?: number; unsubscribeFlag?: null | boolean }[]>

getMarketingGroupsByParentIdCompaniesById

getMarketingGroupsByParentIdCompaniesById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; allContactsFlag?: null | boolean; defaultContactFlag?: null | boolean; groupId?: null | number; id?: number; unsubscribeFlag?: null | boolean }>

- Defined in src/Manage/MarketingAPI.ts:815
Parameters
- id: number
- parentId: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; allContactsFlag?: null | boolean; defaultContactFlag?: null | boolean; groupId?: null | number; id?: number; unsubscribeFlag?: null | boolean }>

getMarketingGroupsByParentIdCompaniesCount

getMarketingGroupsByParentIdCompaniesCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

- Defined in src/Manage/MarketingAPI.ts:861
Parameters
- parentId: number
- params: CommonParameters = {}
Returns Promise<{ count?: number }>

getMarketingGroupsByParentIdContacts

getMarketingGroupsByParentIdContacts(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; groupId?: null | number; id?: number; note?: string; unsubscribeFlag?: null | boolean }[]>

- Defined in src/Manage/MarketingAPI.ts:872
Parameters
- parentId: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; groupId?: null | number; id?: number; note?: string; unsubscribeFlag?: null | boolean }[]>

getMarketingGroupsByParentIdContactsById

getMarketingGroupsByParentIdContactsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; groupId?: null | number; id?: number; note?: string; unsubscribeFlag?: null | boolean }>

- Defined in src/Manage/MarketingAPI.ts:894
Parameters
- id: number
- parentId: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; groupId?: null | number; id?: number; note?: string; unsubscribeFlag?: null | boolean }>

getMarketingGroupsByParentIdContactsCount

getMarketingGroupsByParentIdContactsCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

- Defined in src/Manage/MarketingAPI.ts:940
Parameters
- parentId: number
- params: CommonParameters = {}
Returns Promise<{ count?: number }>

getMarketingGroupsCount

getMarketingGroupsCount(params?: CommonParameters): Promise<{ count?: number }>

- Defined in src/Manage/MarketingAPI.ts:951
Parameters
- params: CommonParameters = {}
Returns Promise<{ count?: number }>

patchMarketingCampaignsById

patchMarketingCampaignsById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; actualCost?: null | number; actualGrossMargin?: null | number; actualROI?: null | number; actualRevenue?: null | number; budgetCost?: null | number; budgetGrossMargin?: null | number; budgetROI?: null | number; budgetRevenue?: null | number; defaultGroup?: { _info?: {}; id?: null | number; name?: string }; emailsSent?: null | number; endDate?: string; id?: number; impressions?: null | number; inactive?: null | boolean; inactiveDaysAfterEnd?: null | number; locationId?: null | number; marketingManagerDefaultTrackId?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; name: string; notes?: string; opportunityDefaultTrackId?: null | number; startDate: string; status?: { _info?: {}; id?: null | number; name?: string }; subType?: { _info?: {}; id?: null | number; name?: string }; type?: { _info?: {}; id?: null | number; name?: string } }>

- Defined in src/Manage/MarketingAPI.ts:97
Parameters
- id: number
- patchOperations: { op?: string; path?: string; value?: {} }[]
Returns Promise<{ _info?: {}; actualCost?: null | number; actualGrossMargin?: null | number; actualROI?: null | number; actualRevenue?: null | number; budgetCost?: null | number; budgetGrossMargin?: null | number; budgetROI?: null | number; budgetRevenue?: null | number; defaultGroup?: { _info?: {}; id?: null | number; name?: string }; emailsSent?: null | number; endDate?: string; id?: number; impressions?: null | number; inactive?: null | boolean; inactiveDaysAfterEnd?: null | number; locationId?: null | number; marketingManagerDefaultTrackId?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; name: string; notes?: string; opportunityDefaultTrackId?: null | number; startDate: string; status?: { _info?: {}; id?: null | number; name?: string }; subType?: { _info?: {}; id?: null | number; name?: string }; type?: { _info?: {}; id?: null | number; name?: string } }>

patchMarketingCampaignsByParentIdAuditsById

patchMarketingCampaignsByParentIdAuditsById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ campaignId?: null | number; createdBy?: string; dateCreated?: string; documentsCreated?: null | number; emailSubject?: string; emailsSent: null | number; emailsUnsent?: null | number; group?: { _info?: {}; id?: null | number; name?: string }; id?: number }>

- Defined in src/Manage/MarketingAPI.ts:208
Parameters
- id: number
- parentId: number
- patchOperations: { op?: string; path?: string; value?: {} }[]
Returns Promise<{ campaignId?: null | number; createdBy?: string; dateCreated?: string; documentsCreated?: null | number; emailSubject?: string; emailsSent: null | number; emailsUnsent?: null | number; group?: { _info?: {}; id?: null | number; name?: string }; id?: number }>

patchMarketingCampaignsByParentIdEmailsOpenedById

patchMarketingCampaignsByParentIdEmailsOpenedById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ campaignId?: null | number; contactId: null | number; dateOpened?: string; id?: number }>

- Defined in src/Manage/MarketingAPI.ts:287
Parameters
- id: number
- parentId: number
- patchOperations: { op?: string; path?: string; value?: {} }[]
Returns Promise<{ campaignId?: null | number; contactId: null | number; dateOpened?: string; id?: number }>

patchMarketingCampaignsByParentIdFormsSubmittedById

patchMarketingCampaignsByParentIdFormsSubmittedById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ campaignId?: null | number; contactId: null | number; dateSubmitted?: string; id?: number; pageSubType?: string; pageType?: string; queryString?: string; status?: string; topic?: string; url: string; version?: string }>

- Defined in src/Manage/MarketingAPI.ts:366
Parameters
- id: number
- parentId: number
- patchOperations: { op?: string; path?: string; value?: {} }[]
Returns Promise<{ campaignId?: null | number; contactId: null | number; dateSubmitted?: string; id?: number; pageSubType?: string; pageType?: string; queryString?: string; status?: string; topic?: string; url: string; version?: string }>

patchMarketingCampaignsByParentIdLinksClickedById

patchMarketingCampaignsByParentIdLinksClickedById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ campaignId?: null | number; contactId: null | number; dateClicked?: string; id?: number; queryString?: string; url: string }>

- Defined in src/Manage/MarketingAPI.ts:445
Parameters
- id: number
- parentId: number
- patchOperations: { op?: string; path?: string; value?: {} }[]
Returns Promise<{ campaignId?: null | number; contactId: null | number; dateClicked?: string; id?: number; queryString?: string; url: string }>

patchMarketingCampaignsStatusesById

patchMarketingCampaignsStatusesById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string }>

- Defined in src/Manage/MarketingAPI.ts:521
Parameters
- id: number
- patchOperations: { op?: string; path?: string; value?: {} }[]
Returns Promise<{ _info?: {}; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string }>

patchMarketingCampaignsSubTypesById

patchMarketingCampaignsSubTypesById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; id?: number; name: string; type?: { _info?: {}; id?: null | number; name?: string } }>

- Defined in src/Manage/MarketingAPI.ts:589
Parameters
- id: number
- patchOperations: { op?: string; path?: string; value?: {} }[]
Returns Promise<{ _info?: {}; id?: number; name: string; type?: { _info?: {}; id?: null | number; name?: string } }>

patchMarketingCampaignsTypesById

patchMarketingCampaignsTypesById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; defaultFlag?: null | boolean; id?: number; name: string }>

- Defined in src/Manage/MarketingAPI.ts:647
Parameters
- id: number
- patchOperations: { op?: string; path?: string; value?: {} }[]
Returns Promise<{ _info?: {}; defaultFlag?: null | boolean; id?: number; name: string }>

patchMarketingGroupsById

patchMarketingGroupsById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; id?: number; inactiveFlag?: null | boolean; name: string; publicDescription?: string; publicFlag?: null | boolean }>

- Defined in src/Manage/MarketingAPI.ts:766
Parameters
- id: number
- patchOperations: { op?: string; path?: string; value?: {} }[]
Returns Promise<{ _info?: {}; id?: number; inactiveFlag?: null | boolean; name: string; publicDescription?: string; publicFlag?: null | boolean }>

patchMarketingGroupsByParentIdCompaniesById

patchMarketingGroupsByParentIdCompaniesById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; allContactsFlag?: null | boolean; defaultContactFlag?: null | boolean; groupId?: null | number; id?: number; unsubscribeFlag?: null | boolean }>

- Defined in src/Manage/MarketingAPI.ts:849
Parameters
- id: number
- parentId: number
- patchOperations: { op?: string; path?: string; value?: {} }[]
Returns Promise<{ _info?: {}; allContactsFlag?: null | boolean; defaultContactFlag?: null | boolean; groupId?: null | number; id?: number; unsubscribeFlag?: null | boolean }>

patchMarketingGroupsByParentIdContactsById

patchMarketingGroupsByParentIdContactsById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; groupId?: null | number; id?: number; note?: string; unsubscribeFlag?: null | boolean }>

- Defined in src/Manage/MarketingAPI.ts:928
Parameters
- id: number
- parentId: number
- patchOperations: { op?: string; path?: string; value?: {} }[]
Returns Promise<{ _info?: {}; groupId?: null | number; id?: number; note?: string; unsubscribeFlag?: null | boolean }>

postMarketingCampaigns

postMarketingCampaigns(campaign: { _info?: {}; actualCost?: null | number; actualGrossMargin?: null | number; actualROI?: null | number; actualRevenue?: null | number; budgetCost?: null | number; budgetGrossMargin?: null | number; budgetROI?: null | number; budgetRevenue?: null | number; defaultGroup?: { _info?: {}; id?: null | number; name?: string }; emailsSent?: null | number; endDate?: string; id?: number; impressions?: null | number; inactive?: null | boolean; inactiveDaysAfterEnd?: null | number; locationId?: null | number; marketingManagerDefaultTrackId?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; name: string; notes?: string; opportunityDefaultTrackId?: null | number; startDate: string; status?: { _info?: {}; id?: null | number; name?: string }; subType?: { _info?: {}; id?: null | number; name?: string }; type?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; actualCost?: null | number; actualGrossMargin?: null | number; actualROI?: null | number; actualRevenue?: null | number; budgetCost?: null | number; budgetGrossMargin?: null | number; budgetROI?: null | number; budgetRevenue?: null | number; defaultGroup?: { _info?: {}; id?: null | number; name?: string }; emailsSent?: null | number; endDate?: string; id?: number; impressions?: null | number; inactive?: null | boolean; inactiveDaysAfterEnd?: null | number; locationId?: null | number; marketingManagerDefaultTrackId?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; name: string; notes?: string; opportunityDefaultTrackId?: null | number; startDate: string; status?: { _info?: {}; id?: null | number; name?: string }; subType?: { _info?: {}; id?: null | number; name?: string }; type?: { _info?: {}; id?: null | number; name?: string } }>

- Defined in src/Manage/MarketingAPI.ts:66
Parameters
- campaign: { _info?: {}; actualCost?: null | number; actualGrossMargin?: null | number; actualROI?: null | number; actualRevenue?: null | number; budgetCost?: null | number; budgetGrossMargin?: null | number; budgetROI?: null | number; budgetRevenue?: null | number; defaultGroup?: { _info?: {}; id?: null | number; name?: string }; emailsSent?: null | number; endDate?: string; id?: number; impressions?: null | number; inactive?: null | boolean; inactiveDaysAfterEnd?: null | number; locationId?: null | number; marketingManagerDefaultTrackId?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; name: string; notes?: string; opportunityDefaultTrackId?: null | number; startDate: string; status?: { _info?: {}; id?: null | number; name?: string }; subType?: { _info?: {}; id?: null | number; name?: string }; type?: { _info?: {}; id?: null | number; name?: string } }
  - Optional _info?: {}
    - [key: string]: string
  - Optional actualCost?: null | number
    
    Format: double
  - Optional actualGrossMargin?: null | number
    
    Format: double
  - Optional actualROI?: null | number
    
    Format: double
  - Optional actualRevenue?: null | number
    
    Format: double
  - Optional budgetCost?: null | number
    
    Format: double
  - Optional budgetGrossMargin?: null | number
    
    Format: double
  - Optional budgetROI?: null | number
    
    Format: double
  - Optional budgetRevenue?: null | number
    
    Format: double
  - Optional defaultGroup?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional emailsSent?: null | number
    
    Format: int32
  - Optional endDate?: string
    
    Format: date-time
  - Optional id?: number
    
    Format: int32
  - Optional impressions?: null | number
    
    Format: int32
  - Optional inactive?: null | boolean
  - Optional inactiveDaysAfterEnd?: null | number
    
    Format: int32
  - Optional locationId?: null | number
    
    Format: int32
  - Optional marketingManagerDefaultTrackId?: null | number
    
    Format: int32
  - Optional member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional identifier?: string
    - Optional name?: string
  - name: string
    description
    Max length: 50;
  - Optional notes?: string
  - Optional opportunityDefaultTrackId?: null | number
    
    Format: int32
  - startDate: string
    
    Format: date-time
  - Optional status?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional subType?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional type?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
Returns Promise<{ _info?: {}; actualCost?: null | number; actualGrossMargin?: null | number; actualROI?: null | number; actualRevenue?: null | number; budgetCost?: null | number; budgetGrossMargin?: null | number; budgetROI?: null | number; budgetRevenue?: null | number; defaultGroup?: { _info?: {}; id?: null | number; name?: string }; emailsSent?: null | number; endDate?: string; id?: number; impressions?: null | number; inactive?: null | boolean; inactiveDaysAfterEnd?: null | number; locationId?: null | number; marketingManagerDefaultTrackId?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; name: string; notes?: string; opportunityDefaultTrackId?: null | number; startDate: string; status?: { _info?: {}; id?: null | number; name?: string }; subType?: { _info?: {}; id?: null | number; name?: string }; type?: { _info?: {}; id?: null | number; name?: string } }>

postMarketingCampaignsByParentIdAudits

postMarketingCampaignsByParentIdAudits(parentId: number, campaignAudit: { campaignId?: null | number; createdBy?: string; dateCreated?: string; documentsCreated?: null | number; emailSubject?: string; emailsSent: null | number; emailsUnsent?: null | number; group?: { _info?: {}; id?: null | number; name?: string }; id?: number }): Promise<{ campaignId?: null | number; createdBy?: string; dateCreated?: string; documentsCreated?: null | number; emailSubject?: string; emailsSent: null | number; emailsUnsent?: null | number; group?: { _info?: {}; id?: null | number; name?: string }; id?: number }>

- Defined in src/Manage/MarketingAPI.ts:163
Parameters
- parentId: number
- campaignAudit: { campaignId?: null | number; createdBy?: string; dateCreated?: string; documentsCreated?: null | number; emailSubject?: string; emailsSent: null | number; emailsUnsent?: null | number; group?: { _info?: {}; id?: null | number; name?: string }; id?: number }
  - Optional campaignId?: null | number
    
    Format: int32
  - Optional createdBy?: string
  - Optional dateCreated?: string
  - Optional documentsCreated?: null | number
    
    Format: int32
  - Optional emailSubject?: string
    description
    Max length: 1000;
  - emailsSent: null | number
    
    Format: int32
  - Optional emailsUnsent?: null | number
    
    Format: int32
  - Optional group?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional id?: number
    
    Format: int32
Returns Promise<{ campaignId?: null | number; createdBy?: string; dateCreated?: string; documentsCreated?: null | number; emailSubject?: string; emailsSent: null | number; emailsUnsent?: null | number; group?: { _info?: {}; id?: null | number; name?: string }; id?: number }>

postMarketingCampaignsByParentIdEmailsOpened

postMarketingCampaignsByParentIdEmailsOpened(parentId: number, emailOpened: { campaignId?: null | number; contactId: null | number; dateOpened?: string; id?: number }): Promise<{ campaignId?: null | number; contactId: null | number; dateOpened?: string; id?: number }>

- Defined in src/Manage/MarketingAPI.ts:242
Parameters
- parentId: number
- emailOpened: { campaignId?: null | number; contactId: null | number; dateOpened?: string; id?: number }
  - Optional campaignId?: null | number
    
    Format: int32
  - contactId: null | number
    
    Format: int32
  - Optional dateOpened?: string
    
    Format: date-time
  - Optional id?: number
    
    Format: int32
Returns Promise<{ campaignId?: null | number; contactId: null | number; dateOpened?: string; id?: number }>

postMarketingCampaignsByParentIdFormsSubmitted

postMarketingCampaignsByParentIdFormsSubmitted(parentId: number, formSubmitted: { campaignId?: null | number; contactId: null | number; dateSubmitted?: string; id?: number; pageSubType?: string; pageType?: string; queryString?: string; status?: string; topic?: string; url: string; version?: string }): Promise<{ campaignId?: null | number; contactId: null | number; dateSubmitted?: string; id?: number; pageSubType?: string; pageType?: string; queryString?: string; status?: string; topic?: string; url: string; version?: string }>

- Defined in src/Manage/MarketingAPI.ts:321
Parameters
- parentId: number
- formSubmitted: { campaignId?: null | number; contactId: null | number; dateSubmitted?: string; id?: number; pageSubType?: string; pageType?: string; queryString?: string; status?: string; topic?: string; url: string; version?: string }
  - Optional campaignId?: null | number
    
    Format: int32
  - contactId: null | number
    
    Format: int32
  - Optional dateSubmitted?: string
    
    Format: date-time
  - Optional id?: number
    
    Format: int32
  - Optional pageSubType?: string
  - Optional pageType?: string
  - Optional queryString?: string
  - Optional status?: string
  - Optional topic?: string
  - url: string
    description
    Max length: 2083;
  - Optional version?: string
Returns Promise<{ campaignId?: null | number; contactId: null | number; dateSubmitted?: string; id?: number; pageSubType?: string; pageType?: string; queryString?: string; status?: string; topic?: string; url: string; version?: string }>

postMarketingCampaignsByParentIdLinksClicked

postMarketingCampaignsByParentIdLinksClicked(parentId: number, linkClicked: { campaignId?: null | number; contactId: null | number; dateClicked?: string; id?: number; queryString?: string; url: string }): Promise<{ campaignId?: null | number; contactId: null | number; dateClicked?: string; id?: number; queryString?: string; url: string }>

- Defined in src/Manage/MarketingAPI.ts:400
Parameters
- parentId: number
- linkClicked: { campaignId?: null | number; contactId: null | number; dateClicked?: string; id?: number; queryString?: string; url: string }
  - Optional campaignId?: null | number
    
    Format: int32
  - contactId: null | number
    
    Format: int32
  - Optional dateClicked?: string
    
    Format: date-time
  - Optional id?: number
    
    Format: int32
  - Optional queryString?: string
  - url: string
    description
    Max length: 2083;
Returns Promise<{ campaignId?: null | number; contactId: null | number; dateClicked?: string; id?: number; queryString?: string; url: string }>

postMarketingCampaignsStatuses

postMarketingCampaignsStatuses(campaignStatus: { _info?: {}; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string }): Promise<{ _info?: {}; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string }>

- Defined in src/Manage/MarketingAPI.ts:484
Parameters
- campaignStatus: { _info?: {}; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string }
  - Optional _info?: {}
    - [key: string]: string
  - Optional defaultFlag?: null | boolean
  - Optional id?: number
    
    Format: int32
  - Optional inactiveFlag?: null | boolean
  - name: string
    description
    Max length: 100;
Returns Promise<{ _info?: {}; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string }>

postMarketingCampaignsSubTypes

postMarketingCampaignsSubTypes(campaignSubType: { _info?: {}; id?: number; name: string; type?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; id?: number; name: string; type?: { _info?: {}; id?: null | number; name?: string } }>

- Defined in src/Manage/MarketingAPI.ts:550
Parameters
- campaignSubType: { _info?: {}; id?: number; name: string; type?: { _info?: {}; id?: null | number; name?: string } }
  - Optional _info?: {}
    - [key: string]: string
  - Optional id?: number
    
    Format: int32
  - name: string
    description
    Max length: 100;
  - Optional type?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
Returns Promise<{ _info?: {}; id?: number; name: string; type?: { _info?: {}; id?: null | number; name?: string } }>

postMarketingCampaignsTypes

postMarketingCampaignsTypes(campaignType: { _info?: {}; defaultFlag?: null | boolean; id?: number; name: string }): Promise<{ _info?: {}; defaultFlag?: null | boolean; id?: number; name: string }>

- Defined in src/Manage/MarketingAPI.ts:616
Parameters
- campaignType: { _info?: {}; defaultFlag?: null | boolean; id?: number; name: string }
  - Optional _info?: {}
    - [key: string]: string
  - Optional defaultFlag?: null | boolean
  - Optional id?: number
    
    Format: int32
  - name: string
    description
    Max length: 100;
Returns Promise<{ _info?: {}; defaultFlag?: null | boolean; id?: number; name: string }>

postMarketingGroups

postMarketingGroups(group: { _info?: {}; id?: number; inactiveFlag?: null | boolean; name: string; publicDescription?: string; publicFlag?: null | boolean }): Promise<{ _info?: {}; id?: number; inactiveFlag?: null | boolean; name: string; publicDescription?: string; publicFlag?: null | boolean }>

- Defined in src/Manage/MarketingAPI.ts:735
Parameters
- group: { _info?: {}; id?: number; inactiveFlag?: null | boolean; name: string; publicDescription?: string; publicFlag?: null | boolean }
  - Optional _info?: {}
    - [key: string]: string
  - Optional id?: number
    
    Format: int32
  - Optional inactiveFlag?: null | boolean
  - name: string
  - Optional publicDescription?: string
    description
    Max length: 255;
  - Optional publicFlag?: null | boolean
Returns Promise<{ _info?: {}; id?: number; inactiveFlag?: null | boolean; name: string; publicDescription?: string; publicFlag?: null | boolean }>

postMarketingGroupsByParentIdCompanies

postMarketingGroupsByParentIdCompanies(parentId: number, marketingCompany: { _info?: {}; allContactsFlag?: null | boolean; defaultContactFlag?: null | boolean; groupId?: null | number; id?: number; unsubscribeFlag?: null | boolean }): Promise<{ _info?: {}; allContactsFlag?: null | boolean; defaultContactFlag?: null | boolean; groupId?: null | number; id?: number; unsubscribeFlag?: null | boolean }>

- Defined in src/Manage/MarketingAPI.ts:804
Parameters
- parentId: number
- marketingCompany: { _info?: {}; allContactsFlag?: null | boolean; defaultContactFlag?: null | boolean; groupId?: null | number; id?: number; unsubscribeFlag?: null | boolean }
  - Optional _info?: {}
    - [key: string]: string
  - Optional allContactsFlag?: null | boolean
  - Optional defaultContactFlag?: null | boolean
  - Optional groupId?: null | number
    
    Format: int32
  - Optional id?: number
    
    Format: int32
  - Optional unsubscribeFlag?: null | boolean
Returns Promise<{ _info?: {}; allContactsFlag?: null | boolean; defaultContactFlag?: null | boolean; groupId?: null | number; id?: number; unsubscribeFlag?: null | boolean }>

postMarketingGroupsByParentIdContacts

postMarketingGroupsByParentIdContacts(parentId: number, marketingContact: { _info?: {}; groupId?: null | number; id?: number; note?: string; unsubscribeFlag?: null | boolean }): Promise<{ _info?: {}; groupId?: null | number; id?: number; note?: string; unsubscribeFlag?: null | boolean }>

- Defined in src/Manage/MarketingAPI.ts:883
Parameters
- parentId: number
- marketingContact: { _info?: {}; groupId?: null | number; id?: number; note?: string; unsubscribeFlag?: null | boolean }
  - Optional _info?: {}
    - [key: string]: string
  - Optional groupId?: null | number
    
    Format: int32
  - Optional id?: number
    
    Format: int32
  - Optional note?: string
    description
    Max length: 50;
  - Optional unsubscribeFlag?: null | boolean
Returns Promise<{ _info?: {}; groupId?: null | number; id?: number; note?: string; unsubscribeFlag?: null | boolean }>

putMarketingCampaignsById

putMarketingCampaignsById(id: number, campaign: { _info?: {}; actualCost?: null | number; actualGrossMargin?: null | number; actualROI?: null | number; actualRevenue?: null | number; budgetCost?: null | number; budgetGrossMargin?: null | number; budgetROI?: null | number; budgetRevenue?: null | number; defaultGroup?: { _info?: {}; id?: null | number; name?: string }; emailsSent?: null | number; endDate?: string; id?: number; impressions?: null | number; inactive?: null | boolean; inactiveDaysAfterEnd?: null | number; locationId?: null | number; marketingManagerDefaultTrackId?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; name: string; notes?: string; opportunityDefaultTrackId?: null | number; startDate: string; status?: { _info?: {}; id?: null | number; name?: string }; subType?: { _info?: {}; id?: null | number; name?: string }; type?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; actualCost?: null | number; actualGrossMargin?: null | number; actualROI?: null | number; actualRevenue?: null | number; budgetCost?: null | number; budgetGrossMargin?: null | number; budgetROI?: null | number; budgetRevenue?: null | number; defaultGroup?: { _info?: {}; id?: null | number; name?: string }; emailsSent?: null | number; endDate?: string; id?: number; impressions?: null | number; inactive?: null | boolean; inactiveDaysAfterEnd?: null | number; locationId?: null | number; marketingManagerDefaultTrackId?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; name: string; notes?: string; opportunityDefaultTrackId?: null | number; startDate: string; status?: { _info?: {}; id?: null | number; name?: string }; subType?: { _info?: {}; id?: null | number; name?: string }; type?: { _info?: {}; id?: null | number; name?: string } }>

- Defined in src/Manage/MarketingAPI.ts:89
Parameters
- id: number
- campaign: { _info?: {}; actualCost?: null | number; actualGrossMargin?: null | number; actualROI?: null | number; actualRevenue?: null | number; budgetCost?: null | number; budgetGrossMargin?: null | number; budgetROI?: null | number; budgetRevenue?: null | number; defaultGroup?: { _info?: {}; id?: null | number; name?: string }; emailsSent?: null | number; endDate?: string; id?: number; impressions?: null | number; inactive?: null | boolean; inactiveDaysAfterEnd?: null | number; locationId?: null | number; marketingManagerDefaultTrackId?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; name: string; notes?: string; opportunityDefaultTrackId?: null | number; startDate: string; status?: { _info?: {}; id?: null | number; name?: string }; subType?: { _info?: {}; id?: null | number; name?: string }; type?: { _info?: {}; id?: null | number; name?: string } }
  - Optional _info?: {}
    - [key: string]: string
  - Optional actualCost?: null | number
    
    Format: double
  - Optional actualGrossMargin?: null | number
    
    Format: double
  - Optional actualROI?: null | number
    
    Format: double
  - Optional actualRevenue?: null | number
    
    Format: double
  - Optional budgetCost?: null | number
    
    Format: double
  - Optional budgetGrossMargin?: null | number
    
    Format: double
  - Optional budgetROI?: null | number
    
    Format: double
  - Optional budgetRevenue?: null | number
    
    Format: double
  - Optional defaultGroup?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional emailsSent?: null | number
    
    Format: int32
  - Optional endDate?: string
    
    Format: date-time
  - Optional id?: number
    
    Format: int32
  - Optional impressions?: null | number
    
    Format: int32
  - Optional inactive?: null | boolean
  - Optional inactiveDaysAfterEnd?: null | number
    
    Format: int32
  - Optional locationId?: null | number
    
    Format: int32
  - Optional marketingManagerDefaultTrackId?: null | number
    
    Format: int32
  - Optional member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional identifier?: string
    - Optional name?: string
  - name: string
    description
    Max length: 50;
  - Optional notes?: string
  - Optional opportunityDefaultTrackId?: null | number
    
    Format: int32
  - startDate: string
    
    Format: date-time
  - Optional status?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional subType?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional type?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
Returns Promise<{ _info?: {}; actualCost?: null | number; actualGrossMargin?: null | number; actualROI?: null | number; actualRevenue?: null | number; budgetCost?: null | number; budgetGrossMargin?: null | number; budgetROI?: null | number; budgetRevenue?: null | number; defaultGroup?: { _info?: {}; id?: null | number; name?: string }; emailsSent?: null | number; endDate?: string; id?: number; impressions?: null | number; inactive?: null | boolean; inactiveDaysAfterEnd?: null | number; locationId?: null | number; marketingManagerDefaultTrackId?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; name: string; notes?: string; opportunityDefaultTrackId?: null | number; startDate: string; status?: { _info?: {}; id?: null | number; name?: string }; subType?: { _info?: {}; id?: null | number; name?: string }; type?: { _info?: {}; id?: null | number; name?: string } }>

putMarketingCampaignsByParentIdAuditsById

putMarketingCampaignsByParentIdAuditsById(id: number, parentId: number, campaignAudit: { campaignId?: null | number; createdBy?: string; dateCreated?: string; documentsCreated?: null | number; emailSubject?: string; emailsSent: null | number; emailsUnsent?: null | number; group?: { _info?: {}; id?: null | number; name?: string }; id?: number }): Promise<{ campaignId?: null | number; createdBy?: string; dateCreated?: string; documentsCreated?: null | number; emailSubject?: string; emailsSent: null | number; emailsUnsent?: null | number; group?: { _info?: {}; id?: null | number; name?: string }; id?: number }>

- Defined in src/Manage/MarketingAPI.ts:196
Parameters
- id: number
- parentId: number
- campaignAudit: { campaignId?: null | number; createdBy?: string; dateCreated?: string; documentsCreated?: null | number; emailSubject?: string; emailsSent: null | number; emailsUnsent?: null | number; group?: { _info?: {}; id?: null | number; name?: string }; id?: number }
  - Optional campaignId?: null | number
    
    Format: int32
  - Optional createdBy?: string
  - Optional dateCreated?: string
  - Optional documentsCreated?: null | number
    
    Format: int32
  - Optional emailSubject?: string
    description
    Max length: 1000;
  - emailsSent: null | number
    
    Format: int32
  - Optional emailsUnsent?: null | number
    
    Format: int32
  - Optional group?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional id?: number
    
    Format: int32
Returns Promise<{ campaignId?: null | number; createdBy?: string; dateCreated?: string; documentsCreated?: null | number; emailSubject?: string; emailsSent: null | number; emailsUnsent?: null | number; group?: { _info?: {}; id?: null | number; name?: string }; id?: number }>

putMarketingCampaignsByParentIdEmailsOpenedById

putMarketingCampaignsByParentIdEmailsOpenedById(id: number, parentId: number, emailOpened: { campaignId?: null | number; contactId: null | number; dateOpened?: string; id?: number }): Promise<{ campaignId?: null | number; contactId: null | number; dateOpened?: string; id?: number }>

- Defined in src/Manage/MarketingAPI.ts:275
Parameters
- id: number
- parentId: number
- emailOpened: { campaignId?: null | number; contactId: null | number; dateOpened?: string; id?: number }
  - Optional campaignId?: null | number
    
    Format: int32
  - contactId: null | number
    
    Format: int32
  - Optional dateOpened?: string
    
    Format: date-time
  - Optional id?: number
    
    Format: int32
Returns Promise<{ campaignId?: null | number; contactId: null | number; dateOpened?: string; id?: number }>

putMarketingCampaignsByParentIdFormsSubmittedById

putMarketingCampaignsByParentIdFormsSubmittedById(id: number, parentId: number, formSubmitted: { campaignId?: null | number; contactId: null | number; dateSubmitted?: string; id?: number; pageSubType?: string; pageType?: string; queryString?: string; status?: string; topic?: string; url: string; version?: string }): Promise<{ campaignId?: null | number; contactId: null | number; dateSubmitted?: string; id?: number; pageSubType?: string; pageType?: string; queryString?: string; status?: string; topic?: string; url: string; version?: string }>

- Defined in src/Manage/MarketingAPI.ts:354
Parameters
- id: number
- parentId: number
- formSubmitted: { campaignId?: null | number; contactId: null | number; dateSubmitted?: string; id?: number; pageSubType?: string; pageType?: string; queryString?: string; status?: string; topic?: string; url: string; version?: string }
  - Optional campaignId?: null | number
    
    Format: int32
  - contactId: null | number
    
    Format: int32
  - Optional dateSubmitted?: string
    
    Format: date-time
  - Optional id?: number
    
    Format: int32
  - Optional pageSubType?: string
  - Optional pageType?: string
  - Optional queryString?: string
  - Optional status?: string
  - Optional topic?: string
  - url: string
    description
    Max length: 2083;
  - Optional version?: string
Returns Promise<{ campaignId?: null | number; contactId: null | number; dateSubmitted?: string; id?: number; pageSubType?: string; pageType?: string; queryString?: string; status?: string; topic?: string; url: string; version?: string }>

putMarketingCampaignsByParentIdLinksClickedById

putMarketingCampaignsByParentIdLinksClickedById(id: number, parentId: number, linkClicked: { campaignId?: null | number; contactId: null | number; dateClicked?: string; id?: number; queryString?: string; url: string }): Promise<{ campaignId?: null | number; contactId: null | number; dateClicked?: string; id?: number; queryString?: string; url: string }>

- Defined in src/Manage/MarketingAPI.ts:433
Parameters
- id: number
- parentId: number
- linkClicked: { campaignId?: null | number; contactId: null | number; dateClicked?: string; id?: number; queryString?: string; url: string }
  - Optional campaignId?: null | number
    
    Format: int32
  - contactId: null | number
    
    Format: int32
  - Optional dateClicked?: string
    
    Format: date-time
  - Optional id?: number
    
    Format: int32
  - Optional queryString?: string
  - url: string
    description
    Max length: 2083;
Returns Promise<{ campaignId?: null | number; contactId: null | number; dateClicked?: string; id?: number; queryString?: string; url: string }>

putMarketingCampaignsStatusesById

putMarketingCampaignsStatusesById(id: number, campaignStatus: { _info?: {}; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string }): Promise<{ _info?: {}; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string }>

- Defined in src/Manage/MarketingAPI.ts:510
Parameters
- id: number
- campaignStatus: { _info?: {}; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string }
  - Optional _info?: {}
    - [key: string]: string
  - Optional defaultFlag?: null | boolean
  - Optional id?: number
    
    Format: int32
  - Optional inactiveFlag?: null | boolean
  - name: string
    description
    Max length: 100;
Returns Promise<{ _info?: {}; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string }>

putMarketingCampaignsSubTypesById

putMarketingCampaignsSubTypesById(id: number, campaignSubType: { _info?: {}; id?: number; name: string; type?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; id?: number; name: string; type?: { _info?: {}; id?: null | number; name?: string } }>

- Defined in src/Manage/MarketingAPI.ts:578
Parameters
- id: number
- campaignSubType: { _info?: {}; id?: number; name: string; type?: { _info?: {}; id?: null | number; name?: string } }
  - Optional _info?: {}
    - [key: string]: string
  - Optional id?: number
    
    Format: int32
  - name: string
    description
    Max length: 100;
  - Optional type?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
Returns Promise<{ _info?: {}; id?: number; name: string; type?: { _info?: {}; id?: null | number; name?: string } }>

putMarketingCampaignsTypesById

putMarketingCampaignsTypesById(id: number, campaignType: { _info?: {}; defaultFlag?: null | boolean; id?: number; name: string }): Promise<{ _info?: {}; defaultFlag?: null | boolean; id?: number; name: string }>

- Defined in src/Manage/MarketingAPI.ts:639
Parameters
- id: number
- campaignType: { _info?: {}; defaultFlag?: null | boolean; id?: number; name: string }
  - Optional _info?: {}
    - [key: string]: string
  - Optional defaultFlag?: null | boolean
  - Optional id?: number
    
    Format: int32
  - name: string
    description
    Max length: 100;
Returns Promise<{ _info?: {}; defaultFlag?: null | boolean; id?: number; name: string }>

putMarketingGroupsById

putMarketingGroupsById(id: number, group: { _info?: {}; id?: number; inactiveFlag?: null | boolean; name: string; publicDescription?: string; publicFlag?: null | boolean }): Promise<{ _info?: {}; id?: number; inactiveFlag?: null | boolean; name: string; publicDescription?: string; publicFlag?: null | boolean }>

- Defined in src/Manage/MarketingAPI.ts:758
Parameters
- id: number
- group: { _info?: {}; id?: number; inactiveFlag?: null | boolean; name: string; publicDescription?: string; publicFlag?: null | boolean }
  - Optional _info?: {}
    - [key: string]: string
  - Optional id?: number
    
    Format: int32
  - Optional inactiveFlag?: null | boolean
  - name: string
  - Optional publicDescription?: string
    description
    Max length: 255;
  - Optional publicFlag?: null | boolean
Returns Promise<{ _info?: {}; id?: number; inactiveFlag?: null | boolean; name: string; publicDescription?: string; publicFlag?: null | boolean }>

putMarketingGroupsByParentIdCompaniesById

putMarketingGroupsByParentIdCompaniesById(id: number, parentId: number, marketingCompany: { _info?: {}; allContactsFlag?: null | boolean; defaultContactFlag?: null | boolean; groupId?: null | number; id?: number; unsubscribeFlag?: null | boolean }): Promise<{ _info?: {}; allContactsFlag?: null | boolean; defaultContactFlag?: null | boolean; groupId?: null | number; id?: number; unsubscribeFlag?: null | boolean }>

- Defined in src/Manage/MarketingAPI.ts:837
Parameters
- id: number
- parentId: number
- marketingCompany: { _info?: {}; allContactsFlag?: null | boolean; defaultContactFlag?: null | boolean; groupId?: null | number; id?: number; unsubscribeFlag?: null | boolean }
  - Optional _info?: {}
    - [key: string]: string
  - Optional allContactsFlag?: null | boolean
  - Optional defaultContactFlag?: null | boolean
  - Optional groupId?: null | number
    
    Format: int32
  - Optional id?: number
    
    Format: int32
  - Optional unsubscribeFlag?: null | boolean
Returns Promise<{ _info?: {}; allContactsFlag?: null | boolean; defaultContactFlag?: null | boolean; groupId?: null | number; id?: number; unsubscribeFlag?: null | boolean }>

putMarketingGroupsByParentIdContactsById

putMarketingGroupsByParentIdContactsById(id: number, parentId: number, marketingContact: { _info?: {}; groupId?: null | number; id?: number; note?: string; unsubscribeFlag?: null | boolean }): Promise<{ _info?: {}; groupId?: null | number; id?: number; note?: string; unsubscribeFlag?: null | boolean }>

- Defined in src/Manage/MarketingAPI.ts:916
Parameters
- id: number
- parentId: number
- marketingContact: { _info?: {}; groupId?: null | number; id?: number; note?: string; unsubscribeFlag?: null | boolean }
  - Optional _info?: {}
    - [key: string]: string
  - Optional groupId?: null | number
    
    Format: int32
  - Optional id?: number
    
    Format: int32
  - Optional note?: string
    description
    Max length: 50;
  - Optional unsubscribeFlag?: null | boolean
Returns Promise<{ _info?: {}; groupId?: null | number; id?: number; note?: string; unsubscribeFlag?: null | boolean }>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

props: CWMOptions

Returns MarketingAPI

Properties

config

paginate

Type declaration

Parameters

apiMethod: Function

paginateArgs: PaginationOptions

Rest ...methodArgs: Record<string, unknown>[]

Returns Promise<unknown[]>

request

Type declaration

Parameters

args: RequestOptions

Returns Promise<any>

Methods

deleteMarketingCampaignsById

Parameters

id: number

Returns Promise<undefined>

deleteMarketingCampaignsByParentIdAuditsById

Parameters

id: number

parentId: number

Returns Promise<undefined>

deleteMarketingCampaignsByParentIdEmailsOpenedById

Parameters

id: number

parentId: number

Returns Promise<undefined>

deleteMarketingCampaignsByParentIdFormsSubmittedById

Parameters

id: number

parentId: number

Returns Promise<undefined>

deleteMarketingCampaignsByParentIdLinksClickedById

Parameters

id: number

parentId: number

Returns Promise<undefined>

deleteMarketingCampaignsStatusesById

Parameters

id: number

Returns Promise<undefined>

deleteMarketingCampaignsSubTypesById

Parameters

id: number

Returns Promise<undefined>

deleteMarketingCampaignsTypesById

Parameters

id: number

Returns Promise<undefined>

deleteMarketingGroupsById

Parameters

id: number

Returns Promise<undefined>

deleteMarketingGroupsByParentIdCompaniesById

Parameters

id: number

parentId: number

Returns Promise<undefined>

deleteMarketingGroupsByParentIdContactsById

Parameters

id: number

parentId: number

Returns Promise<undefined>

getMarketingCampaigns

Parameters

params: CommonParameters = {}

getMarketingCampaignsById

Parameters