Class default

Constructors

constructor

Methods

addContact addNote approveContact assignOwner bulkApprove createCampaign createEmailProviderAddress createFestivalSubmissionSource createLead deactivateEmailProviderAddress deleteCampaign deleteContact deleteFestivalSubmissionSource deleteLead enrichLead festivalSubmissionFormData getCampaignDeliveryStatus getCampaignFilterOptions getCampaignMergeFields getCampaignStats getEmailProviderAddressOptions getFunnelStats getInterestStats getPerformanceStats importCampaignProspects importFestivalSubmissions listCampaignRecipients listCampaigns listEmailProviderAddresses listFestivalSubmissionSources listLeads markAsLost previewCampaignAudience previewCampaignProspectImport previewFestivalSubmissionImport recordStaffReply renderCampaignTemplatePreview sendCampaign sendCampaignTestEmail triggerSourcing triggerSync updateCampaign updateContact updateEmailProviderAddress updateFestivalSubmissionSource updateLead updateStatus viewCampaign viewLead

Constructors

constructor

Methods

Static addContact

  • addContact<T>(lead_id, data): AxiosPromise<default<T>>

  • Manually add a contact person to a lead.

    Type Parameters

    • T

    Parameters

    • lead_id: string
    • data: object

    Returns AxiosPromise<default<T>>

Static addNote

  • addNote<T>(lead_id, content): AxiosPromise<default<T>>

  • Add a manual note to the lead's activity timeline.

    Type Parameters

    • T

    Parameters

    • lead_id: string
    • content: string

    Returns AxiosPromise<default<T>>

Static approveContact

  • approveContact<T>(contact_id): AxiosPromise<default<T>>

  • Approve a specific contact to start the Apollo email sequence.

    Type Parameters

    • T

    Parameters

    • contact_id: string

    Returns AxiosPromise<default<T>>

Static assignOwner

  • assignOwner<T>(lead_id, user_id): AxiosPromise<default<T>>

  • Assign a Super Admin as the owner of a lead.

    Type Parameters

    • T

    Parameters

    • lead_id: string
    • user_id: string

    Returns AxiosPromise<default<T>>

Static bulkApprove

  • bulkApprove<T>(contact_ids): AxiosPromise<default<T>>

  • Approve a batch of contacts for outreach.

    Type Parameters

    • T

    Parameters

    • contact_ids: string[]

    Returns AxiosPromise<default<T>>

Static createCampaign

  • createCampaign<T>(data): AxiosPromise<default<T>>

  • Create a CRM campaign draft with filters, exclusions, and optional variants.

    Type Parameters

    • T

    Parameters

    • data: object

    Returns AxiosPromise<default<T>>

Static createEmailProviderAddress

  • createEmailProviderAddress<T>(data): AxiosPromise<default<T>>

  • Add a provider-managed sender or reply-to address.

    Type Parameters

    • T

    Parameters

    • data: object

    Returns AxiosPromise<default<T>>

Static createFestivalSubmissionSource

  • createFestivalSubmissionSource<T>(data): AxiosPromise<default<T>>

  • Save a recurring Google Sheet source for festival submission imports.

    Type Parameters

    • T

    Parameters

    • data: object

    Returns AxiosPromise<default<T>>

Static createLead

  • createLead<T>(data): AxiosPromise<default<T>>

  • Manually create a new lead.

    Type Parameters

    • T

    Parameters

    • data: object

    Returns AxiosPromise<default<T>>

Static deactivateEmailProviderAddress

  • deactivateEmailProviderAddress<T>(address_id): AxiosPromise<default<T>>

  • Deactivate a provider address while keeping the audit record.

    Type Parameters

    • T

    Parameters

    • address_id: string

    Returns AxiosPromise<default<T>>

Static deleteCampaign

  • deleteCampaign<T>(campaign_id): AxiosPromise<default<T>>

  • Delete an unsent CRM campaign draft.

    Type Parameters

    • T

    Parameters

    • campaign_id: string

    Returns AxiosPromise<default<T>>

Static deleteContact

  • deleteContact<T>(contact_id): AxiosPromise<default<T>>

  • Remove a contact from a lead.

    Type Parameters

    • T

    Parameters

    • contact_id: string

    Returns AxiosPromise<default<T>>

Static deleteFestivalSubmissionSource

  • deleteFestivalSubmissionSource<T>(source_id): AxiosPromise<default<T>>

  • Delete a recurring Google Sheet source for festival submission imports.

    Type Parameters

    • T

    Parameters

    • source_id: string

    Returns AxiosPromise<default<T>>

Static deleteLead

  • deleteLead<T>(lead_id): AxiosPromise<default<T>>

  • Delete a lead (Soft Delete).

    Type Parameters

    • T

    Parameters

    • lead_id: string

    Returns AxiosPromise<default<T>>

