Account Details API: Sample Flows

This article presents possible use cases and corresponding sample flows that you can support. Use them as a starting point when you integrate the Account Details API into your app or site.

Check account eligibility before sending a campaign

Before publishing an email marketing campaign, you can verify that the site's account is active and has sufficient email quota remaining. This prevents attempting to publish a campaign that would fail due to an inactive account or an exhausted quota.

To check account eligibility before sending a campaign:

1. Call Get Account Details to retrieve the current account status and quota.
2. Check the accountDetails.status field. If the value is not ACTIVE, inform the site owner that they must visit the Wix Email Marketing dashboard to resolve the account issue before campaigns can be sent.
3. Check accountDetails.quotaPeriod.quotaUsage.emails against accountDetails.package.monthlyQuotaAllocation.emails to determine how many emails remain in the current period. If the remaining quota is less than the expected campaign audience size, inform the site owner that the quota is insufficient.
4. If the account is ACTIVE and quota is sufficient, proceed to Publish the campaign.

Disable opens tracking before sending a campaign

A site may need to stop recording email opens, for example to meet a privacy or data-protection requirement, or because its audience objects to tracking pixels. Because tracking settings apply to the whole site, disabling opens tracking before you publish means the campaign is sent with opens tracking off from the start.

To disable opens tracking before sending a campaign:

1. Call Get Account Details and read accountDetails.trackingSettings.opensTrackingEnabled to determine whether opens are currently tracked.
2. Call Update Tracking Settings with trackingSettings.opensTrackingEnabled set to false.
3. Publish the campaign. Every email in it is sent without the tracking pixel, and no new opens are recorded for the site until the setting is enabled again.