About the Account Details API

With the Account Details API you can retrieve key information about a site's email marketing account, including the account's current status, premium plan details, and email quota for the current period. You can also control how engagement with the site's emails is tracked.

With the Account Details API, you can:

• Retrieve the account's current status and whether campaigns can be sent.
• Retrieve the current premium plan and its monthly quota allocation.
• Retrieve quota usage for the current period.
• Enable or disable opens tracking for the site's emails.

Account status

The account status field indicates whether the site can send email marketing campaigns. An account must be ACTIVE before campaigns can be sent.

Possible statuses:

• ACTIVE: The account is in good standing. Campaigns can be created and sent.
• WARNED: The account owner must accept the terms of use in the Wix Email Marketing dashboard before campaigns can be sent.
• SUSPENDED: The account is suspended. The account owner must complete a compliance questionnaire in the Wix Email Marketing dashboard.
• SUSPENDED_AUTOLIFT: The account is suspended but may be automatically reinstated after completing a compliance questionnaire in the Wix Email Marketing dashboard.
• BANNED: The account is suspended. The account owner must complete a more rigorous compliance questionnaire in the Wix Email Marketing dashboard.

When the status is not ACTIVE, campaigns cannot be sent. Resolution requires the site owner to visit the Wix Email Marketing dashboard. There is no public API for changing account status.

Quota

The quotaPeriod field shows the current billing cycle and how much quota has been used:

• quotaPeriod.dateFrom and quotaPeriod.dateTo: the start and end of the current quota period. Quota always resets on a monthly cycle, regardless of whether the site has a monthly or yearly billing plan.
• quotaPeriod.quotaUsage: campaigns and emails sent so far in this period.
• package.monthlyQuotaAllocation: the maximum campaigns and emails allowed per quota period. A campaigns value of -1 means unlimited campaigns.

Tracking settings

Tracking settings control how engagement with the site's emails is measured. They're held in trackingSettings, and trackingSettings.opensTrackingEnabled determines whether email opens are recorded.

Tracking settings apply to the whole site, so they cover every email sent from it, including email marketing campaigns, automation emails, and triggered emails. Each site has its own tracking settings, so changing them for one site doesn't affect any other site. Sites that have never changed the setting have opens tracking enabled.

Disabling opens tracking doesn't turn off click tracking, and it doesn't delete opens already recorded. Campaign statistics keep reporting opens collected before the change.

Before you begin

It's important to note the following points before starting to code:

• Account status, premium plan, and quota information are read-only. Use Get Account Details to check account status and quota before publishing campaigns.
• Tracking settings are the only writable part of this API. Change them with Update Tracking Settings, which then reports the new values in accountDetails.trackingSettings.
• When the account status is not ACTIVE, the site owner must resolve the issue in the Wix Email Marketing dashboard. There is no public API for changing account status.
• Quota is tracked per month. Exceeding the email quota prevents additional campaigns from being sent until the quota resets.

Use cases

• Check account eligibility before sending a campaign
• Disable opens tracking before sending a campaign

Terminology

• Account status: Indicates whether the site's email marketing account is active and campaigns can be sent. Possible values: ACTIVE, WARNED, SUSPENDED, SUSPENDED_AUTOLIFT, BANNED.
• Quota period: The current billing cycle, defined by dateFrom and dateTo, during which the allocated quota applies.
• Monthly quota allocation: The maximum number of campaigns and emails the current plan allows per billing period. A value of -1 means unlimited.
• Package group: A set of Wix premium plans that share compatible quota allocations and can be upgraded or downgraded between each other.
• Tracking settings: Site-level settings that control how engagement with the site's emails is measured.
• Opens tracking: Recording when a recipient opens an email, measured with a tracking pixel embedded in the email.