GET

Get Campaign


Retrieves information about an email campaign.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Email Marketing
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/email-marketing/v1/campaigns/{campaignId}

Path Params
campaignIdstringRequired

Campaign ID.

Query Params
optionIncludeStatisticsboolean

Whether a returned campaign object should include publishingData.statistics.

Default: false.

Response Object
campaignCampaign

Campaign information.

Get Campaign
Request
cURL
curl -X GET 'https://www.wixapis.com/email-marketing/v1/campaigns/98b5a0b3-549b-4e58-b933-a8bd40923a14' \ -H 'Authorization: <AUTH>'
Response
JSON
{ "campaign": { "campaignId": "98b5a0b3-549b-4e58-b933-a8bd40923a14", "title": "Yoga with puppies", "firstImageUrl": "//static.wixstatic.com/media/eceb8e_f1f549829402430e8e6408182cb1453c~mv2_d_3681_1488_s_2.jpg", "editorType": "WEB", "status": "ACTIVE", "visibilityStatus": "PUBLISHED", "distributionStatus": "DISTRIBUTED", "publishingData": { "landingPageUrl": "https://shoutout.wix.com/so/d8NCkRGvE", "datePublished": "2020-07-08T12:37:17Z" }, "dateCreated": "2020-07-08T12:36:05Z", "dateUpdated": "2020-07-08T12:36:29.801250634Z" } }
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?