Static enrichLead

  • enrichLead<T>(lead_id): AxiosPromise<default<T>>

  • Manually trigger Apollo enrichment and website scraping for a lead.

    Type Parameters

    • T

    Parameters

    • lead_id: string

    Returns AxiosPromise<default<T>>

Static Private festivalSubmissionFormData

  • festivalSubmissionFormData(files, options): FormData

  • Parameters

    • files: (Blob | File)[]
    • options: Record<string, any>

    Returns FormData

Static getCampaignDeliveryStatus

  • getCampaignDeliveryStatus<T>(): AxiosPromise<default<T>>

  • Read CRM campaign queue depth and Azure/system email rate-limit windows.

    Type Parameters

    • T

    Returns AxiosPromise<default<T>>

Static getCampaignFilterOptions

  • getCampaignFilterOptions<T>(): AxiosPromise<default<T>>

  • List human-readable filter options for the CRM campaign composer.

    Type Parameters

    • T

    Returns AxiosPromise<default<T>>

Static getCampaignMergeFields

  • getCampaignMergeFields<T>(): AxiosPromise<default<T>>

  • List the backend-supported CRM campaign merge fields for the composer.

    Type Parameters

    • T

    Returns AxiosPromise<default<T>>

Static getCampaignStats

  • getCampaignStats<T>(campaign_id): AxiosPromise<default<T>>

  • Refresh and read CRM campaign engagement, reply, and conversion stats.

    Type Parameters

    • T

    Parameters

    • campaign_id: string

    Returns AxiosPromise<default<T>>

Static getEmailProviderAddressOptions

  • getEmailProviderAddressOptions<T>(): AxiosPromise<default<T>>

  • List sender/reply-to dropdown options and defaults for the campaign composer.

    Type Parameters

    • T

    Returns AxiosPromise<default<T>>

Static getFunnelStats

  • getFunnelStats<T>(): AxiosPromise<default<T>>

  • Get funnel conversion percentages.

    Type Parameters

    • T

    Returns AxiosPromise<default<T>>

Static getInterestStats

  • getInterestStats<T>(): AxiosPromise<default<T>>

  • Get the analytics on what users indcated they were interested in.

    Type Parameters

    • T

    Returns AxiosPromise<default<T>>

Static getPerformanceStats

  • getPerformanceStats<T>(): AxiosPromise<default<T>>

  • Get win rates and response time analytics.

    Type Parameters

    • T

    Returns AxiosPromise<default<T>>

Static importCampaignProspects

  • importCampaignProspects<T>(prospects, options?): AxiosPromise<default<T>>

  • Import external prospects into CRM leads and contacts for future campaigns.

    Type Parameters

    • T

    Parameters

    • prospects: object[]
    • options: Record<string, any> = {}

    Returns AxiosPromise<default<T>>

Static importFestivalSubmissions

  • importFestivalSubmissions<T>(files, options?, onUploadProgress?): AxiosPromise<default<T>>

  • Import uploaded festival submission sheets into External Games and CRM leads/contacts.

    Type Parameters

    • T

    Parameters

    • files: (Blob | File)[]
    • options: Record<string, any> = {}
    • Optional onUploadProgress: ((progressEvent) => void)
        • (progressEvent): void

        • Parameters

          • progressEvent: AxiosProgressEvent

          Returns void

    Returns AxiosPromise<default<T>>

Static listCampaignRecipients

  • listCampaignRecipients<T>(campaign_id, params?): AxiosPromise<default<T>>

  • List campaign recipient audit rows with optional status or variant filters.

    Type Parameters

    • T

    Parameters

    • campaign_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

Static listCampaigns

  • listCampaigns<T>(params?): AxiosPromise<default<T>>

  • List CRM newsletter and mass-email campaigns.

    Type Parameters

    • T

    Parameters

    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

Static listEmailProviderAddresses

  • listEmailProviderAddresses<T>(params?): AxiosPromise<default<T>>

  • List provider-managed sender and reply-to addresses for CRM campaigns.

    Type Parameters

    • T

    Parameters

    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

Static listFestivalSubmissionSources

  • listFestivalSubmissionSources<T>(): AxiosPromise<default<T>>

  • List saved recurring Google Sheet sources for festival submission imports.

    Type Parameters

    • T

    Returns AxiosPromise<default<T>>

Static listLeads

  • listLeads<T>(params?): AxiosPromise<default<T>>

  • List and search CRM leads.

    Type Parameters

    • T

    Parameters

    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

Static markAsLost

  • markAsLost<T>(lead_id, reason): AxiosPromise<default<T>>

  • Mark a lead as lost and record the reason.

    Type Parameters

    • T

    Parameters

    • lead_id: string
    • reason: string

    Returns AxiosPromise<default<T>>

Static previewCampaignAudience

  • previewCampaignAudience<T>(data): AxiosPromise<default<T>>

  • Preview campaign audience filters and exclusions without creating recipients.

    Type Parameters

    • T

    Parameters

    • data: object

    Returns AxiosPromise<default<T>>

