connectwise-rest
    Preparing search index...

    Class MarketingAPI

    Marketing module

    Hierarchy

    • ManageBaseAPI
      • MarketingAPI
    Index

    Methods

    deleteMarketingCampaignsById deleteMarketingCampaignsByParentIdAuditsById deleteMarketingCampaignsByParentIdEmailsOpenedById deleteMarketingCampaignsByParentIdFormsSubmittedById deleteMarketingCampaignsByParentIdLinksClickedById deleteMarketingCampaignsStatusesById deleteMarketingCampaignsSubTypesById deleteMarketingCampaignsTypesById deleteMarketingGroupsById deleteMarketingGroupsByParentIdCompaniesById deleteMarketingGroupsByParentIdContactsById getMarketingCampaigns getMarketingCampaignsById getMarketingCampaignsByIdActivities getMarketingCampaignsByIdActivitiesCount getMarketingCampaignsByIdOpportunities getMarketingCampaignsByIdOpportunitiesCount getMarketingCampaignsByParentIdAudits getMarketingCampaignsByParentIdAuditsById getMarketingCampaignsByParentIdAuditsCount getMarketingCampaignsByParentIdEmailsOpened getMarketingCampaignsByParentIdEmailsOpenedById getMarketingCampaignsByParentIdEmailsOpenedCount getMarketingCampaignsByParentIdFormsSubmitted getMarketingCampaignsByParentIdFormsSubmittedById getMarketingCampaignsByParentIdFormsSubmittedCount getMarketingCampaignsByParentIdLinksClicked getMarketingCampaignsByParentIdLinksClickedById getMarketingCampaignsByParentIdLinksClickedCount getMarketingCampaignsCount getMarketingCampaignsStatuses getMarketingCampaignsStatusesById getMarketingCampaignsStatusesCount getMarketingCampaignsSubTypes getMarketingCampaignsSubTypesById getMarketingCampaignsSubTypesCount getMarketingCampaignsTypes getMarketingCampaignsTypesById getMarketingCampaignsTypesByIdInfo getMarketingCampaignsTypesByParentIdSubTypes getMarketingCampaignsTypesByParentIdSubTypesById getMarketingCampaignsTypesByParentIdSubTypesCount getMarketingCampaignsTypesCount getMarketingCampaignsTypesInfo getMarketingCampaignsTypesInfoCount getMarketingGroups getMarketingGroupsById getMarketingGroupsByIdInfo getMarketingGroupsByIdUsages getMarketingGroupsByIdUsagesList getMarketingGroupsByParentIdCompanies getMarketingGroupsByParentIdCompaniesById getMarketingGroupsByParentIdCompaniesCount getMarketingGroupsByParentIdContacts getMarketingGroupsByParentIdContactsById getMarketingGroupsByParentIdContactsCount getMarketingGroupsCount getMarketingGroupsInfo getMarketingGroupsInfoCount patchMarketingCampaignsById patchMarketingCampaignsByParentIdAuditsById patchMarketingCampaignsByParentIdEmailsOpenedById patchMarketingCampaignsByParentIdFormsSubmittedById patchMarketingCampaignsByParentIdLinksClickedById patchMarketingCampaignsStatusesById patchMarketingCampaignsSubTypesById patchMarketingCampaignsTypesById patchMarketingGroupsById patchMarketingGroupsByParentIdCompaniesById patchMarketingGroupsByParentIdContactsById postMarketingCampaigns postMarketingCampaignsByParentIdAudits postMarketingCampaignsByParentIdEmailsOpened postMarketingCampaignsByParentIdFormsSubmitted postMarketingCampaignsByParentIdLinksClicked postMarketingCampaignsStatuses postMarketingCampaignsSubTypes postMarketingCampaignsTypes postMarketingGroups postMarketingGroupsByParentIdCompanies postMarketingGroupsByParentIdContacts putMarketingCampaignsById putMarketingCampaignsByParentIdAuditsById putMarketingCampaignsByParentIdEmailsOpenedById putMarketingCampaignsByParentIdFormsSubmittedById putMarketingCampaignsByParentIdLinksClickedById putMarketingCampaignsStatusesById putMarketingCampaignsSubTypesById putMarketingCampaignsTypesById putMarketingGroupsById putMarketingGroupsByParentIdCompaniesById putMarketingGroupsByParentIdContactsById request

    Methods

    • Parameters

      • id: number

      Returns Promise<undefined>

    • Parameters

      • id: number
      • parentId: number

      Returns Promise<undefined>

    • Parameters

      • id: number
      • parentId: number

      Returns Promise<undefined>

    • Parameters

      • id: number
      • parentId: number

      Returns Promise<undefined>

    • Parameters

      • id: number
      • parentId: number

      Returns Promise<undefined>

    • Parameters

      • id: number

      Returns Promise<undefined>

    • Parameters

      • id: number

      Returns Promise<undefined>

    • Parameters

      • id: number

      Returns Promise<undefined>

    • Parameters

      • id: number
      • parentId: number

      Returns Promise<undefined>

    • Parameters

      • id: number
      • parentId: number

      Returns Promise<undefined>

    • Parameters

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

    • Parameters

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

    • Parameters

      Returns Promise<
          { _info?: { [key: string]: string }; id?: number | null; name?: string }[],
      >

    • Parameters

      Returns Promise<
          { _info?: { [key: string]: string }; id?: number | null; name?: string }[],
      >

    • Parameters

      Returns Promise<
          {
              campaignId?: number
              | null;
              createdBy?: string;
              dateCreated?: string;
              documentsCreated?: number | null;
              emailsSent: number | null;
              emailSubject?: string;
              emailsUnsent?: number | null;
              group?: {
                  _info?: { [key: string]: string };
                  id?: number | null;
                  name?: string;
              };
              id?: number;
          }[],
      >

    • Parameters

      Returns Promise<
          {
              campaignId?: number
              | null;
              createdBy?: string;
              dateCreated?: string;
              documentsCreated?: number | null;
              emailsSent: number | null;
              emailSubject?: string;
              emailsUnsent?: number | null;
              group?: {
                  _info?: { [key: string]: string };
                  id?: number | null;
                  name?: string;
              };
              id?: number;
          },
      >

    • Parameters

      Returns Promise<
          {
              campaignId?: number
              | null;
              contactId: number | null;
              dateOpened?: string;
              id?: number;
          }[],
      >

    • Parameters

      Returns Promise<
          {
              campaignId?: number
              | null;
              contactId: number | null;
              dateOpened?: string;
              id?: number;
          },
      >

    • Parameters

      Returns Promise<
          {
              campaignId?: number
              | null;
              contactId: number | null;
              dateSubmitted?: string;
              id?: number;
              pageSubType?: string;
              pageType?: string;
              queryString?: string;
              status?: string;
              topic?: string;
              url: string;
              version?: string;
          }[],
      >

    • Parameters

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

    • Parameters

      Returns Promise<
          {
              campaignId?: number
              | null;
              contactId: number | null;
              dateClicked?: string;
              id?: number;
              queryString?: string;
              url: string;
          }[],
      >

    • Parameters

      Returns Promise<
          {
              campaignId?: number
              | null;
              contactId: number | null;
              dateClicked?: string;
              id?: number;
              queryString?: string;
              url: string;
          },
      >

    • Parameters

      Returns Promise<
          {
              _info?: { [key: string]: string };
              connectWiseId?: string;
              defaultFlag?: boolean | null;
              id?: number;
              inactiveFlag?: boolean | null;
              name: string;
          }[],
      >

    • Parameters

      Returns Promise<
          {
              _info?: { [key: string]: string };
              connectWiseId?: string;
              defaultFlag?: boolean | null;
              id?: number;
              inactiveFlag?: boolean | null;
              name: string;
          },
      >

    • Parameters

      Returns Promise<
          {
              _info?: { [key: string]: string };
              id?: number;
              name: string;
              type: {
                  _info?: { [key: string]: string };
                  id?: number | null;
                  name?: string;
              };
          }[],
      >

    • Parameters

      Returns Promise<
          {
              _info?: { [key: string]: string };
              id?: number;
              name: string;
              type: {
                  _info?: { [key: string]: string };
                  id?: number | null;
                  name?: string;
              };
          },
      >

    • Parameters

      Returns Promise<
          {
              _info?: { [key: string]: string };
              connectWiseId?: string;
              defaultFlag?: boolean | null;
              id?: number;
              name: string;
          }[],
      >

    • Parameters

      Returns Promise<
          {
              _info?: { [key: string]: string };
              connectWiseId?: string;
              defaultFlag?: boolean | null;
              id?: number;
              name: string;
          },
      >

    • Parameters

      Returns Promise<
          {
              _info?: { [key: string]: string };
              connectWiseId?: string;
              grandParentConnectWiseId?: string;
              grandParentId?: number | null;
              id?: number;
              name?: string;
              parentConnectWiseId?: string;
              parentId?: number | null;
              typeId?: number | null;
          }[],
      >

    • Parameters

      Returns Promise<
          {
              _info?: { [key: string]: string };
              connectWiseId?: string;
              grandParentConnectWiseId?: string;
              grandParentId?: number | null;
              id?: number;
              name?: string;
              parentConnectWiseId?: string;
              parentId?: number | null;
              typeId?: number | null;
          },
      >

    • Parameters

      Returns Promise<
          {
              _info?: { [key: string]: string };
              connectWiseId?: string;
              id?: number;
              inactiveFlag?: boolean | null;
              name: string;
              publicDescription?: string;
              publicFlag?: boolean | null;
          }[],
      >

    • Parameters

      Returns Promise<
          {
              _info?: { [key: string]: string };
              connectWiseId?: string;
              id?: number;
              inactiveFlag?: boolean | null;
              name: string;
              publicDescription?: string;
              publicFlag?: boolean | null;
          },
      >

    • Parameters

      Returns Promise<
          {
              count?: number
              | null;
              description?: string;
              hyperlink?: string;
              id?: number | null;
              type?: string;
              typeKey?: string;
          }[],
      >

    • Parameters

      Returns Promise<
          {
              count?: number
              | null;
              description?: string;
              hyperlink?: string;
              id?: number | null;
              type?: string;
              typeKey?: string;
          }[],
      >

    • Parameters

      Returns Promise<
          {
              _info?: { [key: string]: string };
              allContactsFlag?: boolean | null;
              defaultContactFlag?: boolean | null;
              groupId?: number | null;
              id?: number;
              unsubscribeFlag?: boolean | null;
          }[],
      >

    • Parameters

      Returns Promise<
          {
              _info?: { [key: string]: string };
              allContactsFlag?: boolean | null;
              defaultContactFlag?: boolean | null;
              groupId?: number | null;
              id?: number;
              unsubscribeFlag?: boolean | null;
          },
      >

    • Parameters

      Returns Promise<
          {
              _info?: { [key: string]: string };
              groupId?: number | null;
              id?: number;
              note?: string;
              unsubscribeFlag?: boolean | null;
          }[],
      >

    • Parameters

      Returns Promise<
          {
              _info?: { [key: string]: string };
              groupId?: number | null;
              id?: number;
              note?: string;
              unsubscribeFlag?: boolean | null;
          },
      >

    • Parameters

      • id: number
      • patchOperations: { op?: string; path?: string; value?: Record<string, never> }[]

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

    • Parameters

      • id: number
      • parentId: number
      • patchOperations: { op?: string; path?: string; value?: Record<string, never> }[]

      Returns Promise<
          {
              campaignId?: number
              | null;
              createdBy?: string;
              dateCreated?: string;
              documentsCreated?: number | null;
              emailsSent: number | null;
              emailSubject?: string;
              emailsUnsent?: number | null;
              group?: {
                  _info?: { [key: string]: string };
                  id?: number | null;
                  name?: string;
              };
              id?: number;
          },
      >

    • Parameters

      • id: number
      • parentId: number
      • patchOperations: { op?: string; path?: string; value?: Record<string, never> }[]

      Returns Promise<
          {
              campaignId?: number
              | null;
              contactId: number | null;
              dateOpened?: string;
              id?: number;
          },
      >

    • Parameters

      • id: number
      • parentId: number
      • patchOperations: { op?: string; path?: string; value?: Record<string, never> }[]

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

    • Parameters

      • id: number
      • parentId: number
      • patchOperations: { op?: string; path?: string; value?: Record<string, never> }[]

      Returns Promise<
          {
              campaignId?: number
              | null;
              contactId: number | null;
              dateClicked?: string;
              id?: number;
              queryString?: string;
              url: string;
          },
      >

    • Parameters

      • id: number
      • patchOperations: { op?: string; path?: string; value?: Record<string, never> }[]

      Returns Promise<
          {
              _info?: { [key: string]: string };
              connectWiseId?: string;
              defaultFlag?: boolean | null;
              id?: number;
              inactiveFlag?: boolean | null;
              name: string;
          },
      >

    • Parameters

      • id: number
      • patchOperations: { op?: string; path?: string; value?: Record<string, never> }[]

      Returns Promise<
          {
              _info?: { [key: string]: string };
              id?: number;
              name: string;
              type: {
                  _info?: { [key: string]: string };
                  id?: number | null;
                  name?: string;
              };
          },
      >

    • Parameters

      • id: number
      • patchOperations: { op?: string; path?: string; value?: Record<string, never> }[]

      Returns Promise<
          {
              _info?: { [key: string]: string };
              connectWiseId?: string;
              defaultFlag?: boolean | null;
              id?: number;
              name: string;
          },
      >

    • Parameters

      • id: number
      • patchOperations: { op?: string; path?: string; value?: Record<string, never> }[]

      Returns Promise<
          {
              _info?: { [key: string]: string };
              connectWiseId?: string;
              id?: number;
              inactiveFlag?: boolean | null;
              name: string;
              publicDescription?: string;
              publicFlag?: boolean | null;
          },
      >

    • Parameters

      • id: number
      • parentId: number
      • patchOperations: { op?: string; path?: string; value?: Record<string, never> }[]

      Returns Promise<
          {
              _info?: { [key: string]: string };
              allContactsFlag?: boolean | null;
              defaultContactFlag?: boolean | null;
              groupId?: number | null;
              id?: number;
              unsubscribeFlag?: boolean | null;
          },
      >

    • Parameters

      • id: number
      • parentId: number
      • patchOperations: { op?: string; path?: string; value?: Record<string, never> }[]

      Returns Promise<
          {
              _info?: { [key: string]: string };
              groupId?: number | null;
              id?: number;
              note?: string;
              unsubscribeFlag?: boolean | null;
          },
      >

    • Parameters

      • campaign: {
            _info?: { [key: string]: string };
            actualCost?: number | null;
            actualGrossMargin?: number | null;
            actualRevenue?: number | null;
            actualROI?: number | null;
            budgetCost?: number | null;
            budgetGrossMargin?: number | null;
            budgetRevenue?: number | null;
            budgetROI?: number | null;
            defaultGroup?: {
                _info?: { [key: string]: string };
                id?: number | null;
                name?: string;
            };
            emailsSent?: number
            | null;
            endDate?: string;
            id?: number;
            impressions?: number | null;
            inactive?: boolean | null;
            inactiveDaysAfterEnd?: number | null;
            locationId?: number | null;
            marketingManagerDefaultTrackId?: number | null;
            member?: {
                _info?: { [key: string]: string };
                dailyCapacity?: number | null;
                id?: number | null;
                identifier?: string;
                name?: string;
            };
            name: string;
            notes?: string;
            opportunityDefaultTrackId?: number
            | null;
            startDate: string;
            status?: {
                _info?: { [key: string]: string };
                id?: number | null;
                name?: string;
            };
            subType: {
                _info?: { [key: string]: string };
                id?: number | null;
                name?: string;
            };
            type: {
                _info?: { [key: string]: string };
                id?: number | null;
                name?: string;
            };
        }
        • Optional_info?: { [key: string]: string }
        • OptionalactualCost?: number | null

          Format: double

        • OptionalactualGrossMargin?: number | null

          Format: double

        • OptionalactualRevenue?: number | null

          Format: double

        • OptionalactualROI?: number | null

          Format: double

        • OptionalbudgetCost?: number | null

          Format: double

        • OptionalbudgetGrossMargin?: number | null

          Format: double

        • OptionalbudgetRevenue?: number | null

          Format: double

        • OptionalbudgetROI?: number | null

          Format: double

        • OptionaldefaultGroup?: { _info?: { [key: string]: string }; id?: number | null; name?: string }
          • Optional_info?: { [key: string]: string }
          • Optionalid?: number | null

            Format: int32

          • Optionalname?: string
        • OptionalemailsSent?: number | null

          Format: int32

        • OptionalendDate?: string

          Format: date-time

        • Optionalid?: number

          Format: int32

        • Optionalimpressions?: number | null

          Format: int32

        • Optionalinactive?: boolean | null
        • OptionalinactiveDaysAfterEnd?: number | null

          Format: int32

        • OptionallocationId?: number | null

          Format: int32

        • OptionalmarketingManagerDefaultTrackId?: number | null

          Format: int32

        • Optionalmember?: {
              _info?: { [key: string]: string };
              dailyCapacity?: number | null;
              id?: number | null;
              identifier?: string;
              name?: string;
          }
          • Optional_info?: { [key: string]: string }
          • OptionaldailyCapacity?: number | null

            Format: double

          • Optionalid?: number | null

            Format: int32

          • Optionalidentifier?: string
          • Optionalname?: string
        • name: string

          Max length: 50;

        • Optionalnotes?: string
        • OptionalopportunityDefaultTrackId?: number | null

          Format: int32

        • startDate: string

          Format: date-time

        • Optionalstatus?: { _info?: { [key: string]: string }; id?: number | null; name?: string }
          • Optional_info?: { [key: string]: string }
          • Optionalid?: number | null

            Format: int32

          • Optionalname?: string
        • subType: { _info?: { [key: string]: string }; id?: number | null; name?: string }
          • Optional_info?: { [key: string]: string }
          • Optionalid?: number | null

            Format: int32

          • Optionalname?: string
        • type: { _info?: { [key: string]: string }; id?: number | null; name?: string }
          • Optional_info?: { [key: string]: string }
          • Optionalid?: number | null

            Format: int32

          • Optionalname?: string

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

    • Parameters

      • parentId: number
      • campaignAudit: {
            campaignId?: number | null;
            createdBy?: string;
            dateCreated?: string;
            documentsCreated?: number | null;
            emailsSent: number | null;
            emailSubject?: string;
            emailsUnsent?: number | null;
            group?: {
                _info?: { [key: string]: string };
                id?: number | null;
                name?: string;
            };
            id?: number;
        }
        • OptionalcampaignId?: number | null

          Format: int32

        • OptionalcreatedBy?: string
        • OptionaldateCreated?: string
        • OptionaldocumentsCreated?: number | null

          Format: int32

        • emailsSent: number | null

          Format: int32

        • OptionalemailSubject?: string

          Max length: 1000;

        • OptionalemailsUnsent?: number | null

          Format: int32

        • Optionalgroup?: { _info?: { [key: string]: string }; id?: number | null; name?: string }
          • Optional_info?: { [key: string]: string }
          • Optionalid?: number | null

            Format: int32

          • Optionalname?: string
        • Optionalid?: number

          Format: int32

      Returns Promise<
          {
              campaignId?: number
              | null;
              createdBy?: string;
              dateCreated?: string;
              documentsCreated?: number | null;
              emailsSent: number | null;
              emailSubject?: string;
              emailsUnsent?: number | null;
              group?: {
                  _info?: { [key: string]: string };
                  id?: number | null;
                  name?: string;
              };
              id?: number;
          },
      >

    • Parameters

      • parentId: number
      • emailOpened: {
            campaignId?: number | null;
            contactId: number | null;
            dateOpened?: string;
            id?: number;
        }
        • OptionalcampaignId?: number | null

          Format: int32

        • contactId: number | null

          Format: int32

        • OptionaldateOpened?: string

          Format: date-time

        • Optionalid?: number

          Format: int32

      Returns Promise<
          {
              campaignId?: number
              | null;
              contactId: number | null;
              dateOpened?: string;
              id?: number;
          },
      >

    • Parameters

      • parentId: number
      • formSubmitted: {
            campaignId?: number | null;
            contactId: number | null;
            dateSubmitted?: string;
            id?: number;
            pageSubType?: string;
            pageType?: string;
            queryString?: string;
            status?: string;
            topic?: string;
            url: string;
            version?: string;
        }
        • OptionalcampaignId?: number | null

          Format: int32

        • contactId: number | null

          Format: int32

        • OptionaldateSubmitted?: string

          Format: date-time

        • Optionalid?: number

          Format: int32

        • OptionalpageSubType?: string
        • OptionalpageType?: string
        • OptionalqueryString?: string
        • Optionalstatus?: string
        • Optionaltopic?: string
        • url: string

          Max length: 2083;

        • Optionalversion?: string

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

    • Parameters

      • parentId: number
      • linkClicked: {
            campaignId?: number | null;
            contactId: number | null;
            dateClicked?: string;
            id?: number;
            queryString?: string;
            url: string;
        }
        • OptionalcampaignId?: number | null

          Format: int32

        • contactId: number | null

          Format: int32

        • OptionaldateClicked?: string

          Format: date-time

        • Optionalid?: number

          Format: int32

        • OptionalqueryString?: string
        • url: string

          Max length: 2083;

      Returns Promise<
          {
              campaignId?: number
              | null;
              contactId: number | null;
              dateClicked?: string;
              id?: number;
              queryString?: string;
              url: string;
          },
      >

    • Parameters

      • campaignStatus: {
            _info?: { [key: string]: string };
            connectWiseId?: string;
            defaultFlag?: boolean | null;
            id?: number;
            inactiveFlag?: boolean | null;
            name: string;
        }
        • Optional_info?: { [key: string]: string }
        • OptionalconnectWiseId?: string
        • OptionaldefaultFlag?: boolean | null
        • Optionalid?: number

          Format: int32

        • OptionalinactiveFlag?: boolean | null
        • name: string

          Max length: 100;

      Returns Promise<
          {
              _info?: { [key: string]: string };
              connectWiseId?: string;
              defaultFlag?: boolean | null;
              id?: number;
              inactiveFlag?: boolean | null;
              name: string;
          },
      >

    • Parameters

      • campaignSubType: {
            _info?: { [key: string]: string };
            id?: number;
            name: string;
            type: {
                _info?: { [key: string]: string };
                id?: number | null;
                name?: string;
            };
        }
        • Optional_info?: { [key: string]: string }
        • Optionalid?: number

          Format: int32

        • name: string

          Max length: 100;

        • type: { _info?: { [key: string]: string }; id?: number | null; name?: string }
          • Optional_info?: { [key: string]: string }
          • Optionalid?: number | null

            Format: int32

          • Optionalname?: string

      Returns Promise<
          {
              _info?: { [key: string]: string };
              id?: number;
              name: string;
              type: {
                  _info?: { [key: string]: string };
                  id?: number | null;
                  name?: string;
              };
          },
      >

    • Parameters

      • campaignType: {
            _info?: { [key: string]: string };
            connectWiseId?: string;
            defaultFlag?: boolean | null;
            id?: number;
            name: string;
        }
        • Optional_info?: { [key: string]: string }
        • OptionalconnectWiseId?: string
        • OptionaldefaultFlag?: boolean | null
        • Optionalid?: number

          Format: int32

        • name: string

          Max length: 100;

      Returns Promise<
          {
              _info?: { [key: string]: string };
              connectWiseId?: string;
              defaultFlag?: boolean | null;
              id?: number;
              name: string;
          },
      >

    • Parameters

      • group: {
            _info?: { [key: string]: string };
            connectWiseId?: string;
            id?: number;
            inactiveFlag?: boolean | null;
            name: string;
            publicDescription?: string;
            publicFlag?: boolean | null;
        }
        • Optional_info?: { [key: string]: string }
        • OptionalconnectWiseId?: string
        • Optionalid?: number

          Format: int32

        • OptionalinactiveFlag?: boolean | null
        • name: string
        • OptionalpublicDescription?: string

          Max length: 255;

        • OptionalpublicFlag?: boolean | null

      Returns Promise<
          {
              _info?: { [key: string]: string };
              connectWiseId?: string;
              id?: number;
              inactiveFlag?: boolean | null;
              name: string;
              publicDescription?: string;
              publicFlag?: boolean | null;
          },
      >

    • Parameters

      • parentId: number
      • marketingCompany: {
            _info?: { [key: string]: string };
            allContactsFlag?: boolean | null;
            defaultContactFlag?: boolean | null;
            groupId?: number | null;
            id?: number;
            unsubscribeFlag?: boolean | null;
        }
        • Optional_info?: { [key: string]: string }
        • OptionalallContactsFlag?: boolean | null
        • OptionaldefaultContactFlag?: boolean | null
        • OptionalgroupId?: number | null

          Format: int32

        • Optionalid?: number

          Format: int32

        • OptionalunsubscribeFlag?: boolean | null

      Returns Promise<
          {
              _info?: { [key: string]: string };
              allContactsFlag?: boolean | null;
              defaultContactFlag?: boolean | null;
              groupId?: number | null;
              id?: number;
              unsubscribeFlag?: boolean | null;
          },
      >

    • Parameters

      • parentId: number
      • marketingContact: {
            _info?: { [key: string]: string };
            groupId?: number | null;
            id?: number;
            note?: string;
            unsubscribeFlag?: boolean | null;
        }
        • Optional_info?: { [key: string]: string }
        • OptionalgroupId?: number | null

          Format: int32

        • Optionalid?: number

          Format: int32

        • Optionalnote?: string

          Max length: 50;

        • OptionalunsubscribeFlag?: boolean | null

      Returns Promise<
          {
              _info?: { [key: string]: string };
              groupId?: number | null;
              id?: number;
              note?: string;
              unsubscribeFlag?: boolean | null;
          },
      >

    • Parameters

      • id: number
      • campaign: {
            _info?: { [key: string]: string };
            actualCost?: number | null;
            actualGrossMargin?: number | null;
            actualRevenue?: number | null;
            actualROI?: number | null;
            budgetCost?: number | null;
            budgetGrossMargin?: number | null;
            budgetRevenue?: number | null;
            budgetROI?: number | null;
            defaultGroup?: {
                _info?: { [key: string]: string };
                id?: number | null;
                name?: string;
            };
            emailsSent?: number
            | null;
            endDate?: string;
            id?: number;
            impressions?: number | null;
            inactive?: boolean | null;
            inactiveDaysAfterEnd?: number | null;
            locationId?: number | null;
            marketingManagerDefaultTrackId?: number | null;
            member?: {
                _info?: { [key: string]: string };
                dailyCapacity?: number | null;
                id?: number | null;
                identifier?: string;
                name?: string;
            };
            name: string;
            notes?: string;
            opportunityDefaultTrackId?: number
            | null;
            startDate: string;
            status?: {
                _info?: { [key: string]: string };
                id?: number | null;
                name?: string;
            };
            subType: {
                _info?: { [key: string]: string };
                id?: number | null;
                name?: string;
            };
            type: {
                _info?: { [key: string]: string };
                id?: number | null;
                name?: string;
            };
        }
        • Optional_info?: { [key: string]: string }
        • OptionalactualCost?: number | null

          Format: double

        • OptionalactualGrossMargin?: number | null

          Format: double

        • OptionalactualRevenue?: number | null

          Format: double

        • OptionalactualROI?: number | null

          Format: double

        • OptionalbudgetCost?: number | null

          Format: double

        • OptionalbudgetGrossMargin?: number | null

          Format: double

        • OptionalbudgetRevenue?: number | null

          Format: double

        • OptionalbudgetROI?: number | null

          Format: double

        • OptionaldefaultGroup?: { _info?: { [key: string]: string }; id?: number | null; name?: string }
          • Optional_info?: { [key: string]: string }
          • Optionalid?: number | null

            Format: int32

          • Optionalname?: string
        • OptionalemailsSent?: number | null

          Format: int32

        • OptionalendDate?: string

          Format: date-time

        • Optionalid?: number

          Format: int32

        • Optionalimpressions?: number | null

          Format: int32

        • Optionalinactive?: boolean | null
        • OptionalinactiveDaysAfterEnd?: number | null

          Format: int32

        • OptionallocationId?: number | null

          Format: int32

        • OptionalmarketingManagerDefaultTrackId?: number | null

          Format: int32

        • Optionalmember?: {
              _info?: { [key: string]: string };
              dailyCapacity?: number | null;
              id?: number | null;
              identifier?: string;
              name?: string;
          }
          • Optional_info?: { [key: string]: string }
          • OptionaldailyCapacity?: number | null

            Format: double

          • Optionalid?: number | null

            Format: int32

          • Optionalidentifier?: string
          • Optionalname?: string
        • name: string

          Max length: 50;

        • Optionalnotes?: string
        • OptionalopportunityDefaultTrackId?: number | null

          Format: int32

        • startDate: string

          Format: date-time

        • Optionalstatus?: { _info?: { [key: string]: string }; id?: number | null; name?: string }
          • Optional_info?: { [key: string]: string }
          • Optionalid?: number | null

            Format: int32

          • Optionalname?: string
        • subType: { _info?: { [key: string]: string }; id?: number | null; name?: string }
          • Optional_info?: { [key: string]: string }
          • Optionalid?: number | null

            Format: int32

          • Optionalname?: string
        • type: { _info?: { [key: string]: string }; id?: number | null; name?: string }
          • Optional_info?: { [key: string]: string }
          • Optionalid?: number | null

            Format: int32

          • Optionalname?: string

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

    • Parameters

      • id: number
      • parentId: number
      • campaignAudit: {
            campaignId?: number | null;
            createdBy?: string;
            dateCreated?: string;
            documentsCreated?: number | null;
            emailsSent: number | null;
            emailSubject?: string;
            emailsUnsent?: number | null;
            group?: {
                _info?: { [key: string]: string };
                id?: number | null;
                name?: string;
            };
            id?: number;
        }
        • OptionalcampaignId?: number | null

          Format: int32

        • OptionalcreatedBy?: string
        • OptionaldateCreated?: string
        • OptionaldocumentsCreated?: number | null

          Format: int32

        • emailsSent: number | null

          Format: int32

        • OptionalemailSubject?: string

          Max length: 1000;

        • OptionalemailsUnsent?: number | null

          Format: int32

        • Optionalgroup?: { _info?: { [key: string]: string }; id?: number | null; name?: string }
          • Optional_info?: { [key: string]: string }
          • Optionalid?: number | null

            Format: int32

          • Optionalname?: string
        • Optionalid?: number

          Format: int32

      Returns Promise<
          {
              campaignId?: number
              | null;
              createdBy?: string;
              dateCreated?: string;
              documentsCreated?: number | null;
              emailsSent: number | null;
              emailSubject?: string;
              emailsUnsent?: number | null;
              group?: {
                  _info?: { [key: string]: string };
                  id?: number | null;
                  name?: string;
              };
              id?: number;
          },
      >

    • Parameters

      • id: number
      • parentId: number
      • emailOpened: {
            campaignId?: number | null;
            contactId: number | null;
            dateOpened?: string;
            id?: number;
        }
        • OptionalcampaignId?: number | null

          Format: int32

        • contactId: number | null

          Format: int32

        • OptionaldateOpened?: string

          Format: date-time

        • Optionalid?: number

          Format: int32

      Returns Promise<
          {
              campaignId?: number
              | null;
              contactId: number | null;
              dateOpened?: string;
              id?: number;
          },
      >

    • Parameters

      • id: number
      • parentId: number
      • formSubmitted: {
            campaignId?: number | null;
            contactId: number | null;
            dateSubmitted?: string;
            id?: number;
            pageSubType?: string;
            pageType?: string;
            queryString?: string;
            status?: string;
            topic?: string;
            url: string;
            version?: string;
        }
        • OptionalcampaignId?: number | null

          Format: int32

        • contactId: number | null

          Format: int32

        • OptionaldateSubmitted?: string

          Format: date-time

        • Optionalid?: number

          Format: int32

        • OptionalpageSubType?: string
        • OptionalpageType?: string
        • OptionalqueryString?: string
        • Optionalstatus?: string
        • Optionaltopic?: string
        • url: string

          Max length: 2083;

        • Optionalversion?: string

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

    • Parameters

      • id: number
      • parentId: number
      • linkClicked: {
            campaignId?: number | null;
            contactId: number | null;
            dateClicked?: string;
            id?: number;
            queryString?: string;
            url: string;
        }
        • OptionalcampaignId?: number | null

          Format: int32

        • contactId: number | null

          Format: int32

        • OptionaldateClicked?: string

          Format: date-time

        • Optionalid?: number

          Format: int32

        • OptionalqueryString?: string
        • url: string

          Max length: 2083;

      Returns Promise<
          {
              campaignId?: number
              | null;
              contactId: number | null;
              dateClicked?: string;
              id?: number;
              queryString?: string;
              url: string;
          },
      >

    • Parameters

      • id: number
      • campaignStatus: {
            _info?: { [key: string]: string };
            connectWiseId?: string;
            defaultFlag?: boolean | null;
            id?: number;
            inactiveFlag?: boolean | null;
            name: string;
        }
        • Optional_info?: { [key: string]: string }
        • OptionalconnectWiseId?: string
        • OptionaldefaultFlag?: boolean | null
        • Optionalid?: number

          Format: int32

        • OptionalinactiveFlag?: boolean | null
        • name: string

          Max length: 100;

      Returns Promise<
          {
              _info?: { [key: string]: string };
              connectWiseId?: string;
              defaultFlag?: boolean | null;
              id?: number;
              inactiveFlag?: boolean | null;
              name: string;
          },
      >

    • Parameters

      • id: number
      • campaignSubType: {
            _info?: { [key: string]: string };
            id?: number;
            name: string;
            type: {
                _info?: { [key: string]: string };
                id?: number | null;
                name?: string;
            };
        }
        • Optional_info?: { [key: string]: string }
        • Optionalid?: number

          Format: int32

        • name: string

          Max length: 100;

        • type: { _info?: { [key: string]: string }; id?: number | null; name?: string }
          • Optional_info?: { [key: string]: string }
          • Optionalid?: number | null

            Format: int32

          • Optionalname?: string

      Returns Promise<
          {
              _info?: { [key: string]: string };
              id?: number;
              name: string;
              type: {
                  _info?: { [key: string]: string };
                  id?: number | null;
                  name?: string;
              };
          },
      >

    • Parameters

      • id: number
      • campaignType: {
            _info?: { [key: string]: string };
            connectWiseId?: string;
            defaultFlag?: boolean | null;
            id?: number;
            name: string;
        }
        • Optional_info?: { [key: string]: string }
        • OptionalconnectWiseId?: string
        • OptionaldefaultFlag?: boolean | null
        • Optionalid?: number

          Format: int32

        • name: string

          Max length: 100;

      Returns Promise<
          {
              _info?: { [key: string]: string };
              connectWiseId?: string;
              defaultFlag?: boolean | null;
              id?: number;
              name: string;
          },
      >

    • Parameters

      • id: number
      • group: {
            _info?: { [key: string]: string };
            connectWiseId?: string;
            id?: number;
            inactiveFlag?: boolean | null;
            name: string;
            publicDescription?: string;
            publicFlag?: boolean | null;
        }
        • Optional_info?: { [key: string]: string }
        • OptionalconnectWiseId?: string
        • Optionalid?: number

          Format: int32

        • OptionalinactiveFlag?: boolean | null
        • name: string
        • OptionalpublicDescription?: string

          Max length: 255;

        • OptionalpublicFlag?: boolean | null

      Returns Promise<
          {
              _info?: { [key: string]: string };
              connectWiseId?: string;
              id?: number;
              inactiveFlag?: boolean | null;
              name: string;
              publicDescription?: string;
              publicFlag?: boolean | null;
          },
      >

    • Parameters

      • id: number
      • parentId: number
      • marketingCompany: {
            _info?: { [key: string]: string };
            allContactsFlag?: boolean | null;
            defaultContactFlag?: boolean | null;
            groupId?: number | null;
            id?: number;
            unsubscribeFlag?: boolean | null;
        }
        • Optional_info?: { [key: string]: string }
        • OptionalallContactsFlag?: boolean | null
        • OptionaldefaultContactFlag?: boolean | null
        • OptionalgroupId?: number | null

          Format: int32

        • Optionalid?: number

          Format: int32

        • OptionalunsubscribeFlag?: boolean | null

      Returns Promise<
          {
              _info?: { [key: string]: string };
              allContactsFlag?: boolean | null;
              defaultContactFlag?: boolean | null;
              groupId?: number | null;
              id?: number;
              unsubscribeFlag?: boolean | null;
          },
      >

    • Parameters

      • id: number
      • parentId: number
      • marketingContact: {
            _info?: { [key: string]: string };
            groupId?: number | null;
            id?: number;
            note?: string;
            unsubscribeFlag?: boolean | null;
        }
        • Optional_info?: { [key: string]: string }
        • OptionalgroupId?: number | null

          Format: int32

        • Optionalid?: number

          Format: int32

        • Optionalnote?: string

          Max length: 50;

        • OptionalunsubscribeFlag?: boolean | null

      Returns Promise<
          {
              _info?: { [key: string]: string };
              groupId?: number | null;
              id?: number;
              note?: string;
              unsubscribeFlag?: boolean | null;
          },
      >

    Settings

    Member Visibility

    On This Page

    Methods
    deleteMarketingCampaignsByIddeleteMarketingCampaignsByParentIdAuditsByIddeleteMarketingCampaignsByParentIdEmailsOpenedByIddeleteMarketingCampaignsByParentIdFormsSubmittedByIddeleteMarketingCampaignsByParentIdLinksClickedByIddeleteMarketingCampaignsStatusesByIddeleteMarketingCampaignsSubTypesByIddeleteMarketingCampaignsTypesByIddeleteMarketingGroupsByIddeleteMarketingGroupsByParentIdCompaniesByIddeleteMarketingGroupsByParentIdContactsByIdgetMarketingCampaignsgetMarketingCampaignsByIdgetMarketingCampaignsByIdActivitiesgetMarketingCampaignsByIdActivitiesCountgetMarketingCampaignsByIdOpportunitiesgetMarketingCampaignsByIdOpportunitiesCountgetMarketingCampaignsByParentIdAuditsgetMarketingCampaignsByParentIdAuditsByIdgetMarketingCampaignsByParentIdAuditsCountgetMarketingCampaignsByParentIdEmailsOpenedgetMarketingCampaignsByParentIdEmailsOpenedByIdgetMarketingCampaignsByParentIdEmailsOpenedCountgetMarketingCampaignsByParentIdFormsSubmittedgetMarketingCampaignsByParentIdFormsSubmittedByIdgetMarketingCampaignsByParentIdFormsSubmittedCountgetMarketingCampaignsByParentIdLinksClickedgetMarketingCampaignsByParentIdLinksClickedByIdgetMarketingCampaignsByParentIdLinksClickedCountgetMarketingCampaignsCountgetMarketingCampaignsStatusesgetMarketingCampaignsStatusesByIdgetMarketingCampaignsStatusesCountgetMarketingCampaignsSubTypesgetMarketingCampaignsSubTypesByIdgetMarketingCampaignsSubTypesCountgetMarketingCampaignsTypesgetMarketingCampaignsTypesByIdgetMarketingCampaignsTypesByIdInfogetMarketingCampaignsTypesByParentIdSubTypesgetMarketingCampaignsTypesByParentIdSubTypesByIdgetMarketingCampaignsTypesByParentIdSubTypesCountgetMarketingCampaignsTypesCountgetMarketingCampaignsTypesInfogetMarketingCampaignsTypesInfoCountgetMarketingGroupsgetMarketingGroupsByIdgetMarketingGroupsByIdInfogetMarketingGroupsByIdUsagesgetMarketingGroupsByIdUsagesListgetMarketingGroupsByParentIdCompaniesgetMarketingGroupsByParentIdCompaniesByIdgetMarketingGroupsByParentIdCompaniesCountgetMarketingGroupsByParentIdContactsgetMarketingGroupsByParentIdContactsByIdgetMarketingGroupsByParentIdContactsCountgetMarketingGroupsCountgetMarketingGroupsInfogetMarketingGroupsInfoCountpatchMarketingCampaignsByIdpatchMarketingCampaignsByParentIdAuditsByIdpatchMarketingCampaignsByParentIdEmailsOpenedByIdpatchMarketingCampaignsByParentIdFormsSubmittedByIdpatchMarketingCampaignsByParentIdLinksClickedByIdpatchMarketingCampaignsStatusesByIdpatchMarketingCampaignsSubTypesByIdpatchMarketingCampaignsTypesByIdpatchMarketingGroupsByIdpatchMarketingGroupsByParentIdCompaniesByIdpatchMarketingGroupsByParentIdContactsByIdpostMarketingCampaignspostMarketingCampaignsByParentIdAuditspostMarketingCampaignsByParentIdEmailsOpenedpostMarketingCampaignsByParentIdFormsSubmittedpostMarketingCampaignsByParentIdLinksClickedpostMarketingCampaignsStatusespostMarketingCampaignsSubTypespostMarketingCampaignsTypespostMarketingGroupspostMarketingGroupsByParentIdCompaniespostMarketingGroupsByParentIdContactsputMarketingCampaignsByIdputMarketingCampaignsByParentIdAuditsByIdputMarketingCampaignsByParentIdEmailsOpenedByIdputMarketingCampaignsByParentIdFormsSubmittedByIdputMarketingCampaignsByParentIdLinksClickedByIdputMarketingCampaignsStatusesByIdputMarketingCampaignsSubTypesByIdputMarketingCampaignsTypesByIdputMarketingGroupsByIdputMarketingGroupsByParentIdCompaniesByIdputMarketingGroupsByParentIdContactsByIdrequest