Campaign Object

Attributes
campaignIdstringformat GUID
Campaign ID.

titlestring
Marketing campaign title. For sent campaigns this will match the email subject if subject was not explicitly provided on sending. For published campaigns - the title will be the first line of text.

firstImageUrlstringformat URI
URL of first image after the logo.

snapshotImageUrlstringformat URI
URL of the landing page snapshot.

editorTypestring
3 supported values:
UNKNOWNWEBMOBILE
Editor type. Either web app, or mobile app.

statusstring
4 supported values:
UNKNOWNACTIVEARCHIVEDDELETED
Campaign status.

visibilityStatusstring
4 supported values:
UNKNOWNDRAFTPUBLISHEDTEMPLATE
Campaign visibility status.

distributionStatusstring
11 supported values:
UNKNOWNNOT_STARTEDSCHEDULEDIN_DETECTIONIN_MODERATIONSAMPLINGSENDINGREJECTEDTERMINATEDDISTRIBUTEDPAUSED
Campaign distribution status.

publishingDataobject
Publishing data (present only if campaign is published).

dateCreatedstringformat date-time
Campaign creation date.

dateUpdatedstringformat date-time
Campaign last update date.
Was this helpful?
Yes
No

GetList Statistics

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a list of statistics for up to 100 selected campaigns.

For each campaign, you receive the total activity count for the campaign's landing page and email. For example, the total amount of times the landing page was opened, or the total amount of email recipients that clicked a link in an email.

Use List Campaigns to retrieve additional information for your campaigns. Use List Recipients to retrieve a list of recipients and their activities related to a selected campaign.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Email Marketing
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
GET
https://www.wixapis.com/email-marketing/v1/campaigns/statistics

Was this helpful?
Yes
No

GetList Recipients

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a list of recipients for a selected campaign based on a specific recipient activity.

Pages are returned with a maximum of 1,000 recipients per page and defaults to 40 recipients per page.

Use List Statistics to retrieve a list of activity for selected campaigns. Use List Campaigns to retrieve additional information for your campaigns.

Note: If no activity is included, this endpoint returns an error.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Email Marketing
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
GET
https://www.wixapis.com/email-marketing/v1/campaigns/{campaignId}/statistics/recipients

Was this helpful?
Yes
No

GetGet Campaign

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves information about an email campaign.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Email Marketing
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
GET
https://www.wixapis.com/email-marketing/v1/campaigns/{campaignId}

Was this helpful?
Yes
No

DeleteDelete Campaign

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Permanently deletes a campaign.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Email Marketing
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
DELETE
https://www.wixapis.com/email-marketing/v1/campaigns/{campaignId}

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

GetList Campaigns

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Returns a list of email campaigns.

Default sort by date_updated in desc order.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Email Marketing
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
GET
https://www.wixapis.com/email-marketing/v1/campaigns

Was this helpful?
Yes
No

PostPublish Campaign

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Publishes/sends a specified campaign. If email_distribution_options are not supplied, the campaign is only published as a landing page.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Email Marketing
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
POST
https://www.wixapis.com/email-marketing/v1/campaigns/{campaignId}/publish

Was this helpful?
Yes
No

PostSend Test

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Sends a test email for preview purposes. It is heavily throttled - do not use this for regular campaign sending.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Email Marketing
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
POST
https://www.wixapis.com/email-marketing/v1/campaigns/{campaignId}/test

Was this helpful?
Yes
No

PostPause Scheduling

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Pauses a scheduled campaign. Learn more about market campaign scheduling.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Email Marketing
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
POST
https://www.wixapis.com/email-marketing/v1/campaigns/{campaignId}/pause-scheduling

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

PostReuse Campaign

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Creates a (draft) copy of an existing campaign.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Email Marketing
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
POST
https://www.wixapis.com/email-marketing/v1/campaigns/{campaignId}/reuse

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

Campaign Created

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Triggered when a new (draft) campaign is created.

Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring
Unique event ID. Allows clients to ignore duplicate webhooks.

entityFqdnstring
Fully qualified domain name of the entity associated with the event. Expected wix.email_marketing.v1.campaign.

slugstring
Event name. Expected created.

entityIdstring
ID of the entity associated with the event.

eventTimestringformat date-time
Event timestamp.

triggeredByAnonymizeRequestboolean
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).

originatedFromstring
If present, indicates the action that triggered the event.

createdEventobject
Event information.
Was this helpful?
Yes
No

Campaign Rejected Event

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Triggered when a campaign is identified as abusive and rejected without sending emails to recipients.

Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring
Unique event ID. Allows clients to ignore duplicate webhooks.

entityFqdnstring
Fully qualified domain name of the entity associated with the event. Expected wix.email_marketing.v1.campaign.

slugstring
Event name. Expected campaign_rejected_event.

entityIdstring
ID of the entity associated with the event.

eventTimestringformat date-time
Event timestamp.

