{"id":"85c27c40-dbe6-45d7-8683-8b9f63bb6515","createdDate":"2023-07-30T12:36:55.892Z","updatedDate":"2023-07-30T12:36:55.892Z","resourceId":"ab11d6d2-9dcd-4600-9526-733c34cf9c24","api":{"schema":{"object":{"displayName":"Campaign Object","description":"","slug":"campaign-object","$ref":"#/components/schemas/wix.emailmarketing.api.v1.Campaign","legacyExamples":[{"title":"Campaign","content":"{\n \"campaignId\": \"c9b491f8-bad0-4d0d-8a1c-c90055d31553\",\n \"title\": \"Email subject\",\n \"firstImageUrl\": \"//static.wixstatic.com/media/eceb8e_e1f32b0d497447a8898e7abcf01d7d87~mv2_d_5600_3733_s_4_2.jpg\",\n \"snapshotImageUrl\": \"https://images-wixmp-a87e9a901094cb6400f2e0ce.wixmp.com/images/c9b491f8-bad0-4d0d-8a1c-c90055d31dd3-e2fda936-ff4d-4741-85aa-cc8ef74198b9_snapshot.jpg\",\n \"editorType\": \"WEB\",\n \"status\": \"ACTIVE\",\n \"visibilityStatus\": \"PUBLISHED\",\n \"distributionStatus\": \"DISTRIBUTED\",\n \"publishingData\": {\n \"landingPageUrl\": \"https://www.example.com/so/SHORTCODE\",\n \"statistics\": {\n \"landingPage\": {},\n \"emailCampaign\": {\n \"delivered\": 2,\n \"opened\": 2,\n \"clicked\": 2\n },\n \"total\": {\n \"mailsSent\": 2,\n \"opened\": 10,\n \"clicked\": 8\n }\n },\n \"datePublished\": \"2020-02-14T14:28:54Z\"\n },\n \"dateCreated\": \"2020-02-13T11:18:30Z\",\n \"dateUpdated\": \"2020-02-14T14:28:19.680596102Z\"\n}"}],"sourceRepo":"git@github.com:wix-private/promote-server.git"},"methods":[{"summary":"List Statistics","description":"Retrieves a list of statistics for up to 100 selected campaigns.\n\nFor each campaign, you receive the total activity count for the campaign's landing page and email. For example, the total\namount of times the landing page was opened, or the total amount of email recipients that clicked a link in an email.\n\nUse [List Campaigns](https://dev.wix.com/api/rest/marketing/email-marketing/campaign/list-campaigns) to retrieve additional information for your campaigns.\nUse [List Recipients](https://dev.wix.com/api/rest/marketing/email-marketing/campaign/list-recipients) to retrieve a list of recipients and their activities related to a selected campaign.","operationId":"wix.emailmarketing.api.v1.CampaignStatisticsService.ListStatistics","parameters":[{"name":"campaignIds","in":"query","description":"IDs of the campaigns to retrieve.\n\nMax: 100 campaigns","required":true,"schema":{"title":"campaignIds","description":"IDs of the campaigns to retrieve.\n\nMax: 100 campaigns","format":"GUID","minItems":1,"maxItems":100,"type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}}],"responses":{"200":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.ListStatisticsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/email-marketing/v1","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/email-marketing/v1","destinationPath":"/v1","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.emailmarketing.api.v1.CampaignStatisticsService","errors":[],"exposure":"PUBLIC","permissions":["Shoutout.Read"],"externalPermissionScopes":[{"name":"Read Email Marketing","scopeId":"SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING"}],"protoArtifactId":"com.wixpress.shoutout:shoutout-platform-api","serviceArtifactId":"com.wixpress.shoutout.shoutout-editor","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.emailmarketing.api.v1.ListStatisticsRequest","responseMessage":"wix.emailmarketing.api.v1.ListStatisticsResponse"},"legacyExamples":[{"name":"ListStatistics","serviceName":"CampaignStatisticsService","type":"METHOD","content":{"title":"List Statistics for a campaign","description":"Retrieve statistics for a campaign","request":"curl 'www.wixapis.com/email-marketing/v1/campaigns/statistics?campaignIds=ab0105b6-b9d9-426d-a753-1af8a3fee545' \\\n-H 'Authorization: '","response":"{\n \"statistics\":[\n {\n \"campaignId\":\"ab0105b6-b9d9-426d-a753-1af8a3fee545\",\n \"landingPage\":{\n \"opened\":2,\n \"clicked\":2\n },\n \"email\":{\n \"delivered\":9,\n \"opened\":8,\n \"clicked\":7,\n \"bounced\":3,\n \"complained\":0,\n \"notSent\":2\n }\n }\n ]\n}"}},{"name":"ListStatistics","serviceName":"CampaignStatisticsService","type":"METHOD","order":1,"content":{"title":"List Statistics for more than 1 campaign","request":"curl 'www.wixapis.com/email-marketing/v1/campaigns/statistics?campaignIds=5274f9f6-7031-40d6-972a-b3212ed53f58&campaignIds=8a7f8211-99e4-4116-9d41-da2d11c1e161' \\\n-H 'Authorization: '","response":"{\n \"statistics\": [\n {\n \"campaignId\": \"5274f9f6-7031-40d6-972a-b3212ed53f58\",\n \"landingPage\": {\n \"opened\": 0,\n \"clicked\": 0\n },\n \"email\": {\n \"delivered\": 6,\n \"opened\": 2,\n \"clicked\": 2,\n \"bounced\": 0,\n \"complained\": 0,\n \"notSent\": 0\n }\n },\n {\n \"campaignId\": \"8a7f8211-99e4-4116-9d41-da2d11c1e161\",\n \"landingPage\": {\n \"opened\": 1,\n \"clicked\": 0\n },\n \"email\": {\n \"delivered\": 6,\n \"opened\": 6,\n \"clicked\": 0,\n \"bounced\": 0,\n \"complained\": 0,\n \"notSent\": 0\n }\n }\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/promote-server.git"},"httpMethod":"get","path":"/v1/campaigns/statistics","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.emailmarketing.api.v1.CampaignStatisticsService","errors":[],"exposure":"PUBLIC","permissions":["Shoutout.Read"],"externalPermissionScopes":[{"name":"Read Email Marketing","scopeId":"SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING"}],"protoArtifactId":"com.wixpress.shoutout:shoutout-platform-api","serviceArtifactId":"com.wixpress.shoutout.shoutout-editor","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.emailmarketing.api.v1.ListStatisticsRequest","responseMessage":"wix.emailmarketing.api.v1.ListStatisticsResponse"},"legacyExamples":[{"name":"ListStatistics","serviceName":"CampaignStatisticsService","type":"METHOD","content":{"title":"List Statistics for a campaign","description":"Retrieve statistics for a campaign","request":"curl 'www.wixapis.com/email-marketing/v1/campaigns/statistics?campaignIds=ab0105b6-b9d9-426d-a753-1af8a3fee545' \\\n-H 'Authorization: '","response":"{\n \"statistics\":[\n {\n \"campaignId\":\"ab0105b6-b9d9-426d-a753-1af8a3fee545\",\n \"landingPage\":{\n \"opened\":2,\n \"clicked\":2\n },\n \"email\":{\n \"delivered\":9,\n \"opened\":8,\n \"clicked\":7,\n \"bounced\":3,\n \"complained\":0,\n \"notSent\":2\n }\n }\n ]\n}"}},{"name":"ListStatistics","serviceName":"CampaignStatisticsService","type":"METHOD","order":1,"content":{"title":"List Statistics for more than 1 campaign","request":"curl 'www.wixapis.com/email-marketing/v1/campaigns/statistics?campaignIds=5274f9f6-7031-40d6-972a-b3212ed53f58&campaignIds=8a7f8211-99e4-4116-9d41-da2d11c1e161' \\\n-H 'Authorization: '","response":"{\n \"statistics\": [\n {\n \"campaignId\": \"5274f9f6-7031-40d6-972a-b3212ed53f58\",\n \"landingPage\": {\n \"opened\": 0,\n \"clicked\": 0\n },\n \"email\": {\n \"delivered\": 6,\n \"opened\": 2,\n \"clicked\": 2,\n \"bounced\": 0,\n \"complained\": 0,\n \"notSent\": 0\n }\n },\n {\n \"campaignId\": \"8a7f8211-99e4-4116-9d41-da2d11c1e161\",\n \"landingPage\": {\n \"opened\": 1,\n \"clicked\": 0\n },\n \"email\": {\n \"delivered\": 6,\n \"opened\": 6,\n \"clicked\": 0,\n \"bounced\": 0,\n \"complained\": 0,\n \"notSent\": 0\n }\n }\n ]\n}"}}],"sourceRepo":"git@github.com:wix-private/promote-server.git","contentLink":{"displayName":"List Statistics","slugifiedName":"list-statistics"}},{"summary":"List Recipients","description":"Retrieves a list of recipients for a selected campaign based on a specific recipient activity.\n\nPages are returned with a maximum of 1,000 recipients per page and defaults to 40 recipients per page.\n\nUse [List Statistics](https://dev.wix.com/api/rest/marketing/email-marketing/campaign/list-statistics) to retrieve a list of activity for selected campaigns.\nUse [List Campaigns](https://dev.wix.com/api/rest/marketing/email-marketing/campaign/list-campaigns) to retrieve additional information for your campaigns.\n\n> __Note__: If no `activity` is included, this endpoint returns an error.","operationId":"wix.emailmarketing.api.v1.CampaignStatisticsService.ListRecipients","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"campaignId","description":"Campaign ID.","x-wix-docs":{"exposure":"PUBLIC"}},{"name":"activity","in":"query","description":"__Required.__ Email activity to filter for.","required":true,"schema":{"title":"activity","description":"__Required.__ Email activity to filter for.","type":"string","$ref":"#/components/schemas/wix.emailmarketing.api.v1.RecipientsActivity.Enum","x-wix-docs":{"exposure":"PUBLIC"}}},{"name":"paging","in":"query","description":"Pagination options.","required":false,"schema":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.upstream.wix.common.CursorPaging","summary":"paging","description":"Pagination options.","x-wix-docs":{"exposure":"PUBLIC"}}}],"responses":{"200":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.ListRecipientsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/email-marketing/v1","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/email-marketing/v1","destinationPath":"/v1","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.emailmarketing.api.v1.CampaignStatisticsService","errors":[],"exposure":"PUBLIC","permissions":["Shoutout.Read"],"externalPermissionScopes":[{"name":"Read Email Marketing","scopeId":"SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING"}],"protoArtifactId":"com.wixpress.shoutout:shoutout-platform-api","serviceArtifactId":"com.wixpress.shoutout.shoutout-editor","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.emailmarketing.api.v1.ListRecipientsRequest","responseMessage":"wix.emailmarketing.api.v1.ListRecipientsResponse"},"legacyExamples":[{"name":"ListRecipients","serviceName":"CampaignStatisticsService","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl 'www.wixapis.com/email-marketing/v1/campaigns/8a7f8211-99e4-4116-9d41-da2d11c1e261/statistics/recipients?activity=DELIVERED' \\\n-H 'Authorization: '\n~~~","response":"~~~json\n{\n \"recipients\":[\n {\n \"contactId\":\"7af98416-1939-4239-91fa-8ce9f17cc3f7\",\n \"lastActivityDate\":\"2022-05-13T11:17:45Z\"\n },\n {\n \"contactId\":\"8cef2efc-fe2f-4a30-8136-9d59b901d04c\",\n \"lastActivityDate\":\"2022-05-13T11:17:45Z\"\n }\n ],\n \"pagingMetadata\":{\n \"count\":2,\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/promote-server.git"},"httpMethod":"get","path":"/v1/campaigns/{campaignId}/statistics/recipients","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.emailmarketing.api.v1.CampaignStatisticsService","errors":[],"exposure":"PUBLIC","permissions":["Shoutout.Read"],"externalPermissionScopes":[{"name":"Read Email Marketing","scopeId":"SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING"}],"protoArtifactId":"com.wixpress.shoutout:shoutout-platform-api","serviceArtifactId":"com.wixpress.shoutout.shoutout-editor","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.emailmarketing.api.v1.ListRecipientsRequest","responseMessage":"wix.emailmarketing.api.v1.ListRecipientsResponse"},"legacyExamples":[{"name":"ListRecipients","serviceName":"CampaignStatisticsService","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl 'www.wixapis.com/email-marketing/v1/campaigns/8a7f8211-99e4-4116-9d41-da2d11c1e261/statistics/recipients?activity=DELIVERED' \\\n-H 'Authorization: '\n~~~","response":"~~~json\n{\n \"recipients\":[\n {\n \"contactId\":\"7af98416-1939-4239-91fa-8ce9f17cc3f7\",\n \"lastActivityDate\":\"2022-05-13T11:17:45Z\"\n },\n {\n \"contactId\":\"8cef2efc-fe2f-4a30-8136-9d59b901d04c\",\n \"lastActivityDate\":\"2022-05-13T11:17:45Z\"\n }\n ],\n \"pagingMetadata\":{\n \"count\":2,\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/promote-server.git","contentLink":{"displayName":"List Recipients","slugifiedName":"list-recipients"}},{"summary":"Get Campaign","description":"Retrieves information about an email campaign.","operationId":"wix.emailmarketing.api.v1.CampaignService.Get","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"campaignId","description":"Campaign ID.","x-wix-docs":{"exposure":"PUBLIC"}},{"name":"optionIncludeStatistics","in":"query","description":"Whether a returned campaign object should include `publishingData.statistics`.\n\nDefault: `false`","required":false,"schema":{"title":"optionIncludeStatistics","description":"Whether a returned campaign object should include `publishingData.statistics`.\n\nDefault: `false`","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}}],"responses":{"200":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.GetCampaignResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/email-marketing/v1","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/email-marketing/v1","destinationPath":"/v1","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.emailmarketing.api.v1.CampaignService","errors":[],"exposure":"PUBLIC","permissions":["Shoutout.Manage"],"externalPermissionScopes":[{"name":"Manage Email Marketing","scopeId":"SCOPE.DC-PROMOTE.EMAIL-MARKETING"}],"protoArtifactId":"com.wixpress.shoutout:shoutout-platform-api","serviceArtifactId":"com.wixpress.shoutout.shoutout-editor","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.emailmarketing.api.v1.GetCampaignRequest","responseMessage":"wix.emailmarketing.api.v1.GetCampaignResponse"},"legacyExamples":[{"name":"Get","serviceName":"CampaignService","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X GET 'https://www.wixapis.com/email-marketing/v1/campaigns/{campaign_id}' \\\n-H 'Authorization: '\n~~~","response":"~~~json\n{\n \"campaign\": {\n \"campaignId\": \"{campaign_id}\",\n \"title\": \"Some nice title\",\n \"firstImageUrl\": \"//static.wixstatic.com/media/eceb8e_f1f549829402430e8e6408182cb1453c~mv2_d_3681_1488_s_2.jpg\",\n \"snapshotImageUrl\": \"https://images-wixmp-a87e9a901094cb6400f2e0ce.wixmp.com/images/173083bf-ec73-47af-a5ea-d3de68f98fd8-e3d9eaa3-e4b6-45e4-b2f1-80ad8382a483_snapshot.jpg\",\n \"editorType\": \"WEB\",\n \"status\": \"ACTIVE\",\n \"visibilityStatus\": \"PUBLISHED\",\n \"distributionStatus\": \"DISTRIBUTED\",\n \"publishingData\": {\n \"landingPageUrl\": \"https://shoutout.wix.com/so/d8NCkRGvE\",\n \"datePublished\": \"2020-07-08T12:37:17Z\"\n },\n \"dateCreated\": \"2020-07-08T12:36:05Z\",\n \"dateUpdated\": \"2020-07-08T12:36:29.801250634Z\"\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/promote-server.git"},"httpMethod":"get","path":"/v1/campaigns/{campaignId}","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.emailmarketing.api.v1.CampaignService","errors":[],"exposure":"PUBLIC","permissions":["Shoutout.Manage"],"externalPermissionScopes":[{"name":"Manage Email Marketing","scopeId":"SCOPE.DC-PROMOTE.EMAIL-MARKETING"}],"protoArtifactId":"com.wixpress.shoutout:shoutout-platform-api","serviceArtifactId":"com.wixpress.shoutout.shoutout-editor","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.emailmarketing.api.v1.GetCampaignRequest","responseMessage":"wix.emailmarketing.api.v1.GetCampaignResponse"},"legacyExamples":[{"name":"Get","serviceName":"CampaignService","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X GET 'https://www.wixapis.com/email-marketing/v1/campaigns/{campaign_id}' \\\n-H 'Authorization: '\n~~~","response":"~~~json\n{\n \"campaign\": {\n \"campaignId\": \"{campaign_id}\",\n \"title\": \"Some nice title\",\n \"firstImageUrl\": \"//static.wixstatic.com/media/eceb8e_f1f549829402430e8e6408182cb1453c~mv2_d_3681_1488_s_2.jpg\",\n \"snapshotImageUrl\": \"https://images-wixmp-a87e9a901094cb6400f2e0ce.wixmp.com/images/173083bf-ec73-47af-a5ea-d3de68f98fd8-e3d9eaa3-e4b6-45e4-b2f1-80ad8382a483_snapshot.jpg\",\n \"editorType\": \"WEB\",\n \"status\": \"ACTIVE\",\n \"visibilityStatus\": \"PUBLISHED\",\n \"distributionStatus\": \"DISTRIBUTED\",\n \"publishingData\": {\n \"landingPageUrl\": \"https://shoutout.wix.com/so/d8NCkRGvE\",\n \"datePublished\": \"2020-07-08T12:37:17Z\"\n },\n \"dateCreated\": \"2020-07-08T12:36:05Z\",\n \"dateUpdated\": \"2020-07-08T12:36:29.801250634Z\"\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/promote-server.git","contentLink":{"displayName":"Get Campaign","slugifiedName":"get-campaign"}},{"summary":"Delete Campaign","description":"Permanently deletes a campaign.","operationId":"wix.emailmarketing.api.v1.CampaignService.Delete","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"campaignId","description":"Campaign ID.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.DeleteCampaignResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/email-marketing/v1","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/email-marketing/v1","destinationPath":"/v1","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[{"title":"Campaign Deleted","description":"Triggered when a campaign is deleted.","permissions":["Shoutout.Read"],"exposure":"PUBLIC","maturity":"BETA","slug":"deleted","eventTopic":"domain_events_wix.email_marketing.v1.campaign","serviceName":"wix.emailmarketing.api.v1.CampaignService","domainEvent":"DELETED","sourceRepo":"git@github.com:wix-private/promote-server.git"}],"serviceName":"wix.emailmarketing.api.v1.CampaignService","errors":[],"exposure":"PUBLIC","permissions":["Shoutout.Manage"],"externalPermissionScopes":[{"name":"Manage Email Marketing","scopeId":"SCOPE.DC-PROMOTE.EMAIL-MARKETING"}],"protoArtifactId":"com.wixpress.shoutout:shoutout-platform-api","serviceArtifactId":"com.wixpress.shoutout.shoutout-editor","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.emailmarketing.api.v1.DeleteCampaignRequest","responseMessage":"wix.emailmarketing.api.v1.DeleteCampaignResponse"},"legacyExamples":[{"name":"Delete","serviceName":"CampaignService","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X DELETE 'https://www.wixapis.com/email-marketing/v1/campaigns/{campaign_id}' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: '\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/promote-server.git"},"httpMethod":"delete","path":"/v1/campaigns/{campaignId}","rpcOnly":false,"triggeredEvents":[{"title":"Campaign Deleted","description":"Triggered when a campaign is deleted.","permissions":["Shoutout.Read"],"exposure":"PUBLIC","maturity":"BETA","slug":"deleted","eventTopic":"domain_events_wix.email_marketing.v1.campaign","serviceName":"wix.emailmarketing.api.v1.CampaignService","domainEvent":"DELETED","sourceRepo":"git@github.com:wix-private/promote-server.git"}],"serviceName":"wix.emailmarketing.api.v1.CampaignService","errors":[],"exposure":"PUBLIC","permissions":["Shoutout.Manage"],"externalPermissionScopes":[{"name":"Manage Email Marketing","scopeId":"SCOPE.DC-PROMOTE.EMAIL-MARKETING"}],"protoArtifactId":"com.wixpress.shoutout:shoutout-platform-api","serviceArtifactId":"com.wixpress.shoutout.shoutout-editor","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.emailmarketing.api.v1.DeleteCampaignRequest","responseMessage":"wix.emailmarketing.api.v1.DeleteCampaignResponse"},"legacyExamples":[{"name":"Delete","serviceName":"CampaignService","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X DELETE 'https://www.wixapis.com/email-marketing/v1/campaigns/{campaign_id}' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: '\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/promote-server.git","contentLink":{"displayName":"Delete Campaign","slugifiedName":"delete-campaign"}},{"summary":"List Campaigns","description":"Returns a list of email campaigns.\n\nDefault sort by `date_updated` in `desc` order.","operationId":"wix.emailmarketing.api.v1.CampaignService.List","parameters":[{"name":"paging","in":"query","description":"Paging parameters.","required":false,"schema":{"$ref":"#/components/schemas/wix.common.Paging","summary":"paging","description":"Paging parameters.","x-wix-docs":{"exposure":"PUBLIC"}}},{"name":"optionIncludeStatistics","in":"query","description":"Whether to include `publishingData.statistics` in the returned campaign object.\n\nDefault: `false`","required":false,"schema":{"title":"optionIncludeStatistics","description":"Whether to include `publishingData.statistics` in the returned campaign object.\n\nDefault: `false`","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},{"name":"statuses","in":"query","description":"Include campaigns with the following statuses (no filtering by default).","required":false,"schema":{"title":"statuses","description":"Include campaigns with the following statuses (no filtering by default).","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},{"name":"visibilityStatuses","in":"query","description":"Include campaigns with the following visibility statuses (no filtering by default).","required":false,"schema":{"title":"visibilityStatuses","description":"Include campaigns with the following visibility statuses (no filtering by default).","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},{"name":"campaignType","in":"query","description":"Filter by the following campaign types.","required":false,"schema":{"title":"campaignType","description":"Filter by the following campaign types.","type":"string","$ref":"#/components/schemas/wix.emailmarketing.api.v1.CampaignType.Enum","x-wix-docs":{"exposure":"PUBLIC"}}}],"responses":{"200":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.ListCampaignsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/email-marketing/v1","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/email-marketing/v1","destinationPath":"/v1","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.emailmarketing.api.v1.CampaignService","errors":[],"exposure":"PUBLIC","permissions":["Shoutout.Manage"],"externalPermissionScopes":[{"name":"Manage Email Marketing","scopeId":"SCOPE.DC-PROMOTE.EMAIL-MARKETING"}],"protoArtifactId":"com.wixpress.shoutout:shoutout-platform-api","serviceArtifactId":"com.wixpress.shoutout.shoutout-editor","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.emailmarketing.api.v1.ListCampaignsRequest","responseMessage":"wix.emailmarketing.api.v1.ListCampaignsResponse"},"legacyExamples":[{"name":"List","serviceName":"CampaignService","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X GET 'https://www.wixapis.com/email-marketing/v1/campaigns?option_include_statistics=true&visibility_statuses=DRAFT&statuses=ACTIVE' \\\n-H 'Authorization: '\n~~~","response":"~~~json\n{\n \"campaigns\": [\n {\n \"campaignId\": \"688565b5-d890-4984-8167-1987c1999a1a\",\n \"title\": \"Some nice title\",\n \"firstImageUrl\": \"https:////static.wixstatic.com/media/eceb8e_baccf99d697447468400ca1aba4c4a60~mv2.jpg\",\n \"snapshotImageUrl\": \"https://images-wixmp-a87e9a901094cb6400f2e0ce.wixmp.com/images/688565b5-d890-4984-8167-1987c1999a1a-f6c63191-6453-457c-87c6-2197d6e167c2_snapshot.jpg\",\n \"editorType\": \"WEB\",\n \"status\": \"ACTIVE\",\n \"visibilityStatus\": \"DRAFT\",\n \"distributionStatus\": \"NOT_STARTED\",\n \"dateCreated\": \"2020-04-23T11:29:22Z\",\n \"dateUpdated\": \"2020-05-14T10:08:33.291462479Z\"\n }\n ]\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/promote-server.git"},"httpMethod":"get","path":"/v1/campaigns","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.emailmarketing.api.v1.CampaignService","errors":[],"exposure":"PUBLIC","permissions":["Shoutout.Manage"],"externalPermissionScopes":[{"name":"Manage Email Marketing","scopeId":"SCOPE.DC-PROMOTE.EMAIL-MARKETING"}],"protoArtifactId":"com.wixpress.shoutout:shoutout-platform-api","serviceArtifactId":"com.wixpress.shoutout.shoutout-editor","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.emailmarketing.api.v1.ListCampaignsRequest","responseMessage":"wix.emailmarketing.api.v1.ListCampaignsResponse"},"legacyExamples":[{"name":"List","serviceName":"CampaignService","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X GET 'https://www.wixapis.com/email-marketing/v1/campaigns?option_include_statistics=true&visibility_statuses=DRAFT&statuses=ACTIVE' \\\n-H 'Authorization: '\n~~~","response":"~~~json\n{\n \"campaigns\": [\n {\n \"campaignId\": \"688565b5-d890-4984-8167-1987c1999a1a\",\n \"title\": \"Some nice title\",\n \"firstImageUrl\": \"https:////static.wixstatic.com/media/eceb8e_baccf99d697447468400ca1aba4c4a60~mv2.jpg\",\n \"snapshotImageUrl\": \"https://images-wixmp-a87e9a901094cb6400f2e0ce.wixmp.com/images/688565b5-d890-4984-8167-1987c1999a1a-f6c63191-6453-457c-87c6-2197d6e167c2_snapshot.jpg\",\n \"editorType\": \"WEB\",\n \"status\": \"ACTIVE\",\n \"visibilityStatus\": \"DRAFT\",\n \"distributionStatus\": \"NOT_STARTED\",\n \"dateCreated\": \"2020-04-23T11:29:22Z\",\n \"dateUpdated\": \"2020-05-14T10:08:33.291462479Z\"\n }\n ]\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/promote-server.git","contentLink":{"displayName":"List Campaigns","slugifiedName":"list-campaigns"}},{"summary":"Publish Campaign","description":"Publishes/sends a specified campaign.\nIf `email_distribution_options` are not supplied, the campaign is only published as a landing page.","operationId":"wix.emailmarketing.api.v1.CampaignService.Publish","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"campaignId","description":"Campaign ID","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.PublishCampaignResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/email-marketing/v1","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/email-marketing/v1","destinationPath":"/v1","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"PublishCampaignRequest","description":"","properties":{"emailDistributionOptions":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.PublishCampaignRequest.EmailDistributionOptions","summary":"emailDistributionOptions","description":"Email distribution options - provided only if marketing campaign is intended to be distributed via email.","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["campaignId"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Campaign Campaign Rejected Event","description":"Triggered when a campaign is identified as abusive and rejected without sending emails to recipients.","permissions":["Shoutout.Read"],"payload":{"schemaName":"wix.emailmarketing.api.v1.CampaignRejectedEvent"},"exposure":"PUBLIC","maturity":"BETA","slug":"campaign_rejected_event","eventTopic":"domain_events_wix.email_marketing.v1.campaign","serviceName":"wix.emailmarketing.api.v1.CampaignService","domainEvent":"CUSTOM_ACTION","sourceRepo":"git@github.com:wix-private/promote-server.git"},{"title":"Campaign Campaign Published Event","description":"Triggered when a draft campaign is published.","permissions":["Shoutout.Read"],"payload":{"schemaName":"wix.emailmarketing.api.v1.CampaignPublishedEvent"},"exposure":"PUBLIC","maturity":"BETA","slug":"campaign_published_event","eventTopic":"domain_events_wix.email_marketing.v1.campaign","serviceName":"wix.emailmarketing.api.v1.CampaignService","domainEvent":"CUSTOM_ACTION","sourceRepo":"git@github.com:wix-private/promote-server.git"},{"title":"Campaign Campaign Terminated Event","description":"Triggered when the mailing list is not clean and campaign was terminated (not sent to all recipients).","permissions":["Shoutout.Read"],"payload":{"schemaName":"wix.emailmarketing.api.v1.CampaignTerminatedEvent"},"exposure":"PUBLIC","maturity":"BETA","slug":"campaign_terminated_event","eventTopic":"domain_events_wix.email_marketing.v1.campaign","serviceName":"wix.emailmarketing.api.v1.CampaignService","domainEvent":"CUSTOM_ACTION","sourceRepo":"git@github.com:wix-private/promote-server.git"},{"title":"Campaign Campaign Distributed Event","description":"Triggered when a campaign is successfully distributed to all recipients","permissions":["Shoutout.Read"],"payload":{"schemaName":"wix.emailmarketing.api.v1.CampaignDistributedEvent"},"exposure":"PUBLIC","maturity":"BETA","slug":"campaign_distributed_event","eventTopic":"domain_events_wix.email_marketing.v1.campaign","serviceName":"wix.emailmarketing.api.v1.CampaignService","domainEvent":"CUSTOM_ACTION","sourceRepo":"git@github.com:wix-private/promote-server.git"},{"title":"Campaign Email Activity Updated","description":"Triggered each time an email campaign has a new recipient activity.\n\nNew recipient activity includes when each email in a campaign is `DELIVERED`, `OPENED`,\nor `BOUNCED`. Also, when a URL inside the email is `CLICKED`.\n\nThe type of activity that triggered the webhook is in `actionEvent.body` and can be one of:\n+ `delivery`: Email was delivered to recipient.\n+ `click`: Recipient clicked on a URL in an email.\n+ `open`: Recipient opened an email.\n+ `softBounce`: Email soft bounced when sent to a recipient.\n+ `hardBounce`: Email hard bounced when sent to a recipient.","permissions":["Shoutout.Read"],"payload":{"schemaName":"wix.emailmarketing.api.v1.EmailActivityUpdated"},"exposure":"PUBLIC","maturity":"BETA","slug":"email_activity_updated","eventTopic":"domain_events_wix.email_marketing.v1.campaign","serviceName":"wix.emailmarketing.api.v1.CampaignService","domainEvent":"CUSTOM_ACTION","sourceRepo":"git@github.com:wix-private/promote-server.git"},{"title":"Campaign Campaign Scheduled Event","description":"Campaign scheduled at a specific time in the future.","permissions":["Shoutout.Read"],"payload":{"schemaName":"wix.emailmarketing.api.v1.CampaignScheduledEvent"},"exposure":"PUBLIC","maturity":"BETA","slug":"campaign_scheduled_event","eventTopic":"domain_events_wix.email_marketing.v1.campaign","serviceName":"wix.emailmarketing.api.v1.CampaignService","domainEvent":"CUSTOM_ACTION","sourceRepo":"git@github.com:wix-private/promote-server.git"}],"serviceName":"wix.emailmarketing.api.v1.CampaignService","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ALREADY_SENT"}],"exposure":"PUBLIC","permissions":["Shoutout.Manage"],"externalPermissionScopes":[{"name":"Manage Email Marketing","scopeId":"SCOPE.DC-PROMOTE.EMAIL-MARKETING"}],"protoArtifactId":"com.wixpress.shoutout:shoutout-platform-api","serviceArtifactId":"com.wixpress.shoutout.shoutout-editor","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.emailmarketing.api.v1.PublishCampaignRequest","responseMessage":"wix.emailmarketing.api.v1.PublishCampaignResponse"},"legacyExamples":[{"name":"Publish","serviceName":"CampaignService","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST 'https://www.wixapis.com/email-marketing/v1/campaigns/{campaign_id}/publish' \\\n--data-binary '{\n \"emailDistributionOptions\": {\n \"emailSubject\": \"Some email subject\",\n \"labelIds\": [\"contacts-all\"]\n }\n }' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: '\n~~~","response":"~~~json\n{\n \"publishingData\": {\n \"landingPageUrl\": \"https://shoutout.wix.com/so/{code}\"\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/promote-server.git"},"httpMethod":"post","path":"/v1/campaigns/{campaignId}/publish","rpcOnly":false,"triggeredEvents":[{"title":"Campaign Campaign Rejected Event","description":"Triggered when a campaign is identified as abusive and rejected without sending emails to recipients.","permissions":["Shoutout.Read"],"payload":{"schemaName":"wix.emailmarketing.api.v1.CampaignRejectedEvent"},"exposure":"PUBLIC","maturity":"BETA","slug":"campaign_rejected_event","eventTopic":"domain_events_wix.email_marketing.v1.campaign","serviceName":"wix.emailmarketing.api.v1.CampaignService","domainEvent":"CUSTOM_ACTION","sourceRepo":"git@github.com:wix-private/promote-server.git"},{"title":"Campaign Campaign Published Event","description":"Triggered when a draft campaign is published.","permissions":["Shoutout.Read"],"payload":{"schemaName":"wix.emailmarketing.api.v1.CampaignPublishedEvent"},"exposure":"PUBLIC","maturity":"BETA","slug":"campaign_published_event","eventTopic":"domain_events_wix.email_marketing.v1.campaign","serviceName":"wix.emailmarketing.api.v1.CampaignService","domainEvent":"CUSTOM_ACTION","sourceRepo":"git@github.com:wix-private/promote-server.git"},{"title":"Campaign Campaign Terminated Event","description":"Triggered when the mailing list is not clean and campaign was terminated (not sent to all recipients).","permissions":["Shoutout.Read"],"payload":{"schemaName":"wix.emailmarketing.api.v1.CampaignTerminatedEvent"},"exposure":"PUBLIC","maturity":"BETA","slug":"campaign_terminated_event","eventTopic":"domain_events_wix.email_marketing.v1.campaign","serviceName":"wix.emailmarketing.api.v1.CampaignService","domainEvent":"CUSTOM_ACTION","sourceRepo":"git@github.com:wix-private/promote-server.git"},{"title":"Campaign Campaign Distributed Event","description":"Triggered when a campaign is successfully distributed to all recipients","permissions":["Shoutout.Read"],"payload":{"schemaName":"wix.emailmarketing.api.v1.CampaignDistributedEvent"},"exposure":"PUBLIC","maturity":"BETA","slug":"campaign_distributed_event","eventTopic":"domain_events_wix.email_marketing.v1.campaign","serviceName":"wix.emailmarketing.api.v1.CampaignService","domainEvent":"CUSTOM_ACTION","sourceRepo":"git@github.com:wix-private/promote-server.git"},{"title":"Campaign Email Activity Updated","description":"Triggered each time an email campaign has a new recipient activity.\n\nNew recipient activity includes when each email in a campaign is `DELIVERED`, `OPENED`,\nor `BOUNCED`. Also, when a URL inside the email is `CLICKED`.\n\nThe type of activity that triggered the webhook is in `actionEvent.body` and can be one of:\n+ `delivery`: Email was delivered to recipient.\n+ `click`: Recipient clicked on a URL in an email.\n+ `open`: Recipient opened an email.\n+ `softBounce`: Email soft bounced when sent to a recipient.\n+ `hardBounce`: Email hard bounced when sent to a recipient.","permissions":["Shoutout.Read"],"payload":{"schemaName":"wix.emailmarketing.api.v1.EmailActivityUpdated"},"exposure":"PUBLIC","maturity":"BETA","slug":"email_activity_updated","eventTopic":"domain_events_wix.email_marketing.v1.campaign","serviceName":"wix.emailmarketing.api.v1.CampaignService","domainEvent":"CUSTOM_ACTION","sourceRepo":"git@github.com:wix-private/promote-server.git"},{"title":"Campaign Campaign Scheduled Event","description":"Campaign scheduled at a specific time in the future.","permissions":["Shoutout.Read"],"payload":{"schemaName":"wix.emailmarketing.api.v1.CampaignScheduledEvent"},"exposure":"PUBLIC","maturity":"BETA","slug":"campaign_scheduled_event","eventTopic":"domain_events_wix.email_marketing.v1.campaign","serviceName":"wix.emailmarketing.api.v1.CampaignService","domainEvent":"CUSTOM_ACTION","sourceRepo":"git@github.com:wix-private/promote-server.git"}],"serviceName":"wix.emailmarketing.api.v1.CampaignService","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"ALREADY_SENT"}],"exposure":"PUBLIC","permissions":["Shoutout.Manage"],"externalPermissionScopes":[{"name":"Manage Email Marketing","scopeId":"SCOPE.DC-PROMOTE.EMAIL-MARKETING"}],"protoArtifactId":"com.wixpress.shoutout:shoutout-platform-api","serviceArtifactId":"com.wixpress.shoutout.shoutout-editor","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.emailmarketing.api.v1.PublishCampaignRequest","responseMessage":"wix.emailmarketing.api.v1.PublishCampaignResponse"},"legacyExamples":[{"name":"Publish","serviceName":"CampaignService","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST 'https://www.wixapis.com/email-marketing/v1/campaigns/{campaign_id}/publish' \\\n--data-binary '{\n \"emailDistributionOptions\": {\n \"emailSubject\": \"Some email subject\",\n \"labelIds\": [\"contacts-all\"]\n }\n }' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: '\n~~~","response":"~~~json\n{\n \"publishingData\": {\n \"landingPageUrl\": \"https://shoutout.wix.com/so/{code}\"\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/promote-server.git","contentLink":{"displayName":"Publish Campaign","slugifiedName":"publish-campaign"}},{"summary":"Send Test","description":"Sends a test email for preview purposes. It is heavily throttled - do not use this for regular campaign sending.","operationId":"wix.emailmarketing.api.v1.CampaignService.SendTest","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"campaignId","description":"Campaign ID.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.SendTestResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/email-marketing/v1","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/email-marketing/v1","destinationPath":"/v1","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"SendTestRequest","description":"","properties":{"emailSubject":{"title":"emailSubject","description":"Subject of an email sent to recipient.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"toEmailAddress":{"title":"toEmailAddress","description":"Recipient's email address.","format":"EMAIL","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false,"required":["campaignId","toEmailAddress"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.emailmarketing.api.v1.CampaignService","errors":[],"exposure":"PUBLIC","permissions":["Shoutout.Manage"],"externalPermissionScopes":[{"name":"Manage Email Marketing","scopeId":"SCOPE.DC-PROMOTE.EMAIL-MARKETING"}],"protoArtifactId":"com.wixpress.shoutout:shoutout-platform-api","serviceArtifactId":"com.wixpress.shoutout.shoutout-editor","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.emailmarketing.api.v1.SendTestRequest","responseMessage":"wix.emailmarketing.api.v1.SendTestResponse"},"legacyExamples":[{"name":"SendTest","serviceName":"CampaignService","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST 'https://www.wixapis.com/email-marketing/v1/campaigns/{campaign_id}/test' \\\n--data-binary '{\n \"emailSubject\": \"Test email subject\",\n \"toEmailAddress\": \"jack.sparrow@email.com\"\n }' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: '\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/promote-server.git"},"httpMethod":"post","path":"/v1/campaigns/{campaignId}/test","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.emailmarketing.api.v1.CampaignService","errors":[],"exposure":"PUBLIC","permissions":["Shoutout.Manage"],"externalPermissionScopes":[{"name":"Manage Email Marketing","scopeId":"SCOPE.DC-PROMOTE.EMAIL-MARKETING"}],"protoArtifactId":"com.wixpress.shoutout:shoutout-platform-api","serviceArtifactId":"com.wixpress.shoutout.shoutout-editor","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.emailmarketing.api.v1.SendTestRequest","responseMessage":"wix.emailmarketing.api.v1.SendTestResponse"},"legacyExamples":[{"name":"SendTest","serviceName":"CampaignService","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST 'https://www.wixapis.com/email-marketing/v1/campaigns/{campaign_id}/test' \\\n--data-binary '{\n \"emailSubject\": \"Test email subject\",\n \"toEmailAddress\": \"jack.sparrow@email.com\"\n }' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: '\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/promote-server.git","contentLink":{"displayName":"Send Test","slugifiedName":"send-test"}},{"summary":"Pause Scheduling","description":"Pauses a scheduled campaign. Learn more about [market campaign scheduling](https://support.wix.com/en/article/managing-your-scheduled-email-marketing-campaign).","operationId":"wix.emailmarketing.api.v1.CampaignService.PauseScheduling","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"campaignId","description":"Campaign ID.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.PauseSchedulingResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/email-marketing/v1","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/email-marketing/v1","destinationPath":"/v1","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"PauseSchedulingRequest","description":"","properties":{},"deprecated":false,"required":["campaignId"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Campaign Campaign Paused Event","description":"Triggered when a scheduled campaign is paused.","permissions":["Shoutout.Read"],"payload":{"schemaName":"wix.emailmarketing.api.v1.CampaignPausedEvent"},"exposure":"PUBLIC","maturity":"BETA","slug":"campaign_paused_event","eventTopic":"domain_events_wix.email_marketing.v1.campaign","serviceName":"wix.emailmarketing.api.v1.CampaignService","domainEvent":"CUSTOM_ACTION","sourceRepo":"git@github.com:wix-private/promote-server.git"}],"serviceName":"wix.emailmarketing.api.v1.CampaignService","errors":[],"exposure":"PUBLIC","permissions":["Shoutout.Manage"],"externalPermissionScopes":[{"name":"Manage Email Marketing","scopeId":"SCOPE.DC-PROMOTE.EMAIL-MARKETING"}],"protoArtifactId":"com.wixpress.shoutout:shoutout-platform-api","serviceArtifactId":"com.wixpress.shoutout.shoutout-editor","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.emailmarketing.api.v1.PauseSchedulingRequest","responseMessage":"wix.emailmarketing.api.v1.PauseSchedulingResponse"},"legacyExamples":[{"name":"PauseScheduling","serviceName":"CampaignService","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST 'https://www.wixapis.com/email-marketing/v1/campaigns/{campaign_id}/pause-scheduling' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: '\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/promote-server.git"},"httpMethod":"post","path":"/v1/campaigns/{campaignId}/pause-scheduling","rpcOnly":false,"triggeredEvents":[{"title":"Campaign Campaign Paused Event","description":"Triggered when a scheduled campaign is paused.","permissions":["Shoutout.Read"],"payload":{"schemaName":"wix.emailmarketing.api.v1.CampaignPausedEvent"},"exposure":"PUBLIC","maturity":"BETA","slug":"campaign_paused_event","eventTopic":"domain_events_wix.email_marketing.v1.campaign","serviceName":"wix.emailmarketing.api.v1.CampaignService","domainEvent":"CUSTOM_ACTION","sourceRepo":"git@github.com:wix-private/promote-server.git"}],"serviceName":"wix.emailmarketing.api.v1.CampaignService","errors":[],"exposure":"PUBLIC","permissions":["Shoutout.Manage"],"externalPermissionScopes":[{"name":"Manage Email Marketing","scopeId":"SCOPE.DC-PROMOTE.EMAIL-MARKETING"}],"protoArtifactId":"com.wixpress.shoutout:shoutout-platform-api","serviceArtifactId":"com.wixpress.shoutout.shoutout-editor","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.emailmarketing.api.v1.PauseSchedulingRequest","responseMessage":"wix.emailmarketing.api.v1.PauseSchedulingResponse"},"legacyExamples":[{"name":"PauseScheduling","serviceName":"CampaignService","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST 'https://www.wixapis.com/email-marketing/v1/campaigns/{campaign_id}/pause-scheduling' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: '\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/promote-server.git","contentLink":{"displayName":"Pause Scheduling","slugifiedName":"pause-scheduling"}},{"summary":"Reuse Campaign","description":"Creates a (draft) copy of an existing campaign.","operationId":"wix.emailmarketing.api.v1.CampaignService.Reuse","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"campaignId","description":"ID of the message to be duplicated.","x-wix-docs":{"exposure":"PUBLIC"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.ReuseCampaignResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/email-marketing/v1","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/email-marketing/v1","destinationPath":"/v1","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"ReuseCampaignRequest","description":"","properties":{},"deprecated":false,"required":["campaignId"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Campaign Created","description":"Triggered when a new (draft) campaign is created.","permissions":["Shoutout.Read"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.email_marketing.v1.campaign","serviceName":"wix.emailmarketing.api.v1.CampaignService","domainEvent":"CREATED","sourceRepo":"git@github.com:wix-private/promote-server.git"}],"serviceName":"wix.emailmarketing.api.v1.CampaignService","errors":[],"exposure":"PUBLIC","permissions":["Shoutout.Manage"],"externalPermissionScopes":[{"name":"Manage Email Marketing","scopeId":"SCOPE.DC-PROMOTE.EMAIL-MARKETING"}],"protoArtifactId":"com.wixpress.shoutout:shoutout-platform-api","serviceArtifactId":"com.wixpress.shoutout.shoutout-editor","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.emailmarketing.api.v1.ReuseCampaignRequest","responseMessage":"wix.emailmarketing.api.v1.ReuseCampaignResponse"},"legacyExamples":[{"name":"Reuse","serviceName":"CampaignService","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST 'https://www.wixapis.com/email-marketing/v1/campaigns/{campaign_id}/reuse' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: '\n~~~","response":"~~~json\n{\n \"campaign\": {\n \"campaignId\": \"98b5a0b3-549b-4e58-b933-a8bd40923a14\",\n \"title\": \"Some email subject\",\n \"firstImageUrl\": \"//static.wixstatic.com/media/eceb8e_f1f549829402430e8e6408182cb1453c~mv2_d_3681_1488_s_2.jpg\",\n \"editorType\": \"WEB\",\n \"status\": \"ACTIVE\",\n \"visibilityStatus\": \"DRAFT\",\n \"distributionStatus\": \"NOT_STARTED\",\n \"dateCreated\": \"2020-07-09T10:07:51Z\",\n \"dateUpdated\": \"2020-07-09T10:07:51.781290641Z\"\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/promote-server.git"},"httpMethod":"post","path":"/v1/campaigns/{campaignId}/reuse","rpcOnly":false,"triggeredEvents":[{"title":"Campaign Created","description":"Triggered when a new (draft) campaign is created.","permissions":["Shoutout.Read"],"exposure":"PUBLIC","maturity":"BETA","slug":"created","eventTopic":"domain_events_wix.email_marketing.v1.campaign","serviceName":"wix.emailmarketing.api.v1.CampaignService","domainEvent":"CREATED","sourceRepo":"git@github.com:wix-private/promote-server.git"}],"serviceName":"wix.emailmarketing.api.v1.CampaignService","errors":[],"exposure":"PUBLIC","permissions":["Shoutout.Manage"],"externalPermissionScopes":[{"name":"Manage Email Marketing","scopeId":"SCOPE.DC-PROMOTE.EMAIL-MARKETING"}],"protoArtifactId":"com.wixpress.shoutout:shoutout-platform-api","serviceArtifactId":"com.wixpress.shoutout.shoutout-editor","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.emailmarketing.api.v1.ReuseCampaignRequest","responseMessage":"wix.emailmarketing.api.v1.ReuseCampaignResponse"},"legacyExamples":[{"name":"Reuse","serviceName":"CampaignService","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST 'https://www.wixapis.com/email-marketing/v1/campaigns/{campaign_id}/reuse' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: '\n~~~","response":"~~~json\n{\n \"campaign\": {\n \"campaignId\": \"98b5a0b3-549b-4e58-b933-a8bd40923a14\",\n \"title\": \"Some email subject\",\n \"firstImageUrl\": \"//static.wixstatic.com/media/eceb8e_f1f549829402430e8e6408182cb1453c~mv2_d_3681_1488_s_2.jpg\",\n \"editorType\": \"WEB\",\n \"status\": \"ACTIVE\",\n \"visibilityStatus\": \"DRAFT\",\n \"distributionStatus\": \"NOT_STARTED\",\n \"dateCreated\": \"2020-07-09T10:07:51Z\",\n \"dateUpdated\": \"2020-07-09T10:07:51.781290641Z\"\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/promote-server.git","contentLink":{"displayName":"Reuse Campaign","slugifiedName":"reuse-campaign"}}],"webhooks":[{"summary":"Email Activity Updated","title":"Campaign Email Activity Updated","description":"Triggered each time an email campaign has a new recipient activity.\n\nNew recipient activity includes when each email in a campaign is `DELIVERED`, `OPENED`,\nor `BOUNCED`. Also, when a URL inside the email is `CLICKED`.\n\nThe type of activity that triggered the webhook is in `actionEvent.body` and can be one of:\n+ `delivery`: Email was delivered to recipient.\n+ `click`: Recipient clicked on a URL in an email.\n+ `open`: Recipient opened an email.\n+ `softBounce`: Email soft bounced when sent to a recipient.\n+ `hardBounce`: Email hard bounced when sent to a recipient.","permissions":["Shoutout.Read"],"payload":{"schemaName":"wix.emailmarketing.api.v1.EmailActivityUpdated"},"exposure":"PUBLIC","maturity":"BETA","slug":"email_activity_updated","eventTopic":"domain_events_wix.email_marketing.v1.campaign","serviceName":"wix.emailmarketing.api.v1.CampaignService","domainEvent":"CUSTOM_ACTION","legacyExamples":[{"name":"EmailActivityUpdated","eventType":"UPDATED","type":"DOMAIN_EVENT","content":"{\n \"entityId\": \"38d837a5-8303-413c-8ac0-75d735a4bdb0\",\n \"actionEvent\": {\n \"body\": {\n \"timestamp\": \"2022-09-22T12:58:00Z\",\n \"recipientEmailAddress\": \"michaeltaylor@example.com\",\n \"open\": {\n \"userAgent\": \"Mozilla/5.0 (Windows NT 5.1; rv:11.0) Gecko Firefox/11.0 (via ggpht.com GoogleImageProxy)\"\n },\n \"activityType\": \"OPEN\",\n \"contactId\": \"f1654c62-53b4-43d5-b01b-acbf782dee6f\",\n \"campaignId\": \"38d837a5-8303-413c-8ac0-75d735a4bdb0\"\n }\n },\n \"slug\": \"email_activity_updated\",\n \"id\": \"aacdffe0-8e14-4d1b-8060-8d0bf8248d36\",\n \"entityFqdn\": \"wix.email_marketing.v1.campaign\",\n \"eventTime\": \"2022-09-22T12:58:37.407664Z\",\n \"triggeredByAnonymizeRequest\": false\n}\n"}],"sourceRepo":"git@github.com:wix-private/promote-server.git","$ref":"#/components/schemas/wix.emailmarketing.api.v1.EmailActivityUpdated","contentLink":{"displayName":"Email Activity Updated","slugifiedName":"email-activity-updated"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}]}],"articles":[],"components":{"schemas":{"wix.emailmarketing.api.v1.Campaign":{"type":"object","properties":{"campaignId":{"title":"campaignId","description":"Campaign ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"title":{"title":"title","description":"Marketing campaign title. For sent campaigns this will match the email subject if subject was not explicitly provided on sending.\nFor published campaigns - the title will be the first line of text.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"firstImageUrl":{"title":"firstImageUrl","description":"URL of first image after the logo.","format":"URI","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"snapshotImageUrl":{"title":"snapshotImageUrl","description":"URL of the landing page snapshot.","format":"URI","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"editorType":{"title":"editorType","description":"Editor type. Either web app, or mobile app.","type":"string","$ref":"#/components/schemas/wix.emailmarketing.api.v1.CampaignEditorType.Enum","x-wix-docs":{"exposure":"PUBLIC"}},"status":{"title":"status","description":"Campaign status.","type":"string","$ref":"#/components/schemas/wix.emailmarketing.api.v1.CampaignStatus.Enum","x-wix-docs":{"exposure":"PUBLIC"}},"visibilityStatus":{"title":"visibilityStatus","description":"Campaign visibility status.","type":"string","$ref":"#/components/schemas/wix.emailmarketing.api.v1.CampaignVisibilityStatus.Enum","x-wix-docs":{"exposure":"PUBLIC"}},"distributionStatus":{"title":"distributionStatus","description":"Campaign distribution status.","type":"string","$ref":"#/components/schemas/wix.emailmarketing.api.v1.CampaignDistributionStatus.Enum","x-wix-docs":{"exposure":"PUBLIC"}},"publishingData":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.PublishingData","summary":"publishingData","description":"Publishing data (present only if campaign is published).","x-wix-docs":{"exposure":"PUBLIC"}},"dateCreated":{"title":"dateCreated","description":"Campaign creation date.","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"dateUpdated":{"title":"dateUpdated","description":"Campaign last update date.","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Campaign","description":""},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"title":"value","description":"","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"StringValue","description":""},"wix.emailmarketing.api.v1.CampaignEditorType.Enum":{"type":"string","description":"","title":"Enum","enum":["UNKNOWN","WEB","MOBILE"]},"wix.emailmarketing.api.v1.CampaignStatus.Enum":{"type":"string","description":"","title":"Enum","enum":["UNKNOWN","ACTIVE","ARCHIVED","DELETED"]},"wix.emailmarketing.api.v1.CampaignVisibilityStatus.Enum":{"type":"string","description":"","title":"Enum","enum":["UNKNOWN","DRAFT","PUBLISHED","TEMPLATE"]},"wix.emailmarketing.api.v1.CampaignDistributionStatus.Enum":{"type":"string","description":"","title":"Enum","enum":["UNKNOWN","NOT_STARTED","SCHEDULED","IN_DETECTION","IN_MODERATION","SAMPLING","SENDING","REJECTED","TERMINATED","DISTRIBUTED","PAUSED"]},"wix.emailmarketing.api.v1.PublishingData":{"type":"object","properties":{"landingPageUrl":{"title":"landingPageUrl","description":"Landing page URL.","format":"URI","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"statistics":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.CampaignStatistics","summary":"statistics","description":"Marketing campaign statistics.","x-wix-docs":{"exposure":"PUBLIC"}},"datePublished":{"title":"datePublished","description":"Marketing campaign publish date.","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"PublishingData","description":""},"wix.emailmarketing.api.v1.CampaignStatistics":{"type":"object","properties":{"landingPage":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.LandingPageStatistics","summary":"landingPage","description":"Marketing campaign's landing page statistics.","x-wix-docs":{"exposure":"PUBLIC"}},"emailCampaign":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.DistributionStatistics","summary":"emailCampaign","description":"Marketing campaign's email distribution statistics.","x-wix-docs":{"exposure":"PUBLIC"}},"total":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.TotalStatistics","summary":"total","description":"Combined landing page and email distribution statistics.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CampaignStatistics","description":""},"wix.emailmarketing.api.v1.LandingPageStatistics":{"type":"object","properties":{"opened":{"title":"opened","description":"Number of times landing page was loaded or viewed.","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"clicked":{"title":"clicked","description":"Number of times a link was clicked in landing page.","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"LandingPageStatistics","description":""},"wix.emailmarketing.api.v1.DistributionStatistics":{"type":"object","properties":{"delivered":{"title":"delivered","description":"Number of emails delivered.","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"opened":{"title":"opened","description":"Number of recipients who opened an email.\n\nIf a single recipient opens an email twice, it is counted as one unique open.","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"clicked":{"title":"clicked","description":"Number of recipients who clicked a link in the email.\n\nIf a single recipient clicks a link in an email twice, it is counted as one unique click.\nIf a single recipient clicks different links in an email, it is counted as one unique click.","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"bounced":{"title":"bounced","description":"Number of emails that bounced.","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"complained":{"title":"complained","description":"Number of recipients who reported email as spam.","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"notSent":{"title":"notSent","description":"Number of emails not sent because the campaign was terminated.","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"DistributionStatistics","description":""},"wix.emailmarketing.api.v1.TotalStatistics":{"type":"object","properties":{"mailsSent":{"title":"mailsSent","description":"Total number of emails sent.","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"opened":{"title":"opened","description":"Number of landing page views + emails opened.","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"clicked":{"title":"clicked","description":"Number of landing page link clicks + email link clicks.","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"TotalStatistics","description":""},"google.protobuf.Timestamp":{"type":"object","properties":{"seconds":{"title":"seconds","description":"","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"nanos":{"title":"nanos","description":"","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Timestamp","description":""},"wix.emailmarketing.api.v1.RejectionData":{"type":"object","properties":{"rejectionReasons":{"title":"rejectionReasons","description":"","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"RejectionData","description":""},"wix.emailmarketing.api.v1.RejectionReason.Enum":{"type":"string","description":"","title":"Enum","enum":["UNKNOWN","LOW_ENGAGEMENT","SENDER_DETAILS","SPAM_TRAPS","OTHER","ADULT_SEXUAL_CONTENT","AFFILIATE_MARKETING","BETTING_OR_GAMBLING","CREDIT_REPAIR_OR_DEBT_RELIEF","GET_RICH_QUICK_SCHEME","ILLEGAL_SUBSTANCES_OR_WEAPONS","MISLEADING_SUBJECT_LINE","TRADING_OR_CRYPTOCURRENCIES","UNSOLICITED_CONTENT"]},"wix.emailmarketing.api.v1.CampaignSendingState.Enum":{"type":"string","description":"","title":"Enum","enum":["DRAFT","REVIEW","REJECTED","SCHEDULED","PAUSED","PUBLISHED","SENDING","PARTIALLY_SENT","SENT"]},"wix.emailmarketing.api.v1.CampaignType.Enum":{"type":"string","description":"","title":"Enum","enum":["UNKNOWN","EMAIL_MARKETING","INVITATION","AUTOMATION","TRIGGERED"]},"wix.emailmarketing.api.v1.ListStatisticsRequest":{"type":"object","properties":{"campaignIds":{"title":"campaignIds","description":"IDs of the campaigns to retrieve.\n\nMax: 100 campaigns","format":"GUID","minItems":1,"maxItems":100,"type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListStatisticsRequest","description":""},"wix.emailmarketing.api.v1.ListStatisticsResponse":{"type":"object","properties":{"statistics":{"title":"statistics","description":"List of statistics.","type":"array","items":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.CampaignStatisticsContainer"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListStatisticsResponse","description":""},"wix.emailmarketing.api.v1.CampaignStatisticsContainer":{"type":"object","properties":{"campaignId":{"title":"campaignId","description":"Campaign ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"landingPage":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.LandingPageStatistics","summary":"landingPage","description":"Landing page statistics.","x-wix-docs":{"exposure":"PUBLIC"}},"email":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.DistributionStatistics","summary":"email","description":"Email campaign statistics.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CampaignStatisticsContainer","description":""},"wix.emailmarketing.api.v1.ListRecipientsRequest":{"type":"object","properties":{"campaignId":{"title":"campaignId","description":"Campaign ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"activity":{"title":"activity","description":"__Required.__ Email activity to filter for.","type":"string","$ref":"#/components/schemas/wix.emailmarketing.api.v1.RecipientsActivity.Enum","x-wix-docs":{"exposure":"PUBLIC"}},"paging":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.upstream.wix.common.CursorPaging","summary":"paging","description":"Pagination options.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListRecipientsRequest","description":""},"wix.emailmarketing.api.v1.RecipientsActivity.Enum":{"type":"string","description":"","title":"Enum","enum":["UNKNOWN","DELIVERED","OPENED","CLICKED","BOUNCED","NOT_SENT"]},"wix.emailmarketing.api.v1.upstream.wix.common.CursorPaging":{"type":"object","properties":{"limit":{"title":"limit","description":"Number of items to load.","minimum":0,"maximum":1000,"type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"cursor":{"title":"cursor","description":"Pointer to the next or previous page in the list of results.\n\nYou can get the relevant cursor token\nfrom the `pagingMetadata` object in the previous call's response.\nNot relevant for the first request.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CursorPaging","description":""},"google.protobuf.Int32Value":{"type":"object","properties":{"value":{"title":"value","description":"","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Int32Value","description":""},"wix.emailmarketing.api.v1.ListRecipientsResponse":{"type":"object","properties":{"recipients":{"title":"recipients","description":"List of recipients.","type":"array","items":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.CampaignRecipientDetails"},"x-wix-docs":{"exposure":"PUBLIC"}},"pagingMetadata":{"$ref":"#/components/schemas/wix.common.PagingMetadataV2","summary":"pagingMetadata","description":"Details on the paged set of returned results.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListRecipientsResponse","description":""},"wix.emailmarketing.api.v1.CampaignRecipientDetails":{"type":"object","properties":{"contactId":{"title":"contactId","description":"Contact ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"lastActivityDate":{"title":"lastActivityDate","description":"Date and time of the last activity.","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CampaignRecipientDetails","description":""},"wix.common.PagingMetadataV2":{"type":"object","properties":{"count":{"title":"count","description":"Number of items returned in the response.","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"offset":{"title":"offset","description":"Offset that was requested.","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"total":{"title":"total","description":"Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set.","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"tooManyToCount":{"title":"tooManyToCount","description":"Flag that indicates the server failed to calculate the `total` field.","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"cursors":{"$ref":"#/components/schemas/wix.common.Cursors","summary":"cursors","description":"Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"PagingMetadataV2","description":""},"google.protobuf.BoolValue":{"type":"object","properties":{"value":{"title":"value","description":"","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BoolValue","description":""},"wix.common.Cursors":{"type":"object","properties":{"next":{"title":"next","description":"Cursor pointing to next page in the list of results.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"prev":{"title":"prev","description":"Cursor pointing to previous page in the list of results.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Cursors","description":""},"wix.emailmarketing.api.v1.GetCampaignMappingRequest":{"type":"object","properties":{"automationRuleId":{"title":"automationRuleId","description":"rule ID in automations","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"templateId":{"title":"templateId","description":"template ID configured for the automation","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetCampaignMappingRequest","description":""},"wix.emailmarketing.api.v1.GetCampaignMappingResponse":{"type":"object","properties":{"campaignId":{"title":"campaignId","description":"","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetCampaignMappingResponse","description":""},"wix.emailmarketing.api.v1.GetPingCampaignMappingRequest":{"type":"object","properties":{"streamId":{"title":"streamId","description":"ping stream ID.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"templateId":{"title":"templateId","description":"template ID configured for the ping automation.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"appDefId":{"title":"appDefId","description":"ID of the initiating vertical.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"pingTemplateId":{"title":"pingTemplateId","description":"Ping template ID.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"language":{"title":"language","description":"Preferred language (optional).","format":"LANGUAGE","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"automationRuleId":{"title":"automationRuleId","description":"rule ID in automations","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetPingCampaignMappingRequest","description":""},"wix.emailmarketing.api.v1.GetPingCampaignMappingResponse":{"type":"object","properties":{"campaignId":{"title":"campaignId","description":"","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetPingCampaignMappingResponse","description":""},"wix.emailmarketing.api.v1.QueryAutomationTemplatesRequest":{"type":"object","properties":{"query":{"$ref":"#/components/schemas/wix.common.Query","summary":"query","description":"https://github.com/wix-private/p13n/blob/master/protos/query/src/main/proto/wix/common/query.proto","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"QueryAutomationTemplatesRequest","description":""},"wix.common.Query":{"type":"object","properties":{"filter":{"title":"filter","description":"Filter object in the following format:\n`\"filter\" : {\n\"fieldName1\": \"value1\",\n\"fieldName2\":{\"$operator\":\"value2\"}\n}`\nExample of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`","$ref":"#/components/schemas/google.protobuf.Value","x-wix-docs":{"exposure":"PUBLIC"}},"sort":{"title":"sort","description":"Sort object in the following format:\n`[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`","type":"array","items":{"$ref":"#/components/schemas/wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC"}},"paging":{"$ref":"#/components/schemas/wix.common.Paging","summary":"paging","description":"Paging options to limit and skip the number of items.","x-wix-docs":{"exposure":"PUBLIC"}},"fields":{"title":"fields","description":"Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned.","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}},"fieldsets":{"title":"fieldsets","description":"Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned.","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Query","description":""},"google.protobuf.Value":{"type":"object","properties":{},"title":"Value","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/google.protobuf.Value.kind"}]},"google.protobuf.Value.kind":{"type":"object","title":"kind","properties":{"nullValue":{"title":"nullValue","description":"","$ref":"#/components/schemas/google.protobuf.NullValue","x-wix-docs":{"exposure":"PUBLIC"}},"numberValue":{"title":"numberValue","description":"","type":"number","x-wix-docs":{"exposure":"PUBLIC"}},"stringValue":{"title":"stringValue","description":"","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"boolValue":{"title":"boolValue","description":"","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"structValue":{"title":"structValue","description":"","type":"object","x-wix-docs":{"exposure":"PUBLIC"}},"listValue":{"title":"listValue","description":"","$ref":"#/components/schemas/google.protobuf.ListValue","x-wix-docs":{"exposure":"PUBLIC"}}}},"google.protobuf.NullValue":{"type":"string","description":"","title":"NullValue","enum":["NULL_VALUE"]},"google.protobuf.Struct":{"type":"object","properties":{"fields":{"title":"fields","description":"","type":"object","format":"map","properties":{"key:value":{"type":"object","description":"\"key\" of type string, \"value\" of type object","title":"key:value"}},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Struct","description":""},"google.protobuf.ListValue":{"type":"object","properties":{"values":{"title":"values","description":"","$ref":"#/components/schemas/google.protobuf.Value","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListValue","description":""},"wix.common.Sorting":{"type":"object","properties":{"fieldName":{"title":"fieldName","description":"Name of the field to sort by.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"order":{"title":"order","description":"Sort order.","type":"string","$ref":"#/components/schemas/wix.common.SortOrder","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Sorting","description":""},"wix.common.SortOrder":{"type":"string","description":"","title":"SortOrder","enum":["ASC","DESC"]},"wix.common.Paging":{"type":"object","properties":{"limit":{"title":"limit","description":"Number of items to load.","minimum":0,"type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"offset":{"title":"offset","description":"Number of items to skip in the current sort order.","minimum":0,"type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Paging","description":""},"wix.emailmarketing.api.v1.QueryAutomationTemplatesResponse":{"type":"object","properties":{"entries":{"title":"entries","description":"","type":"array","items":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.AutomationTemplateContainer"},"x-wix-docs":{"exposure":"PUBLIC"}},"metaData":{"$ref":"#/components/schemas/com.wixpress.actiontriggers.integrator.entities.QueryMetadata","summary":"metaData","description":"","x-wix-docs":{"exposure":"PUBLIC"}},"total":{"title":"total","description":"","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"QueryAutomationTemplatesResponse","description":""},"wix.emailmarketing.api.v1.AutomationTemplateContainer":{"type":"object","properties":{"automationTemplate":{"$ref":"#/components/schemas/com.wixpress.actiontriggers.integrator.entities.AutomationTemplate","summary":"automationTemplate","description":"","x-wix-docs":{"exposure":"PUBLIC"}},"enrichmentData":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.AutomationTemplateEnrichmentData","summary":"enrichmentData","description":"","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"AutomationTemplateContainer","description":""},"com.wixpress.actiontriggers.integrator.entities.AutomationTemplate":{"type":"object","properties":{"id":{"title":"id","description":"Automation template ID (unique)","format":"GUID","readOnly":true,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"revision":{"title":"revision","description":"Automation template current revision","readOnly":true,"type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}},"name":{"title":"name","description":"Automation template name","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"description":{"title":"description","description":"Automation template description","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"rule":{"$ref":"#/components/schemas/com.wixpress.actiontriggers.integrator.entities.RuleConfiguration","summary":"rule","description":"Automation template rule configuration","x-wix-docs":{"exposure":"PUBLIC"}},"correlationId":{"title":"correlationId","description":"Automation template correlation id - TODO: rename","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"templateType":{"title":"templateType","description":"Automation template type","type":"string","$ref":"#/components/schemas/com.wixpress.actiontriggers.integrator.entities.AutomationTemplate.TemplateType","x-wix-docs":{"exposure":"PUBLIC"}},"preconditions":{"title":"preconditions","description":"Automation template preconditions","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.actiontriggers.integrator.entities.Precondition"},"x-wix-docs":{"exposure":"PUBLIC"}},"groupIds":{"title":"groupIds","description":"used to determine which users will see the Automation template while in internal state","format":"GUID","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}},"templateState":{"title":"templateState","description":"Automation template state","readOnly":true,"type":"string","$ref":"#/components/schemas/com.wixpress.actiontriggers.integrator.entities.AutomationTemplate.TemplateState","x-wix-docs":{"exposure":"PUBLIC"}},"createdDate":{"title":"createdDate","description":"Automation template created date","readOnly":true,"type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"updatedDate":{"title":"updatedDate","description":"Automation template updated date","readOnly":true,"type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"translation":{"$ref":"#/components/schemas/com.wixpress.actiontriggers.integrator.entities.Translation","summary":"translation","description":"","x-wix-docs":{"exposure":"PUBLIC"}},"additionalTranslations":{"title":"additionalTranslations","description":"key -> english value, we will include those keys in the translator json and send them for translations.\nin the \"search rules\" api they will be resolved with their translation","type":"object","format":"map","properties":{"key:value":{"type":"string","description":"\"key\" of type string, \"value\" of type string","title":"key:value"}},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"AutomationTemplate","description":""},"com.wixpress.actiontriggers.integrator.entities.RuleConfiguration":{"type":"object","properties":{"name":{"title":"name","description":"Rule configuration name","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"description":{"title":"description","description":"Rule configuration description","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"trigger":{"$ref":"#/components/schemas/com.wixpress.actiontriggers.integrator.entities.RuleConfiguration.TriggerConfiguration","summary":"trigger","description":"Trigger configuration","x-wix-docs":{"exposure":"PUBLIC"}},"actions":{"title":"actions","description":"Actions configuration","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.actiontriggers.integrator.entities.RuleConfiguration.ActionConfiguration"},"x-wix-docs":{"exposure":"PUBLIC"}},"ruleStatus":{"title":"ruleStatus","description":"Rule status","type":"string","$ref":"#/components/schemas/com.wixpress.actiontriggers.integrator.RuleStatus","x-wix-docs":{"exposure":"PUBLIC"}},"activationCycle":{"$ref":"#/components/schemas/com.wixpress.actiontriggers.integrator.ActivationCycle","summary":"activationCycle","description":"Activation cycle","x-wix-docs":{"exposure":"PUBLIC"}},"metadata":{"$ref":"#/components/schemas/com.wixpress.actiontriggers.integrator.RuleMetadata","summary":"metadata","description":"","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"RuleConfiguration","description":""},"com.wixpress.actiontriggers.integrator.entities.RuleConfiguration.ConditionConfiguration":{"type":"object","properties":{"schemaKey":{"title":"schemaKey","description":"Condition schema key","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"operator":{"title":"operator","description":"Condition operator","type":"string","$ref":"#/components/schemas/com.wixpress.actiontriggers.integrator.entities.RuleConfiguration.ConditionConfiguration.Operator","x-wix-docs":{"exposure":"PUBLIC"}},"values":{"title":"values","description":"Condition values","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ConditionConfiguration","description":""},"com.wixpress.actiontriggers.integrator.entities.RuleConfiguration.ConditionConfiguration.Operator":{"type":"string","description":"","title":"Operator","enum":["UNDEFINED","IN"]},"com.wixpress.actiontriggers.integrator.entities.RuleConfiguration.TriggerConfiguration":{"type":"object","properties":{"appDefId":{"title":"appDefId","description":"Trigger source app def id","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"triggerName":{"title":"triggerName","description":"Trigger name","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"triggerSchema":{"title":"triggerSchema","description":"Trigger schema","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"conditions":{"title":"conditions","description":"Condition configuration","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.actiontriggers.integrator.entities.RuleConfiguration.ConditionConfiguration"},"x-wix-docs":{"exposure":"PUBLIC"}},"triggerConfigurationId":{"title":"triggerConfigurationId","description":"TODO - might need to replace the entire object","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"reengagementDelaySec":{"title":"reengagementDelaySec","description":"Trigger Reengagement delay internal in sec","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"TriggerConfiguration","description":""},"com.wixpress.actiontriggers.integrator.entities.RuleConfiguration.ActionConfiguration":{"type":"object","properties":{"id":{"title":"id","description":"","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"appDefId":{"title":"appDefId","description":"Action source app def id","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"actionName":{"title":"actionName","description":"Action name","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"configuration":{"title":"configuration","description":"Action configuration","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"delayIntervalSec":{"title":"delayIntervalSec","description":"Delay interval in seconds","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ActionConfiguration","description":""},"com.wixpress.actiontriggers.integrator.RuleStatus":{"type":"string","description":"","title":"RuleStatus","enum":["UnknownStatus","Active","Suspended"]},"com.wixpress.actiontriggers.integrator.ActivationCycle":{"type":"object","properties":{"timeFrame":{"title":"timeFrame","description":"set a time frame in minutes for the once_per_user attribute, use 0 for infinite","minimum":0,"type":"number","x-wix-docs":{"exposure":"PUBLIC"}},"activations":{"title":"activations","description":"number of activations allowed in the given time_frame","minimum":1,"type":"number","x-wix-docs":{"exposure":"PUBLIC"}},"rateLimitingJsonata":{"title":"rateLimitingJsonata","description":"","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ActivationCycle","description":""},"com.wixpress.actiontriggers.integrator.RuleMetadata":{"type":"object","properties":{"canBeSuspended":{"title":"canBeSuspended","description":"default value is 'true', when this is set to 'false' user wont be able to toggle off the rule","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"notes":{"title":"notes","description":"additional notes to describe the rule","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"versionType":{"title":"versionType","description":"will be used to indicate to user how urgent is this change during \"version\" changes","type":"string","$ref":"#/components/schemas/com.wixpress.actiontriggers.integrator.RuleMetadata.VersionType","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"RuleMetadata","description":""},"com.wixpress.actiontriggers.integrator.RuleMetadata.VersionType":{"type":"string","description":"","title":"VersionType","enum":["UNKNOWN_VERSION_TYPE","MINOR","MAJOR"]},"com.wixpress.actiontriggers.integrator.entities.AutomationTemplate.TemplateType":{"type":"string","description":"Type","title":"TemplateType","enum":["UNKNOWN_TEMPLATE_TYPE","PREINSTALLED","RECIPE"]},"com.wixpress.actiontriggers.integrator.entities.Precondition":{"type":"object","properties":{"preconditionType":{"title":"preconditionType","description":"Precondition type","type":"string","$ref":"#/components/schemas/com.wixpress.actiontriggers.integrator.entities.Precondition.PreconditionType","x-wix-docs":{"exposure":"PUBLIC"}},"key":{"title":"key","description":"Precondition unique key","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"value":{"title":"value","description":"Precondition value","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Precondition","description":"{\nState message examples:\nprecondition_type: PreconditionType.Petri,\nkey: ‘specs.crm.InvoicesSendViaAutomationsABC’,\nvalue: ‘C’\n},\n{\nprecondition_type: PreconditionType.STATE,\nkey: ‘:double_opt_in’,\nvalue: ‘true’\n},\n{\nprecondition_type: PreconditionType.APP_DEPENDENCY,\nkey: ‘’,\nvalue: ‘true’\n}"},"com.wixpress.actiontriggers.integrator.entities.Precondition.PreconditionType":{"type":"string","description":"","title":"PreconditionType","enum":["UNKNOWN_PRECONDITION_TYPE","PETRI","STATE","APP_DEPENDENCY","DEALER_OFFERING"]},"com.wixpress.actiontriggers.integrator.entities.AutomationTemplate.TemplateState":{"type":"string","description":"","title":"TemplateState","enum":["UNKNOWN_TEMPLATE_STATUS","INTERNAL","PUBLIC","ARCHIVED","LIVE"]},"com.wixpress.actiontriggers.integrator.entities.Translation":{"type":"object","properties":{"state":{"title":"state","description":"","type":"string","$ref":"#/components/schemas/com.wixpress.actiontriggers.integrator.entities.Translation.TranslationState","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Translation","description":""},"com.wixpress.actiontriggers.integrator.entities.Translation.TranslationState":{"type":"string","description":"","title":"TranslationState","enum":["UNKNOWN_TRANSLATION_STATE","NOT_REQUESTED","PENDING","PARTIAL","TRANSLATED"]},"wix.emailmarketing.api.v1.AutomationTemplateEnrichmentData":{"type":"object","properties":{"campaignId":{"title":"campaignId","description":"","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"metaSiteId":{"title":"metaSiteId","description":"","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"AutomationTemplateEnrichmentData","description":""},"com.wixpress.actiontriggers.integrator.entities.QueryMetadata":{"type":"object","properties":{"items":{"title":"items","description":"Number of returned items","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}},"offset":{"title":"offset","description":"Offset that was applied to the request","type":"integer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"QueryMetadata","description":""},"wix.emailmarketing.api.v1.QueryAppTemplatesRequest":{"type":"object","properties":{"queryType":{"title":"queryType","description":"","type":"string","$ref":"#/components/schemas/wix.emailmarketing.api.v1.TemplateQueryType","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"QueryAppTemplatesRequest","description":""},"wix.emailmarketing.api.v1.TemplateQueryType":{"type":"string","description":"","title":"TemplateQueryType","enum":["TRIGGERED_EMAILS","PING"]},"wix.emailmarketing.api.v1.QueryAppTemplatesResponse":{"type":"object","properties":{"template":{"title":"template","description":"","type":"array","items":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.TemplateData"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"QueryAppTemplatesResponse","description":""},"wix.emailmarketing.api.v1.TemplateData":{"type":"object","properties":{"templateName":{"title":"templateName","description":"","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"templateId":{"title":"templateId","description":"","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"TemplateData","description":""},"wix.emailmarketing.api.v1.CampaignLookupRequest":{"type":"object","properties":{"campaignId":{"title":"campaignId","description":"","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CampaignLookupRequest","description":""},"wix.emailmarketing.api.v1.CampaignLookupResponse":{"type":"object","properties":{"campaignId":{"title":"campaignId","description":"","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"instanceId":{"title":"instanceId","description":"","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"metasiteId":{"title":"metasiteId","description":"","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CampaignLookupResponse","description":""},"wix.emailmarketing.api.v1.CampaignLookupBatchRequest":{"type":"object","properties":{"campaignIds":{"title":"campaignIds","description":"","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CampaignLookupBatchRequest","description":""},"wix.emailmarketing.api.v1.CampaignLookupBatchResponse":{"type":"object","properties":{"responses":{"title":"responses","description":"","type":"array","items":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.CampaignLookupResponse"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CampaignLookupBatchResponse","description":""},"wix.emailmarketing.api.v1.GetCampaignRequest":{"type":"object","properties":{"campaignId":{"title":"campaignId","description":"Campaign ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"optionIncludeStatistics":{"title":"optionIncludeStatistics","description":"Whether a returned campaign object should include `publishingData.statistics`.\n\nDefault: `false`","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetCampaignRequest","description":""},"wix.emailmarketing.api.v1.GetCampaignResponse":{"type":"object","properties":{"campaign":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.Campaign","summary":"campaign","description":"Campaign information.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetCampaignResponse","description":""},"wix.emailmarketing.api.v1.ListCampaignsRequest":{"type":"object","properties":{"paging":{"$ref":"#/components/schemas/wix.common.Paging","summary":"paging","description":"Paging parameters.","x-wix-docs":{"exposure":"PUBLIC"}},"optionIncludeStatistics":{"title":"optionIncludeStatistics","description":"Whether to include `publishingData.statistics` in the returned campaign object.\n\nDefault: `false`","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"statuses":{"title":"statuses","description":"Include campaigns with the following statuses (no filtering by default).","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}},"visibilityStatuses":{"title":"visibilityStatuses","description":"Include campaigns with the following visibility statuses (no filtering by default).","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}},"campaignType":{"title":"campaignType","description":"Filter by the following campaign types.","type":"string","$ref":"#/components/schemas/wix.emailmarketing.api.v1.CampaignType.Enum","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListCampaignsRequest","description":""},"wix.emailmarketing.api.v1.ListCampaignsResponse":{"type":"object","properties":{"paging":{"$ref":"#/components/schemas/wix.common.Paging","summary":"paging","description":"Paging parameters.","x-wix-docs":{"exposure":"PUBLIC"}},"campaigns":{"title":"campaigns","description":"List of campaigns.","type":"array","items":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.Campaign"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ListCampaignsResponse","description":""},"wix.emailmarketing.api.v1.CreateFromTemplateRequest":{"type":"object","properties":{"templateId":{"title":"templateId","description":"ID of the template to fork.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"variables":{"title":"variables","description":"Values to replace template placeholders with (unique for each template).","type":"object","format":"map","properties":{"key:value":{"type":"string","description":"\"key\" of type string, \"value\" of type string","title":"key:value"}},"x-wix-docs":{"exposure":"PUBLIC"}},"campaignType":{"title":"campaignType","description":"Campaign type.","type":"string","$ref":"#/components/schemas/wix.emailmarketing.api.v1.CampaignType.Enum","x-wix-docs":{"exposure":"PUBLIC"}},"campaignEditorType":{"title":"campaignEditorType","description":"Campaign editor type. Either web app or mobile app.","type":"string","$ref":"#/components/schemas/wix.emailmarketing.api.v1.CampaignEditorType.Enum","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CreateFromTemplateRequest","description":""},"wix.emailmarketing.api.v1.CreateFromTemplateResponse":{"type":"object","properties":{"campaign":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.Campaign","summary":"campaign","description":"Campaign information.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CreateFromTemplateResponse","description":""},"wix.emailmarketing.api.v1.PublishCampaignRequest":{"type":"object","properties":{"campaignId":{"title":"campaignId","description":"Campaign ID","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"emailDistributionOptions":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.PublishCampaignRequest.EmailDistributionOptions","summary":"emailDistributionOptions","description":"Email distribution options - provided only if marketing campaign is intended to be distributed via email.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"PublishCampaignRequest","description":""},"wix.emailmarketing.api.v1.PublishCampaignRequest.EmailDistributionOptions":{"type":"object","properties":{"emailSubject":{"title":"emailSubject","description":"Subject of an email sent to recipient.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"labelIds":{"title":"labelIds","description":"Label IDs to send campaign to.","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}},"contactIds":{"title":"contactIds","description":"Contact IDs to send campaign to.","format":"GUID","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}},"filterIds":{"title":"filterIds","description":"Filter ids to send campaign to.","format":"GUID","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}},"sendAt":{"title":"sendAt","description":"For scheduling (at least one hour in the future, for premium users only).","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"EmailDistributionOptions","description":""},"wix.emailmarketing.api.v1.PublishCampaignResponse":{"type":"object","properties":{"publishingData":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.PublishingData","summary":"publishingData","description":"`publishingData.statistics` will be empty.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"PublishCampaignResponse","description":""},"wix.emailmarketing.api.v1.CampaignRejectedEvent":{"type":"object","properties":{"campaignId":{"title":"campaignId","description":"ID of the campaign that was rejected.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CampaignRejectedEvent","description":""},"wix.emailmarketing.api.v1.CampaignPublishedEvent":{"type":"object","properties":{"campaignId":{"title":"campaignId","description":"ID of the campaign that was published.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"landingPageUrl":{"title":"landingPageUrl","description":"Campaign landing page URL.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"mailingListSizeEstimate":{"title":"mailingListSizeEstimate","description":"Estimation of recipient list size (optional).","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CampaignPublishedEvent","description":""},"wix.emailmarketing.api.v1.CampaignTerminatedEvent":{"type":"object","properties":{"campaignId":{"title":"campaignId","description":"ID of the campaign that was terminated.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CampaignTerminatedEvent","description":""},"wix.emailmarketing.api.v1.CampaignDistributedEvent":{"type":"object","properties":{"campaignId":{"title":"campaignId","description":"ID of the campaign that was distributed.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CampaignDistributedEvent","description":""},"wix.emailmarketing.api.v1.EmailActivityUpdated":{"type":"object","properties":{"campaignId":{"title":"campaignId","description":"Campaign ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"contactId":{"title":"contactId","description":"[Contact ID](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-object) of recipient.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"recipientEmailAddress":{"title":"recipientEmailAddress","description":"Email address of recipient.","format":"EMAIL","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"timestamp":{"title":"timestamp","description":"Date and time of the event.","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"activityType":{"title":"activityType","description":"","type":"string","$ref":"#/components/schemas/wix.emailmarketing.api.v1.EmailActivityUpdated.ActivityType","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"EmailActivityUpdated","description":"","oneOf":[{"description":"","summary":"eventType","$ref":"#/components/schemas/wix.emailmarketing.api.v1.EmailActivityUpdated.eventType"}]},"wix.emailmarketing.api.v1.EmailActivityUpdated.eventType":{"type":"object","title":"eventType","properties":{"click":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.EmailActivityUpdated.Click","summary":"click","description":"","x-wix-docs":{"exposure":"PUBLIC"}},"open":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.EmailActivityUpdated.Open","summary":"open","description":"Recipient opened an email.","x-wix-docs":{"exposure":"PUBLIC"}},"softBounce":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.EmailActivityUpdated.SoftBounce","summary":"softBounce","description":"Email soft bounced when sent to a recipient.\n\nIndicates a temporary issue sending your email. For example, the email server receiving the email is under a heavy load.\nFor soft bounces, you should wait and try again at a later time.","x-wix-docs":{"exposure":"PUBLIC"}},"hardBounce":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.EmailActivityUpdated.HardBounce","summary":"hardBounce","description":"Email hard bounced when sent to a recipient.\n\nIndicates a permanent error sending your email. For example, the email address does not exist.","x-wix-docs":{"exposure":"PUBLIC"}}}},"wix.emailmarketing.api.v1.EmailActivityUpdated.ActivityType":{"type":"string","description":"The type of email activity that triggered the webhook.","title":"ActivityType","enum":["DELIVERY","CLICK","OPEN","SOFT_BOUNCE","HARD_BOUNCED"]},"wix.emailmarketing.api.v1.EmailActivityUpdated.Click":{"type":"object","properties":{"url":{"title":"url","description":"URL that was clicked.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"userAgent":{"title":"userAgent","description":"Browser user agent of the recipient.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Click","description":""},"wix.emailmarketing.api.v1.EmailActivityUpdated.Open":{"type":"object","properties":{"userAgent":{"title":"userAgent","description":"Browser user agent of the recipient.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Open","description":""},"wix.emailmarketing.api.v1.EmailActivityUpdated.SoftBounce":{"type":"object","properties":{"reason":{"title":"reason","description":"Reason the email soft bounced.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"SoftBounce","description":""},"wix.emailmarketing.api.v1.EmailActivityUpdated.HardBounce":{"type":"object","properties":{"reason":{"title":"reason","description":"Reason the email hard bounced.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"HardBounce","description":""},"wix.emailmarketing.api.v1.CampaignScheduledEvent":{"type":"object","properties":{"campaignId":{"title":"campaignId","description":"ID of the campaign that was scheduled.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"sendAt":{"title":"sendAt","description":"The timestamp campaign is scheduled for.","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CampaignScheduledEvent","description":""},"wix.emailmarketing.api.v1.SendTestRequest":{"type":"object","properties":{"campaignId":{"title":"campaignId","description":"Campaign ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"emailSubject":{"title":"emailSubject","description":"Subject of an email sent to recipient.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"toEmailAddress":{"title":"toEmailAddress","description":"Recipient's email address.","format":"EMAIL","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"SendTestRequest","description":""},"wix.emailmarketing.api.v1.PlaceholderContent":{"type":"object","properties":{},"title":"PlaceholderContent","description":"","oneOf":[{"description":"","summary":"value","$ref":"#/components/schemas/wix.emailmarketing.api.v1.PlaceholderContent.value"}]},"wix.emailmarketing.api.v1.PlaceholderContent.value":{"type":"object","title":"value","properties":{"text":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.PlaceholderContent.PlainText","summary":"text","description":"","x-wix-docs":{"exposure":"PUBLIC"}},"html":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.PlaceholderContent.Html","summary":"html","description":"","x-wix-docs":{"exposure":"PUBLIC"}},"money":{"$ref":"#/components/schemas/wix.common.Money","summary":"money","description":"","x-wix-docs":{"exposure":"PUBLIC"}},"dateTime":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.PlaceholderContent.DateTime","summary":"dateTime","description":"","x-wix-docs":{"exposure":"PUBLIC"}},"map":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.PlaceholderContent.Map","summary":"map","description":"","x-wix-docs":{"exposure":"PUBLIC"}},"array":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.PlaceholderContent.Array","summary":"array","description":"","x-wix-docs":{"exposure":"PUBLIC"}},"enum":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.PlaceholderContent.Enum","summary":"enum","description":"","x-wix-docs":{"exposure":"PUBLIC"}},"attachment":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.PlaceholderContent.Attachment","summary":"attachment","description":"","x-wix-docs":{"exposure":"PUBLIC"}}}},"wix.emailmarketing.api.v1.PlaceholderContent.PlainText":{"type":"object","properties":{"text":{"title":"text","description":"","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"PlainText","description":""},"wix.emailmarketing.api.v1.PlaceholderContent.Html":{"type":"object","properties":{"html":{"title":"html","description":"","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Html","description":""},"wix.common.Money":{"type":"object","properties":{"value":{"title":"value","description":"Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative.","format":"DECIMAL_VALUE","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"currency":{"title":"currency","description":"Currency code. Must be valid ISO 4217 currency code (e.g., USD).","format":"CURRENCY","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"formattedValue":{"title":"formattedValue","description":"Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Money","description":"Money.\nDefault format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003."},"wix.emailmarketing.api.v1.PlaceholderContent.DateTime":{"type":"object","properties":{"timestamp":{"title":"timestamp","description":"","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC"}},"timeZone":{"title":"timeZone","description":"optional time zone is the full name. example: \"Asia/Jerusalem\"","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"DateTime","description":""},"wix.emailmarketing.api.v1.PlaceholderContent.Map":{"type":"object","properties":{"variables":{"title":"variables","description":"","type":"object","format":"map","properties":{"key:value":{"type":"object","description":"\"key\" of type string, \"value\" of type object","title":"key:value"}},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Map","description":""},"wix.emailmarketing.api.v1.PlaceholderContent.Array":{"type":"object","properties":{"items":{"title":"items","description":"","type":"array","items":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.PlaceholderContent"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Array","description":""},"wix.emailmarketing.api.v1.PlaceholderContent.Enum":{"type":"object","properties":{"value":{"title":"value","description":"","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"translation":{"title":"translation","description":"","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Enum","description":""},"wix.emailmarketing.api.v1.PlaceholderContent.Attachment":{"type":"object","properties":{"fileName":{"title":"fileName","description":"","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"downloadUrl":{"title":"downloadUrl","description":"","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Attachment","description":""},"wix.emailmarketing.api.v1.SendTestResponse":{"type":"object","properties":{},"title":"SendTestResponse","description":""},"wix.emailmarketing.api.v1.PauseSchedulingRequest":{"type":"object","properties":{"campaignId":{"title":"campaignId","description":"Campaign ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"PauseSchedulingRequest","description":""},"wix.emailmarketing.api.v1.PauseSchedulingResponse":{"type":"object","properties":{},"title":"PauseSchedulingResponse","description":""},"wix.emailmarketing.api.v1.CampaignPausedEvent":{"type":"object","properties":{"campaignId":{"title":"campaignId","description":"ID of the campaign that was paused.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CampaignPausedEvent","description":""},"wix.emailmarketing.api.v1.ArchiveCampaignRequest":{"type":"object","properties":{"campaignId":{"title":"campaignId","description":"ID of the campaign to archive.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ArchiveCampaignRequest","description":""},"wix.emailmarketing.api.v1.ArchiveCampaignResponse":{"type":"object","properties":{},"title":"ArchiveCampaignResponse","description":""},"wix.emailmarketing.api.v1.CampaignArchivedEvent":{"type":"object","properties":{"campaignId":{"title":"campaignId","description":"ID of the campaign that was archived.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CampaignArchivedEvent","description":"Sent when status of the campaign is changed from \"Active\" to \"Archived\""},"wix.emailmarketing.api.v1.UnarchiveCampaignRequest":{"type":"object","properties":{"campaignId":{"title":"campaignId","description":"ID of the campaign to unarchive.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"UnarchiveCampaignRequest","description":""},"wix.emailmarketing.api.v1.UnarchiveCampaignResponse":{"type":"object","properties":{},"title":"UnarchiveCampaignResponse","description":""},"wix.emailmarketing.api.v1.CampaignUnarchivedEvent":{"type":"object","properties":{"campaignId":{"title":"campaignId","description":"ID of the campaign whose status was changed to active.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CampaignUnarchivedEvent","description":"Sent when status of the campaign is changed from \"Archived\" to \"Active\""},"wix.emailmarketing.api.v1.UpdateTitleRequest":{"type":"object","properties":{"campaignId":{"title":"campaignId","description":"ID of the campaign to change title of.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"title":{"title":"title","description":"","maxLength":1000,"type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"UpdateTitleRequest","description":""},"wix.emailmarketing.api.v1.UpdateTitleResponse":{"type":"object","properties":{},"title":"UpdateTitleResponse","description":""},"wix.emailmarketing.api.v1.DeleteCampaignRequest":{"type":"object","properties":{"campaignId":{"title":"campaignId","description":"Campaign ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"DeleteCampaignRequest","description":""},"wix.emailmarketing.api.v1.DeleteCampaignResponse":{"type":"object","properties":{},"title":"DeleteCampaignResponse","description":""},"wix.emailmarketing.api.v1.ReuseCampaignRequest":{"type":"object","properties":{"campaignId":{"title":"campaignId","description":"ID of the message to be duplicated.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ReuseCampaignRequest","description":""},"wix.emailmarketing.api.v1.ReuseCampaignResponse":{"type":"object","properties":{"campaign":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.Campaign","summary":"campaign","description":"Campaign information.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ReuseCampaignResponse","description":""},"wix.emailmarketing.api.v1.PreviewCampaignRequest":{"type":"object","properties":{"campaignId":{"title":"campaignId","description":"ID of the campaign to preview.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"language":{"title":"language","description":"Preferred language for campaign content (optional).","format":"LANGUAGE","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"placeholders":{"title":"placeholders","description":"Values to replace campaign placeholders with (unique for each campaign).","type":"object","format":"map","properties":{"key:value":{"type":"object","description":"\"key\" of type string, \"value\" of type object","title":"key:value"}},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"PreviewCampaignRequest","description":""},"wix.emailmarketing.api.v1.PreviewCampaignResponse":{"type":"object","properties":{"html":{"title":"html","description":"Preview HTML.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"PreviewCampaignResponse","description":""},"wix.emailmarketing.api.v1.GetComposerRequest":{"type":"object","properties":{"campaignId":{"title":"campaignId","description":"Campaign ID.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetComposerRequest","description":""},"wix.emailmarketing.api.v1.GetComposerResponse":{"type":"object","properties":{"composer":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.Composer","summary":"composer","description":"composer","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GetComposerResponse","description":""},"wix.emailmarketing.api.v1.Composer":{"type":"object","properties":{"composerDataJson":{"title":"composerDataJson","description":"internal data structure for editor/viewer to render the campaign","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Composer","description":"INTERNAL"},"wix.emailmarketing.api.v1.CreateCampaignRequest":{"type":"object","properties":{"composer":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.Composer","summary":"composer","description":"Campaign composer.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CreateCampaignRequest","description":""},"wix.emailmarketing.api.v1.CreateCampaignResponse":{"type":"object","properties":{"campaign":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.Campaign","summary":"campaign","description":"Campaign information.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"CreateCampaignResponse","description":""},"wix.emailmarketing.api.v1.ResendToNonOpenersRequest":{"type":"object","properties":{"campaignId":{"title":"campaignId","description":"ID of the campaign to resend.","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"emailSubject":{"title":"emailSubject","description":"Subject line to use with the resent copy of campaign.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ResendToNonOpenersRequest","description":""},"wix.emailmarketing.api.v1.ResendToNonOpenersResponse":{"type":"object","properties":{"campaignId":{"title":"campaignId","description":"ID of the newly created and resent campaign","format":"GUID","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ResendToNonOpenersResponse","description":""}}},"title":"Campaign","description":"","fqdn":"wix.email_marketing.v1.campaign"},"articles":[]},"reviewStatus":"APPROVED","isLocked":true}

List Campaigns

Permission Scopes