> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # Method name: listCampaigns(options: ListCampaignsOptions) # Method package: wixEmailMarketingV2 # Method menu location: wixEmailMarketingV2 --> campaigns --> listCampaigns # Method Link: https://dev.wix.com/docs/velo/apis/wix-email-marketing-v2/campaigns/list-campaigns.md # Method Description: Returns a list of email campaigns. By default sorts by the `dateUpdated` field in the `DESC` order. # Method Code Examples: *** Note: do not assume any prop names or enum values other than the ones in the example. ## Returns a list of email campaigns (dashboard page code) ```javascript import { campaigns } from 'wix-email-marketing.v2'; // Sample options value: // { // paging: { // limit: 2, // offset: 0 // } // } export async function myListCampaignsFunction(options) { try { const results = await campaigns.listCampaigns(options); console.log('Success! Retrieved results:', results); return results; } catch (error) { console.error(error); } } /* Promise resolves to: * { * "campaigns": [ * { * "campaignId": "b98a4436-10f5-47bd-9c6f-370962adfe54", * "title": "A New Tutorial for You", * "firstImageUrl": "https://static.wixstatic.com/media/6191b8_77d27f7d028a4b50850b7f92dadcd578~mv2.png", * "editorType": "WEB", * "status": "ACTIVE", * "visibilityStatus": "PUBLISHED", * "distributionStatus": "DISTRIBUTED", * "publishingData": { * "landingPageUrl": "https://shoutout.wix.com/so/54OdUqUrf?languageTag=en", * "datePublished": "2023-08-10T09:40:59.000Z", * "wasResentToNonOpeners": false * }, * "dateCreated": "2023-08-10T09:40:47.000Z", * "dateUpdated": "2023-08-10T09:40:59.045Z", * "sendingState": "SENT", * "campaignType": "EMAIL_MARKETING" * }, * { * "campaignId": "fb21c999-40b5-4364-8e75-18273da41983", * "title": "What did we do last month?", * "firstImageUrl": "https://static.wixstatic.com/media/eceb8e_e65cd7284b4c4144a4fb8b2f3ce30a68~mv2_d_2000_1334_s_2.png", * "editorType": "WEB", * "status": "ACTIVE", * "visibilityStatus": "PUBLISHED", * "distributionStatus": "DISTRIBUTED", * "publishingData": { * "landingPageUrl": "https://shoutout.wix.com/so/83OdQ8pDA?languageTag=en", * "datePublished": "2023-08-10T09:25:15.000Z", * "wasResentToNonOpeners": false * }, * "dateCreated": "2023-08-09T11:51:27.000Z", * "dateUpdated": "2023-08-10T09:25:14.952Z", * "sendingState": "SENT", * "campaignType": "EMAIL_MARKETING" * } * ] * } */ ``` ## Returns a list of email campaigns (export from backend code) ```javascript import { Permissions, webMethod } from 'wix-web-module'; import { campaigns } from 'wix-email-marketing.v2'; // Sample options value: // { // paging: { // limit: 2, // offset: 0 // } // } export const myListCampaignsFunction = webMethod(Permissions.Anyone, async (options) => { try { const results = await campaigns.listCampaigns(options); console.log('Success! Retrieved results:', results); return results; } catch (error) { console.error(error); } }); /* Promise resolves to: * { * "campaigns": [ * { * "campaignId": "b98a4436-10f5-47bd-9c6f-370962adfe54", * "title": "A New Tutorial for You", * "firstImageUrl": "https://static.wixstatic.com/media/6191b8_77d27f7d028a4b50850b7f92dadcd578~mv2.png", * "editorType": "WEB", * "status": "ACTIVE", * "visibilityStatus": "PUBLISHED", * "distributionStatus": "DISTRIBUTED", * "publishingData": { * "landingPageUrl": "https://shoutout.wix.com/so/54OdUqUrf?languageTag=en", * "datePublished": "2023-08-10T09:40:59.000Z", * "wasResentToNonOpeners": false * }, * "dateCreated": "2023-08-10T09:40:47.000Z", * "dateUpdated": "2023-08-10T09:40:59.045Z", * "sendingState": "SENT", * "campaignType": "EMAIL_MARKETING" * }, * { * "campaignId": "fb21c999-40b5-4364-8e75-18273da41983", * "title": "What did we do last month?", * "firstImageUrl": "https://static.wixstatic.com/media/eceb8e_e65cd7284b4c4144a4fb8b2f3ce30a68~mv2_d_2000_1334_s_2.png", * "editorType": "WEB", * "status": "ACTIVE", * "visibilityStatus": "PUBLISHED", * "distributionStatus": "DISTRIBUTED", * "publishingData": { * "landingPageUrl": "https://shoutout.wix.com/so/83OdQ8pDA?languageTag=en", * "datePublished": "2023-08-10T09:25:15.000Z", * "wasResentToNonOpeners": false * }, * "dateCreated": "2023-08-09T11:51:27.000Z", * "dateUpdated": "2023-08-10T09:25:14.952Z", * "sendingState": "SENT", * "campaignType": "EMAIL_MARKETING" * } * ] * } */ ``` ## Returns a list of email campaigns based on optional data ```javascript import { Permissions, webMethod } from 'wix-web-module'; import { campaigns } from 'wix-email-marketing.v2'; // Sample options value: // { // options: { // campaignType: 'AUTOMATION', // statuses: ['DELETED'], // visibilityStatuses: ['PUBLISHED] // } // } export const myListCampaignsFunction = webMethod(Permissions.Anyone, async (options) => { try { const results = await campaigns.listCampaigns(options); console.log('Success! Retrieved results:', results); return results; } catch (error) { console.error(error); } }); /* Promise resolves to: * { * "campaigns": [ * { * "campaignId": "b98a4436-10f5-47bd-9c6f-370962adfe54", * "title": "A New Tutorial for You", * "firstImageUrl": "https://static.wixstatic.com/media/6191b8_77d27f7d028a4b50850b7f92dadcd578~mv2.png", * "editorType": "WEB", * "status": "DELETED", * "visibilityStatus": "PUBLISHED", * "distributionStatus": "DISTRIBUTED", * "publishingData": { * "landingPageUrl": "https://shoutout.wix.com/so/54OdUqUrf?languageTag=en", * "datePublished": "2023-08-10T09:40:59.000Z", * "wasResentToNonOpeners": false * }, * "dateCreated": "2023-08-10T09:40:47.000Z", * "dateUpdated": "2023-08-10T09:40:59.045Z", * "sendingState": "SENT", * "campaignType": "EMAIL_MARKETING" * }, * { * "campaignId": "fb21c999-40b5-4364-8e75-18273da41983", * "title": "What did we do last month?", * "firstImageUrl": "https://static.wixstatic.com/media/eceb8e_e65cd7284b4c4144a4fb8b2f3ce30a68~mv2_d_2000_1334_s_2.png", * "editorType": "WEB", * "status": "DELETED", * "visibilityStatus": "PUBLISHED", * "distributionStatus": "DISTRIBUTED", * "publishingData": { * "landingPageUrl": "https://shoutout.wix.com/so/83OdQ8pDA?languageTag=en", * "datePublished": "2023-08-10T09:25:15.000Z", * "wasResentToNonOpeners": false * }, * "dateCreated": "2023-08-09T11:51:27.000Z", * "dateUpdated": "2023-08-10T09:25:14.952Z", * "sendingState": "SENT", * "campaignType": "EMAIL_MARKETING" * } * ] * } */ ``` ## Returns a list of email campaigns and adds the campaign title to your database ```javascript import { Permissions, webMethod } from 'wix-web-module'; import { campaigns } from 'wix-email-marketing.v2'; import wixData from 'wix-data'; export const myListCampaignsFunction = webMethod(Permissions.Anyone, async () => { try { const result = await campaigns.listCampaigns(); const campaignTitle = result.campaigns.title[0].title; console.log(campaignTitle); // store campaign title in your database let toInsert = { "title": campaignTitle }; const results = await wixData.insert('myDatabaseCollection', toInsert); console.log(`Data inserted successfully. The item ID is: ${results._id}`); // Data inserted successfully. The item ID is: 532549d4-2a95-45cc-bb8e-4cb39422e42c return { "title": campaignTitle } } catch (error) { console.error(error); return { "Error": "Failed to find and insert data." }; } }); /* * Promise returns: * { * "title": "A New Tutorial for You" * } */ ``` ---