triggeredByAnonymizeRequestboolean
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).

originatedFromstring
If present, indicates the action that triggered the event.

actionEventobject
Event information.
Was this helpful?
Yes
No

Campaign Published Event

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Triggered when a draft campaign is published.

Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring
Unique event ID. Allows clients to ignore duplicate webhooks.

entityFqdnstring
Fully qualified domain name of the entity associated with the event. Expected wix.email_marketing.v1.campaign.

slugstring
Event name. Expected campaign_published_event.

entityIdstring
ID of the entity associated with the event.

eventTimestringformat date-time
Event timestamp.

triggeredByAnonymizeRequestboolean
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).

originatedFromstring
If present, indicates the action that triggered the event.

actionEventobject
Event information.
Was this helpful?
Yes
No

Campaign Terminated Event

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Triggered when the mailing list is not clean and campaign was terminated (not sent to all recipients).

Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring
Unique event ID. Allows clients to ignore duplicate webhooks.

entityFqdnstring
Fully qualified domain name of the entity associated with the event. Expected wix.email_marketing.v1.campaign.

slugstring
Event name. Expected campaign_terminated_event.

entityIdstring
ID of the entity associated with the event.

eventTimestringformat date-time
Event timestamp.

triggeredByAnonymizeRequestboolean
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).

originatedFromstring
If present, indicates the action that triggered the event.

actionEventobject
Event information.
Was this helpful?
Yes
No

Campaign Distributed Event

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Triggered when a campaign is successfully distributed to all recipients

Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring
Unique event ID. Allows clients to ignore duplicate webhooks.

entityFqdnstring
Fully qualified domain name of the entity associated with the event. Expected wix.email_marketing.v1.campaign.

slugstring
Event name. Expected campaign_distributed_event.

entityIdstring
ID of the entity associated with the event.

eventTimestringformat date-time
Event timestamp.

triggeredByAnonymizeRequestboolean
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).

originatedFromstring
If present, indicates the action that triggered the event.

actionEventobject
Event information.
Was this helpful?
Yes
No

Email Activity Updated

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Triggered each time an email campaign has a new recipient activity.

New recipient activity includes when each email in a campaign is DELIVERED, OPENED, or BOUNCED. Also, when a URL inside the email is CLICKED.

The type of activity that triggered the webhook is in actionEvent.body and can be one of:

  • delivery: Email was delivered to recipient.
  • click: Recipient clicked on a URL in an email.
  • open: Recipient opened an email.
  • softBounce: Email soft bounced when sent to a recipient.
  • hardBounce: Email hard bounced when sent to a recipient.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring
Unique event ID. Allows clients to ignore duplicate webhooks.

entityFqdnstring
Fully qualified domain name of the entity associated with the event. Expected wix.email_marketing.v1.campaign.

slugstring
Event name. Expected email_activity_updated.

entityIdstring
ID of the entity associated with the event.

eventTimestringformat date-time
Event timestamp.

triggeredByAnonymizeRequestboolean
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).

originatedFromstring
If present, indicates the action that triggered the event.

actionEventobject
Event information.
Was this helpful?
Yes
No

Campaign Scheduled Event

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Campaign scheduled at a specific time in the future.

Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring
Unique event ID. Allows clients to ignore duplicate webhooks.

entityFqdnstring
Fully qualified domain name of the entity associated with the event. Expected wix.email_marketing.v1.campaign.

slugstring
Event name. Expected campaign_scheduled_event.

entityIdstring
ID of the entity associated with the event.

eventTimestringformat date-time
Event timestamp.

triggeredByAnonymizeRequestboolean
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).

originatedFromstring
If present, indicates the action that triggered the event.

actionEventobject
Event information.
Was this helpful?
Yes
No

Campaign Paused Event

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Triggered when a scheduled campaign is paused.

Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring
Unique event ID. Allows clients to ignore duplicate webhooks.

entityFqdnstring
Fully qualified domain name of the entity associated with the event. Expected wix.email_marketing.v1.campaign.

slugstring
Event name. Expected campaign_paused_event.

entityIdstring
ID of the entity associated with the event.

eventTimestringformat date-time
Event timestamp.

triggeredByAnonymizeRequestboolean
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).

originatedFromstring
If present, indicates the action that triggered the event.

actionEventobject
Event information.
Was this helpful?
Yes
No

Campaign Deleted

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Triggered when a campaign is deleted.

Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring
Unique event ID. Allows clients to ignore duplicate webhooks.

entityFqdnstring
Fully qualified domain name of the entity associated with the event. Expected wix.email_marketing.v1.campaign.

slugstring
Event name. Expected deleted.

entityIdstring
ID of the entity associated with the event.

eventTimestringformat date-time
Event timestamp.

triggeredByAnonymizeRequestboolean
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).

originatedFromstring
If present, indicates the action that triggered the event.

deletedEventstruct
Event information.
Was this helpful?
Yes
No