Namespace: hs/emailEvents

hs/emailEvents

A collection of methods related to the Email Events API

Methods

hs/emailEvents.getCampaign (campaignId, appId)Promise asyncstatic

For a given campaign, return data associated with the campaign.

Name Type Description
campaignId int

Selected campaign id.

appId int

The Application Id for the given email. Found in the get_campaigns endpoint.

Returns:
Type Description
Promise
Example
const hs = new HubspotClient(props);
hs.emailEvents.getCampaign(campaignId, appId).then(response => console.log(response));

hs/emailEvents.getCampaignsWithRecentActivity (opts)Promise asyncstatic

For a given portal, return all campaign IDs sorted by recent activity associated with the portal.

Name Type Description
opts object
Properties:
Name Type Description
opts.limit int
opts.offset int
Returns:
Type Description
Promise
Example
const hs = new HubspotClient(props);
hs.emailEvents.getCampaignsWithRecentActivity(opts).then(response => console.log(response));