Static previewCampaignProspectImport

  • previewCampaignProspectImport<T>(prospects, options?): AxiosPromise<default<T>>

  • Validate external prospect rows and preview field mapping/dedupe outcomes.

    Type Parameters

    • T

    Parameters

    • prospects: object[]
    • options: Record<string, any> = {}

    Returns AxiosPromise<default<T>>

Static previewFestivalSubmissionImport

  • previewFestivalSubmissionImport<T>(files, options?, onUploadProgress?): AxiosPromise<default<T>>

  • Preview uploaded festival submission sheets without writing External Game or CRM records.

    Type Parameters

    • T

    Parameters

    • files: (Blob | File)[]
    • options: Record<string, any> = {}
    • Optional onUploadProgress: ((progressEvent) => void)
        • (progressEvent): void

        • Parameters

          • progressEvent: AxiosProgressEvent

          Returns void

    Returns AxiosPromise<default<T>>

Static recordStaffReply

  • recordStaffReply<T>(lead_id): AxiosPromise<default<T>>

  • Record that a staff member has manually replied to a prospect.

    Type Parameters

    • T

    Parameters

    • lead_id: string

    Returns AxiosPromise<default<T>>

Static renderCampaignTemplatePreview

  • renderCampaignTemplatePreview<T>(data): AxiosPromise<default<T>>

  • Render CRM campaign content with the same merge-field engine used at send time.

    Type Parameters

    • T

    Parameters

    • data: object

    Returns AxiosPromise<default<T>>

Static sendCampaign

  • sendCampaign<T>(campaign_id, data?): AxiosPromise<default<T>>

  • Materialize and queue a CRM campaign, optionally with a limit or dispatch=false.

    Type Parameters

    • T

    Parameters

    • campaign_id: string
    • data: object = {}

    Returns AxiosPromise<default<T>>

Static sendCampaignTestEmail

  • sendCampaignTestEmail<T>(data): AxiosPromise<default<T>>

  • Send a non-tracked CRM campaign test email with rendered merge fields.

    Type Parameters

    • T

    Parameters

    • data: object

    Returns AxiosPromise<default<T>>

Static triggerSourcing

  • triggerSourcing<T>(): AxiosPromise<default<T>>

  • Manually trigger the bi-weekly sourcing automation.

    Type Parameters

    • T

    Returns AxiosPromise<default<T>>

Static triggerSync

  • triggerSync<T>(): AxiosPromise<default<T>>

  • Manually trigger the Apollo status and conversion sync.

    Type Parameters

    • T

    Returns AxiosPromise<default<T>>

Static updateCampaign

  • updateCampaign<T>(campaign_id, data): AxiosPromise<default<T>>

  • Update an editable CRM campaign draft or paused campaign.

    Type Parameters

    • T

    Parameters

    • campaign_id: string
    • data: object

    Returns AxiosPromise<default<T>>

Static updateContact

  • updateContact<T>(contact_id, data): AxiosPromise<default<T>>

  • Update an existing contact's information.

    Type Parameters

    • T

    Parameters

    • contact_id: string
    • data: object

    Returns AxiosPromise<default<T>>

Static updateEmailProviderAddress

  • updateEmailProviderAddress<T>(address_id, data): AxiosPromise<default<T>>

  • Update provider verification, sendability, capabilities, defaults, or notes.

    Type Parameters

    • T

    Parameters

    • address_id: string
    • data: object

    Returns AxiosPromise<default<T>>

Static updateFestivalSubmissionSource

  • updateFestivalSubmissionSource<T>(source_id, data): AxiosPromise<default<T>>

  • Update a recurring Google Sheet source for festival submission imports.

    Type Parameters

    • T

    Parameters

    • source_id: string
    • data: object

    Returns AxiosPromise<default<T>>

Static updateLead

  • updateLead<T>(lead_id, data): AxiosPromise<default<T>>

  • Update lead information.

    Type Parameters

    • T

    Parameters

    • lead_id: string
    • data: object

    Returns AxiosPromise<default<T>>

Static updateStatus

  • updateStatus<T>(lead_id, status, note?): AxiosPromise<default<T>>

  • Manually update the pipeline status of a lead.

    Type Parameters

    • T

    Parameters

    • lead_id: string
    • status: string
    • Optional note: string

    Returns AxiosPromise<default<T>>

Static viewCampaign

  • viewCampaign<T>(campaign_id, params?): AxiosPromise<default<T>>

  • View a CRM campaign. Pass include_recipients in params for a small recipient sample.

    Type Parameters

    • T

    Parameters

    • campaign_id: string
    • Optional params: Record<string, any>

    Returns AxiosPromise<default<T>>

Static viewLead

  • viewLead<T>(lead_id): AxiosPromise<default<T>>

  • View a single lead with contacts and activity timeline.

    Type Parameters

    • T

    Parameters

    • lead_id: string

    Returns AxiosPromise<default<T>>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc