{"id":"fef8a22d-2673-4711-81f8-aebb6379e2f1","createdDate":"2024-09-03T12:31:35.631Z","updatedDate":"2024-09-03T12:31:35.631Z","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 \"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 (max 100 campaigns).","required":true,"schema":{"description":"IDs of the campaigns to retrieve (max 100 campaigns).","format":"GUID","minItems":1,"maxItems":100,"title":"campaignIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"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","maturity":"BETA","permissions":["Shoutout.Read"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Read Email Marketing","scopeId":"SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING"},{"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.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","maturity":"BETA","permissions":["Shoutout.Read"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Read Email Marketing","scopeId":"SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING"},{"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.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"},"permissionScopes":[{"name":"Manage Email Marketing","scopeId":"SCOPE.DC-PROMOTE.EMAIL-MARKETING"},{"name":"Read Email Marketing","scopeId":"SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING"}]},{"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","maturity":"GA"}},{"name":"activity","in":"query","description":"__Required.__ Email activity to filter for.","required":true,"schema":{"description":"__Required.__ Email activity to filter for.","title":"activity","type":"string","$ref":"#/components/schemas/wix.emailmarketing.api.v1.RecipientsActivity.Enum","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"name":"paging","in":"query","description":"Pagination options.","required":false,"schema":{"description":"Pagination options.","$ref":"#/components/schemas/wix.emailmarketing.api.v1.upstream.wix.common.CursorPaging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"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","maturity":"BETA","permissions":["Shoutout.Read"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Read Email Marketing","scopeId":"SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING"},{"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.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","maturity":"BETA","permissions":["Shoutout.Read"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Read Email Marketing","scopeId":"SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING"},{"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.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"},"permissionScopes":[{"name":"Manage Email Marketing","scopeId":"SCOPE.DC-PROMOTE.EMAIL-MARKETING"},{"name":"Read Email Marketing","scopeId":"SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING"}]},{"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","maturity":"GA"}},{"name":"optionIncludeStatistics","in":"query","description":"Whether a returned campaign object should include `publishingData.statistics`.\nDefault: `false`","required":false,"schema":{"description":"Whether a returned campaign object should include `publishingData.statistics`.\nDefault: `false`","title":"optionIncludeStatistics","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"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","maturity":"BETA","permissions":["Shoutout.Manage"],"applicableIdentities":["APP"],"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 \"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","maturity":"BETA","permissions":["Shoutout.Manage"],"applicableIdentities":["APP"],"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 \"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"},"permissionScopes":[{"name":"Manage Email Marketing","scopeId":"SCOPE.DC-PROMOTE.EMAIL-MARKETING"}]},{"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","maturity":"GA"}}],"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","externalPermissionScopes":[],"eventType":"wix.email_marketing.v1.campaign_deleted","sourceRepo":"git@github.com:wix-private/promote-server.git"}],"serviceName":"wix.emailmarketing.api.v1.CampaignService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["Shoutout.Manage"],"applicableIdentities":["APP"],"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","externalPermissionScopes":[],"eventType":"wix.email_marketing.v1.campaign_deleted","sourceRepo":"git@github.com:wix-private/promote-server.git"}],"serviceName":"wix.emailmarketing.api.v1.CampaignService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["Shoutout.Manage"],"applicableIdentities":["APP"],"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"},"permissionScopes":[{"name":"Manage Email Marketing","scopeId":"SCOPE.DC-PROMOTE.EMAIL-MARKETING"}]},{"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":{"description":"Paging parameters.","$ref":"#/components/schemas/wix.common.Paging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"name":"optionIncludeStatistics","in":"query","description":"Whether to include `publishingData.statistics` in the returned campaign object.\nDefault: `false`","required":false,"schema":{"description":"Whether to include `publishingData.statistics` in the returned campaign object.\nDefault: `false`","title":"optionIncludeStatistics","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"name":"statuses","in":"query","description":"Include campaigns with the following statuses (no filtering by default).","required":false,"schema":{"description":"Include campaigns with the following statuses (no filtering by default).","title":"statuses","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.CampaignStatus.Enum"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"name":"visibilityStatuses","in":"query","description":"Include campaigns with the following visibility statuses (no filtering by default).","required":false,"schema":{"description":"Include campaigns with the following visibility statuses (no filtering by default).","title":"visibilityStatuses","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.CampaignVisibilityStatus.Enum"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"name":"campaignType","in":"query","description":"Filter by the following campaign types.","required":false,"schema":{"description":"Filter by the following campaign types.","title":"campaignType","type":"string","$ref":"#/components/schemas/wix.emailmarketing.api.v1.CampaignType.Enum","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"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","maturity":"BETA","permissions":["Shoutout.Manage"],"applicableIdentities":["APP"],"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 \"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","maturity":"BETA","permissions":["Shoutout.Manage"],"applicableIdentities":["APP"],"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 \"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"},"permissionScopes":[{"name":"Manage Email Marketing","scopeId":"SCOPE.DC-PROMOTE.EMAIL-MARKETING"}]},{"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","maturity":"GA"}}],"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":{"description":"Email distribution options - provided only if marketing campaign is intended to be distributed via email.","$ref":"#/components/schemas/wix.emailmarketing.api.v1.PublishCampaignRequest.EmailDistributionOptions","summary":"emailDistributionOptions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"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","externalPermissionScopes":[],"eventType":"wix.email_marketing.v1.campaign_campaign_rejected_event","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","externalPermissionScopes":[],"eventType":"wix.email_marketing.v1.campaign_campaign_published_event","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","externalPermissionScopes":[],"eventType":"wix.email_marketing.v1.campaign_campaign_terminated_event","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","externalPermissionScopes":[],"eventType":"wix.email_marketing.v1.campaign_campaign_distributed_event","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","externalPermissionScopes":[],"eventType":"wix.email_marketing.v1.campaign_email_activity_updated","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","externalPermissionScopes":[],"eventType":"wix.email_marketing.v1.campaign_campaign_scheduled_event","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","maturity":"BETA","permissions":["Shoutout.Manage"],"applicableIdentities":["APP"],"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","externalPermissionScopes":[],"eventType":"wix.email_marketing.v1.campaign_campaign_rejected_event","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","externalPermissionScopes":[],"eventType":"wix.email_marketing.v1.campaign_campaign_published_event","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","externalPermissionScopes":[],"eventType":"wix.email_marketing.v1.campaign_campaign_terminated_event","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","externalPermissionScopes":[],"eventType":"wix.email_marketing.v1.campaign_campaign_distributed_event","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","externalPermissionScopes":[],"eventType":"wix.email_marketing.v1.campaign_email_activity_updated","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","externalPermissionScopes":[],"eventType":"wix.email_marketing.v1.campaign_campaign_scheduled_event","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","maturity":"BETA","permissions":["Shoutout.Manage"],"applicableIdentities":["APP"],"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"},"permissionScopes":[{"name":"Manage Email Marketing","scopeId":"SCOPE.DC-PROMOTE.EMAIL-MARKETING"}]},{"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","maturity":"GA"}}],"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":{"description":"Subject of an email sent to recipient.","title":"emailSubject","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"toEmailAddress":{"description":"Recipient's email address.","format":"EMAIL","title":"toEmailAddress","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["campaignId","toEmailAddress"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.emailmarketing.api.v1.CampaignService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["Shoutout.Manage"],"applicableIdentities":["APP"],"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","maturity":"BETA","permissions":["Shoutout.Manage"],"applicableIdentities":["APP"],"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"},"permissionScopes":[{"name":"Manage Email Marketing","scopeId":"SCOPE.DC-PROMOTE.EMAIL-MARKETING"}]},{"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","maturity":"GA"}}],"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","externalPermissionScopes":[],"eventType":"wix.email_marketing.v1.campaign_campaign_paused_event","sourceRepo":"git@github.com:wix-private/promote-server.git"}],"serviceName":"wix.emailmarketing.api.v1.CampaignService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["Shoutout.Manage"],"applicableIdentities":["APP"],"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","externalPermissionScopes":[],"eventType":"wix.email_marketing.v1.campaign_campaign_paused_event","sourceRepo":"git@github.com:wix-private/promote-server.git"}],"serviceName":"wix.emailmarketing.api.v1.CampaignService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["Shoutout.Manage"],"applicableIdentities":["APP"],"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"},"permissionScopes":[{"name":"Manage Email Marketing","scopeId":"SCOPE.DC-PROMOTE.EMAIL-MARKETING"}]},{"summary":"Reschedule","description":"Changes the sending time for an already scheduled campaign.","operationId":"wix.emailmarketing.api.v1.CampaignService.Reschedule","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"campaignId","description":"ID of the campaign to reschedule.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.RescheduleResponse","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":"RescheduleRequest","description":"","properties":{"sendAt":{"description":"The new time for sending out the campaign.","title":"sendAt","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["campaignId","sendAt"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.emailmarketing.api.v1.CampaignService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["Shoutout.Manage"],"applicableIdentities":["APP"],"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.RescheduleRequest","responseMessage":"wix.emailmarketing.api.v1.RescheduleResponse"},"legacyExamples":[{"name":"Reschedule","serviceName":"CampaignService","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST 'https://www.wixapis.com/email-marketing/v1/campaigns/{campaign_id}/reschedule' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: '\n--d '{\n \"campaignId\": \"d699798f-dc07-4668-89f9-6db2e8ab52a3\",\n \"sendAt\": \"2024-08-14T14:43:00Z\"\n }' \\\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/promote-server.git"},"httpMethod":"post","path":"/v1/campaigns/{campaignId}/reschedule","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.emailmarketing.api.v1.CampaignService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["Shoutout.Manage"],"applicableIdentities":["APP"],"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.RescheduleRequest","responseMessage":"wix.emailmarketing.api.v1.RescheduleResponse"},"legacyExamples":[{"name":"Reschedule","serviceName":"CampaignService","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST 'https://www.wixapis.com/email-marketing/v1/campaigns/{campaign_id}/reschedule' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: '\n--d '{\n \"campaignId\": \"d699798f-dc07-4668-89f9-6db2e8ab52a3\",\n \"sendAt\": \"2024-08-14T14:43:00Z\"\n }' \\\n~~~","response":"~~~json\n{}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/promote-server.git","contentLink":{"displayName":"Reschedule","slugifiedName":"reschedule"},"permissionScopes":[{"name":"Manage Email Marketing","scopeId":"SCOPE.DC-PROMOTE.EMAIL-MARKETING"}]},{"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","maturity":"GA"}}],"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","externalPermissionScopes":[],"eventType":"wix.email_marketing.v1.campaign_created","sourceRepo":"git@github.com:wix-private/promote-server.git"}],"serviceName":"wix.emailmarketing.api.v1.CampaignService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["Shoutout.Manage"],"applicableIdentities":["APP"],"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","externalPermissionScopes":[],"eventType":"wix.email_marketing.v1.campaign_created","sourceRepo":"git@github.com:wix-private/promote-server.git"}],"serviceName":"wix.emailmarketing.api.v1.CampaignService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["Shoutout.Manage"],"applicableIdentities":["APP"],"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"},"permissionScopes":[{"name":"Manage Email Marketing","scopeId":"SCOPE.DC-PROMOTE.EMAIL-MARKETING"}]}],"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","externalPermissionScopes":[{"name":"Read Email Marketing","scopeId":"SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING"},{"name":"Manage Email Marketing","scopeId":"SCOPE.DC-PROMOTE.EMAIL-MARKETING"}],"eventType":"wix.email_marketing.v1.campaign_email_activity_updated","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 \"metadata\": {\"metadataFieldOne\": \"6b8fe9d9-bf02-42ed-9b27-77be5f6bc133\", \"metadataFieldTwo\": \"80cad016-1f36-4238-9748-2545fd374480\"}\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"]}],"permissionScopes":[{"name":"Manage Email Marketing","scopeId":"SCOPE.DC-PROMOTE.EMAIL-MARKETING"},{"name":"Read Email Marketing","scopeId":"SCOPE.DC-PROMOTE.READ-EMAIL-MARKETING"}]}],"articles":[],"components":{"schemas":{"wix.emailmarketing.api.v1.Campaign":{"type":"object","properties":{"campaignId":{"description":"Campaign ID.","format":"GUID","title":"campaignId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"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.","title":"title","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"firstImageUrl":{"description":"URL of the first image after the logo.","format":"WEB_URL","title":"firstImageUrl","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"snapshotImageUrl":{"description":"Landing page snapshot URL.
\nThis field is deprecated and snapshot images are no longer supported. Instead, use the `firstImageUrl` field.\nThe value of this field will soon become the same as the value of the `firstImageUrl` field.","format":"WEB_URL","title":"snapshotImageUrl","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{"message":"Landing page snapshot URL.
\nThis field is deprecated and snapshot images are no longer supported. Instead, use the `firstImageUrl` field.\nThe value of this field will soon become the same as the value of the `firstImageUrl` field.","replacedBy":"firstImageUrl","targetRemovalDate":"2024-12-01"}}},"editorType":{"description":"Editor type. Either web app, or mobile app.","title":"editorType","type":"string","$ref":"#/components/schemas/wix.emailmarketing.api.v1.CampaignEditorType.Enum","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"status":{"description":"Campaign status.","title":"status","type":"string","$ref":"#/components/schemas/wix.emailmarketing.api.v1.CampaignStatus.Enum","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"visibilityStatus":{"description":"Campaign visibility status.","title":"visibilityStatus","type":"string","$ref":"#/components/schemas/wix.emailmarketing.api.v1.CampaignVisibilityStatus.Enum","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"distributionStatus":{"description":"Campaign distribution status.","title":"distributionStatus","type":"string","$ref":"#/components/schemas/wix.emailmarketing.api.v1.CampaignDistributionStatus.Enum","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"publishingData":{"description":"Publishing data (present only if campaign is published).","$ref":"#/components/schemas/wix.emailmarketing.api.v1.PublishingData","summary":"publishingData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dateCreated":{"description":"Campaign creation date.","title":"dateCreated","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dateUpdated":{"description":"Campaign last update date.","title":"dateUpdated","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"emailSubject":{"description":"Email subject of the campaign (initially copied from the template).\nTODO: Deprecated (moved to \"GetComposerResponse\").","maxLength":1000,"title":"emailSubject","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}}},"title":"Campaign","description":""},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"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":{"description":"Landing page URL.","format":"WEB_URL","title":"landingPageUrl","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"statistics":{"description":"Marketing campaign statistics.","$ref":"#/components/schemas/wix.emailmarketing.api.v1.CampaignStatistics","summary":"statistics","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"datePublished":{"description":"Marketing campaign publish date.","title":"datePublished","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PublishingData","description":""},"wix.emailmarketing.api.v1.CampaignStatistics":{"type":"object","properties":{"landingPage":{"description":"Marketing campaign's landing page statistics.","$ref":"#/components/schemas/wix.emailmarketing.api.v1.LandingPageStatistics","summary":"landingPage","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"emailCampaign":{"description":"Marketing campaign's email distribution statistics.","$ref":"#/components/schemas/wix.emailmarketing.api.v1.DistributionStatistics","summary":"emailCampaign","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"total":{"description":"Combined landing page and email distribution statistics.","$ref":"#/components/schemas/wix.emailmarketing.api.v1.TotalStatistics","summary":"total","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CampaignStatistics","description":""},"wix.emailmarketing.api.v1.LandingPageStatistics":{"type":"object","properties":{"opened":{"description":"Number of times landing page was loaded or viewed.","title":"opened","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"clicked":{"description":"Number of times a link was clicked in landing page.","title":"clicked","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"LandingPageStatistics","description":""},"wix.emailmarketing.api.v1.DistributionStatistics":{"type":"object","properties":{"delivered":{"description":"Number of emails delivered.","title":"delivered","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"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.","title":"opened","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"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.","title":"clicked","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bounced":{"description":"Number of emails that bounced.","title":"bounced","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"complained":{"description":"Number of recipients who reported email as spam.","title":"complained","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"notSent":{"description":"Number of emails not sent because the campaign was terminated.","title":"notSent","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DistributionStatistics","description":""},"wix.emailmarketing.api.v1.TotalStatistics":{"type":"object","properties":{"mailsSent":{"description":"Total number of emails sent.","title":"mailsSent","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"opened":{"description":"Number of landing page views + emails opened.","title":"opened","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"clicked":{"description":"Number of landing page link clicks + email link clicks.","title":"clicked","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TotalStatistics","description":""},"google.protobuf.Timestamp":{"type":"object","properties":{"seconds":{"description":"","title":"seconds","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nanos":{"description":"","title":"nanos","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Timestamp","description":""},"wix.emailmarketing.api.v1.RejectionData":{"type":"object","properties":{"rejectionReasons":{"description":"","title":"rejectionReasons","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.RejectionReason.Enum"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"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.EstimateFilterSizeRequest":{"type":"object","properties":{"filter":{"description":"Contacts filter expression.","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"activeContactsOnly":{"description":"Should \"inactive\" contacts be excluded or not (default value \"false\").","title":"activeContactsOnly","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"search":{"description":"Contacts plain text search expression (searches in name, phone and email fields).","minLength":1,"maxLength":100,"title":"search","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EstimateFilterSizeRequest","description":""},"google.protobuf.Struct":{"type":"object","properties":{"fields":{"description":"","title":"fields","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/google.protobuf.Value"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Struct","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":{"description":"","title":"nullValue","$ref":"#/components/schemas/google.protobuf.NullValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"numberValue":{"description":"","title":"numberValue","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"stringValue":{"description":"","title":"stringValue","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"boolValue":{"description":"","title":"boolValue","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"structValue":{"description":"","title":"structValue","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"listValue":{"description":"","title":"listValue","$ref":"#/components/schemas/google.protobuf.ListValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"google.protobuf.NullValue":{"type":"string","description":"","title":"NullValue","enum":["NULL_VALUE"]},"google.protobuf.ListValue":{"type":"object","properties":{"values":{"description":"","title":"values","type":"array","items":{"$ref":"#/components/schemas/google.protobuf.Value"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListValue","description":""},"wix.emailmarketing.api.v1.EstimateFilterSizeResponse":{"type":"object","properties":{"estimation":{"description":"Mailing list size estimation.","title":"estimation","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EstimateFilterSizeResponse","description":""},"wix.emailmarketing.api.v1.EstimateAudienceSizeRequest":{"type":"object","properties":{"contactIds":{"description":"Contact IDs of a campaign audience.","format":"GUID","title":"contactIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"labelIds":{"description":"Label IDs of a campaign audience.","title":"labelIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"contactsFilter":{"description":"Contacts filter expression (json).","title":"contactsFilter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"search":{"description":"Contacts plain text search expression (searches in name, phone and email fields).","minLength":1,"maxLength":100,"title":"search","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"segmentIds":{"description":"Segment ids of a campaign audience.","format":"GUID","title":"segmentIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"activeContactsOnly":{"description":"Should \"inactive\" contacts be excluded or not (default value \"false\").","title":"activeContactsOnly","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"resendCampaignId":{"description":"Id of a campaign that is to be resent.","format":"GUID","title":"resendCampaignId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"withTotal":{"description":"Should total number of contacts in provided audience be returned or not (default value \"false\").","title":"withTotal","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EstimateAudienceSizeRequest","description":""},"wix.emailmarketing.api.v1.EstimateAudienceSizeResponse":{"type":"object","properties":{"estimation":{"description":"Audience size (estimated number of emails to be sent).","title":"estimation","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"total":{"description":"Total number of contacts in provided audience (optional).","title":"total","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EstimateAudienceSizeResponse","description":""},"google.protobuf.Int32Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int32Value","description":""},"wix.emailmarketing.api.v1.ReconcileContactRequest":{"type":"object","properties":{"emailAddress":{"description":"Email address of the contact.","format":"EMAIL","title":"emailAddress","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ReconcileContactRequest","description":""},"wix.emailmarketing.api.v1.ReconcileContactResponse":{"type":"object","properties":{"contact":{"description":"Created or retrieved contact.","$ref":"#/components/schemas/wix.emailmarketing.api.v1.Contact","summary":"contact","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ReconcileContactResponse","description":""},"wix.emailmarketing.api.v1.Contact":{"type":"object","properties":{"id":{"description":"Unique ID of the contact entity.","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"emailAddress":{"description":"Primary email address of the contact.","format":"EMAIL","title":"emailAddress","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fullName":{"description":"Full name of the contact (optional).","maxLength":100,"title":"fullName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pictureUrl":{"description":"Profile picture of the contact (optional).","format":"WEB_URL","maxLength":2048,"title":"pictureUrl","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Contact","description":""},"wix.emailmarketing.api.v1.SearchContactsRequest":{"type":"object","properties":{"searchTerm":{"description":"Text to search contacts by - can search by name or email address.","maxLength":100,"title":"searchTerm","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"activeContactsOnly":{"description":"Should \"inactive\" contacts be excluded or not (default value \"false\").","title":"activeContactsOnly","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pageSize":{"description":"Page size (default 50, max 1000).","maximum":1000,"title":"pageSize","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SearchContactsRequest","description":""},"wix.emailmarketing.api.v1.SearchContactsResponse":{"type":"object","properties":{"contacts":{"description":"Search results.","title":"contacts","type":"array","items":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.Contact"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SearchContactsResponse","description":""},"wix.emailmarketing.api.v1.GetLabelsRequest":{"type":"object","properties":{"activeContactsOnly":{"description":"Should \"inactive\" contacts be excluded or not (default value \"false\").","title":"activeContactsOnly","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetLabelsRequest","description":""},"wix.emailmarketing.api.v1.GetLabelsResponse":{"type":"object","properties":{"labels":{"description":"Returned labels with contact counts.","title":"labels","type":"array","items":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.Label"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetLabelsResponse","description":""},"wix.emailmarketing.api.v1.Label":{"type":"object","properties":{"id":{"description":"Unique ID of the label entity.","maxLength":100,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"Name of the label.","maxLength":100,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"contactsCount":{"description":"Amount of contacts assigned to the label.","title":"contactsCount","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Label","description":""},"wix.emailmarketing.api.v1.SubscribeFromLandingPageRequest":{"type":"object","properties":{"campaignId":{"description":"Campaign ID that the subscription is happening from.","format":"GUID","title":"campaignId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"emailAddress":{"description":"Email address that is entered into subscription field.","format":"EMAIL","title":"emailAddress","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"consent":{"description":"Did UoU explicitly consent to terms of use or not (optional, default value \"false\")","title":"consent","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SubscribeFromLandingPageRequest","description":""},"wix.emailmarketing.api.v1.SubscribeFromLandingPageResponse":{"type":"object","properties":{"contactId":{"description":"","format":"GUID","title":"contactId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SubscribeFromLandingPageResponse","description":""},"wix.coreservices.businessschema.v1.internal.UnprocessedTargetEvent":{"type":"object","properties":{"target":{"description":"The target that was not marked as processed","$ref":"#/components/schemas/wix.coreservices.businessschema.v1.internal.Target","summary":"target","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UnprocessedTargetEvent","description":""},"wix.coreservices.businessschema.v1.internal.Target":{"type":"object","properties":{"id":{"description":"Unique identifier of the target with pattern `id_tag_value[type]`, for example 'com.wixpress.myproto[wix_proto_bundle_export]``","minLength":1,"maxLength":100,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"location":{"description":"The unique location of the target in Bazel notation i.e @repo//path/to/target:target_name","minLength":1,"maxLength":100,"title":"location","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"combinedDigest":{"description":"The combined digest of all files within the target","minLength":1,"maxLength":100,"title":"combinedDigest","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"commitTimestamp":{"description":"The vcs commit timestamp of the target in milliseconds","title":"commitTimestamp","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"type":{"description":"The type of the target","title":"type","type":"string","$ref":"#/components/schemas/wix.coreservices.businessschema.v1.internal.TargetType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"idTagValue":{"description":"The target's id tag value in Bazel, uniquness is not guaranteed\ni.e for a tag \"businessSchemaIndexerId=com.wixpress.myproto\" the value is \"com.wixpress.myproto\"","minLength":1,"maxLength":100,"title":"idTagValue","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"files":{"description":"","maxItems":1000,"title":"files","type":"array","items":{"$ref":"#/components/schemas/wix.coreservices.businessschema.v1.internal.File"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Target","description":""},"google.protobuf.Int64Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int64Value","description":""},"wix.coreservices.businessschema.v1.internal.TargetType":{"type":"string","description":"","title":"TargetType","enum":["NONE","WIX_PROTO_BUNDLE_EXPORT","WIX_APPENDIX_BUNDLE_EXPORT","WIX_API_REGISTRY_INFO_EXPORT"]},"wix.coreservices.businessschema.v1.internal.File":{"type":"object","properties":{"name":{"description":"The name of the file including path relative to its source repo, i.e src/main/java/com/wixpress/MyClass.java","minLength":1,"maxLength":1000,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"uri":{"description":"The URI of the file","minLength":1,"maxLength":100,"title":"uri","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"digest":{"description":"The digest of the file","minLength":1,"maxLength":100,"title":"digest","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sizeInBytes":{"description":"The size of the file in bytes","title":"sizeInBytes","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"File","description":""},"wix.emailmarketing.api.v1.GetPlaceholderKeysRequest":{"type":"object","properties":{"campaignId":{"description":"Campaign ID.","format":"GUID","title":"campaignId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetPlaceholderKeysRequest","description":""},"wix.emailmarketing.api.v1.GetPlaceholderKeysResponse":{"type":"object","properties":{"placeholderKeys":{"description":"Keys of placeholders used in the campaign.","title":"placeholderKeys","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetPlaceholderKeysResponse","description":""},"wix.emailmarketing.api.v1.GetDefaultComponentsRequest":{"type":"object","properties":{},"title":"GetDefaultComponentsRequest","description":""},"wix.emailmarketing.api.v1.GetDefaultComponentsResponse":{"type":"object","properties":{"footer":{"description":"","title":"footer","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"logo":{"description":"","title":"logo","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"follow":{"description":"","title":"follow","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetDefaultComponentsResponse","description":""},"wix.common.domainevents.DomainEvent":{"type":"object","properties":{"id":{"description":"Unique event ID.\nAllows clients to ignore duplicate webhooks.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityFqdn":{"description":"Assumes actions are also always typed to an entity_type\nExample: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction","title":"entityFqdn","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"slug":{"description":"This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\nThis is although the created/updated/deleted notion is duplication of the oneof types\nExample: created/updated/deleted/started/completed/email_opened","title":"slug","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityId":{"description":"ID of the entity associated with the event.","title":"entityId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventTime":{"description":"Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z","title":"eventTime","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"triggeredByAnonymizeRequest":{"description":"Whether the event was triggered as a result of a privacy regulation application\n(for example, GDPR).","title":"triggeredByAnonymizeRequest","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originatedFrom":{"description":"If present, indicates the action that triggered the event.","title":"originatedFrom","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityEventSequence":{"description":"A sequence number defining the order of updates to the underlying entity.\nFor example, given that some entity was updated at 16:00 and than again at 16:01,\nit is guaranteed that the sequence number of the second update is strictly higher than the first.\nAs the consumer, you can use this value to ensure that you handle messages in the correct order.\nTo do so, you will need to persist this number on your end, and compare the sequence number from the\nmessage against the one you have stored. Given that the stored number is higher, you should ignore the message.","title":"entityEventSequence","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DomainEvent","description":"","oneOf":[{"description":"","summary":"body","$ref":"#/components/schemas/wix.common.domainevents.DomainEvent.body"}]},"wix.common.domainevents.DomainEvent.body":{"type":"object","title":"body","properties":{"createdEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityCreatedEvent","summary":"createdEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityUpdatedEvent","summary":"updatedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"deletedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityDeletedEvent","summary":"deletedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"actionEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.ActionEvent","summary":"actionEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.common.domainevents.EntityCreatedEvent":{"type":"object","properties":{"entityAsJson":{"description":"","title":"entityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"restoreInfo":{"description":"Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity","$ref":"#/components/schemas/wix.common.domainevents.RestoreInfo","summary":"restoreInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityCreatedEvent","description":""},"google.protobuf.BoolValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BoolValue","description":""},"wix.common.domainevents.RestoreInfo":{"type":"object","properties":{"deletedDate":{"description":"","title":"deletedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RestoreInfo","description":""},"wix.common.domainevents.EntityUpdatedEvent":{"type":"object","properties":{"currentEntityAsJson":{"description":"Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\nThis means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\nWe don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.","title":"currentEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityUpdatedEvent","description":""},"wix.common.domainevents.EntityDeletedEvent":{"type":"object","properties":{"deletedEntityAsJson":{"description":"Entity that was deleted","title":"deletedEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityDeletedEvent","description":""},"wix.common.domainevents.ActionEvent":{"type":"object","properties":{"bodyAsJson":{"description":"","title":"bodyAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ActionEvent","description":""},"com.wixpress.iptf.v1.webhooks.MessageEnvelope":{"type":"object","properties":{"instanceId":{"description":"App instance ID.","format":"GUID","title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventType":{"description":"Event type.","maxLength":150,"title":"eventType","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"identity":{"description":"The identification type and identity data.","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData","summary":"identity","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"data":{"description":"Stringify payload.","title":"data","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MessageEnvelope","description":""},"com.wixpress.iptf.v1.webhooks.IdentificationData":{"type":"object","properties":{"identityType":{"description":"","readOnly":true,"title":"identityType","type":"string","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"IdentificationData","description":"","oneOf":[{"description":"","summary":"id","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.id"}]},"com.wixpress.iptf.v1.webhooks.IdentificationData.id":{"type":"object","title":"id","properties":{"anonymousVisitorId":{"description":"ID of a site visitor that has not logged in to the site.","format":"GUID","title":"anonymousVisitorId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"memberId":{"description":"ID of a site visitor that has logged in to the site.","format":"GUID","title":"memberId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"wixUserId":{"description":"ID of a Wix user (site owner, contributor, etc.).","format":"GUID","title":"wixUserId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appId":{"description":"ID of an app.","format":"GUID","title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType":{"type":"string","description":"","title":"WebhookIdentityType","enum":["UNKNOWN","ANONYMOUS_VISITOR","MEMBER","WIX_USER","APP"]},"wix.emailmarketing.api.v1.ValidateLinkRequest":{"type":"object","properties":{"url":{"description":"web URL","minLength":1,"title":"url","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ValidateLinkRequest","description":""},"wix.emailmarketing.api.v1.ValidateLinkResponse":{"type":"object","properties":{"valid":{"description":"Whether link is valid","title":"valid","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ValidateLinkResponse","description":""},"wix.emailmarketing.api.v1.ValidateHtmlLinksRequest":{"type":"object","properties":{"html":{"description":"string containing HTML","maxLength":1000000,"title":"html","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ValidateHtmlLinksRequest","description":""},"wix.emailmarketing.api.v1.ValidateHtmlLinksResponse":{"type":"object","properties":{"blacklistedLinks":{"description":"array of blacklisted links","title":"blacklistedLinks","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ValidateHtmlLinksResponse","description":""},"wix.emailmarketing.api.v1.ListStatisticsRequest":{"type":"object","properties":{"campaignIds":{"description":"IDs of the campaigns to retrieve (max 100 campaigns).","format":"GUID","minItems":1,"maxItems":100,"title":"campaignIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListStatisticsRequest","description":""},"wix.emailmarketing.api.v1.ListStatisticsResponse":{"type":"object","properties":{"statistics":{"description":"List of statistics.","title":"statistics","type":"array","items":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.CampaignStatisticsContainer"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListStatisticsResponse","description":""},"wix.emailmarketing.api.v1.CampaignStatisticsContainer":{"type":"object","properties":{"campaignId":{"description":"Campaign ID.","format":"GUID","title":"campaignId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"landingPage":{"description":"Landing page statistics.","$ref":"#/components/schemas/wix.emailmarketing.api.v1.LandingPageStatistics","summary":"landingPage","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"email":{"description":"Email campaign statistics.","$ref":"#/components/schemas/wix.emailmarketing.api.v1.DistributionStatistics","summary":"email","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CampaignStatisticsContainer","description":""},"wix.emailmarketing.api.v1.ListRecipientsRequest":{"type":"object","properties":{"campaignId":{"description":"Campaign ID.","format":"GUID","title":"campaignId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"activity":{"description":"__Required.__ Email activity to filter for.","title":"activity","type":"string","$ref":"#/components/schemas/wix.emailmarketing.api.v1.RecipientsActivity.Enum","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"paging":{"description":"Pagination options.","$ref":"#/components/schemas/wix.emailmarketing.api.v1.upstream.wix.common.CursorPaging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListRecipientsRequest","description":""},"wix.emailmarketing.api.v1.RecipientsActivity.Enum":{"type":"string","description":"","title":"Enum","enum":["UNKNOWN","DELIVERED","OPENED","CLICKED","BOUNCED","NOT_SENT","SENT","NOT_OPENED"]},"wix.emailmarketing.api.v1.upstream.wix.common.CursorPaging":{"type":"object","properties":{"limit":{"description":"Number of items to load.","minimum":0,"maximum":1000,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"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.","title":"cursor","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorPaging","description":""},"wix.emailmarketing.api.v1.ListRecipientsResponse":{"type":"object","properties":{"recipients":{"description":"List of recipients.","title":"recipients","type":"array","items":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.CampaignRecipientDetails"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Details on the paged set of returned results.","$ref":"#/components/schemas/wix.common.PagingMetadataV2","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListRecipientsResponse","description":""},"wix.emailmarketing.api.v1.CampaignRecipientDetails":{"type":"object","properties":{"contactId":{"description":"Contact ID.","format":"GUID","title":"contactId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"lastActivityDate":{"description":"Date and time of the last activity.","title":"lastActivityDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"emailAddress":{"description":"Primary email address of the contact.","format":"EMAIL","title":"emailAddress","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fullName":{"description":"Full name of the contact (optional).","maxLength":100,"title":"fullName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"contactDeleted":{"description":"Is this contact currently deleted from the site or not.","title":"contactDeleted","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CampaignRecipientDetails","description":""},"wix.common.PagingMetadataV2":{"type":"object","properties":{"count":{"description":"Number of items returned in the response.","title":"count","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"Offset that was requested.","title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"total":{"description":"Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set.","title":"total","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"tooManyToCount":{"description":"Flag that indicates the server failed to calculate the `total` field.","title":"tooManyToCount","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursors":{"description":"Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used.","$ref":"#/components/schemas/wix.common.Cursors","summary":"cursors","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PagingMetadataV2","description":""},"wix.common.Cursors":{"type":"object","properties":{"next":{"description":"Cursor string pointing to the next page in the list of results.","maxLength":16000,"title":"next","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"prev":{"description":"Cursor pointing to the previous page in the list of results.","maxLength":16000,"title":"prev","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Cursors","description":""},"wix.emailmarketing.api.v1.GetCampaignMappingRequest":{"type":"object","properties":{"automationRuleId":{"description":"rule ID in automations","format":"GUID","title":"automationRuleId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"templateId":{"description":"template ID configured for the automation","format":"GUID","title":"templateId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetCampaignMappingRequest","description":""},"wix.emailmarketing.api.v1.GetCampaignMappingResponse":{"type":"object","properties":{"campaignId":{"description":"","format":"GUID","title":"campaignId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetCampaignMappingResponse","description":""},"wix.emailmarketing.api.v1.GetPingCampaignMappingRequest":{"type":"object","properties":{"streamId":{"description":"ping stream ID.","title":"streamId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"templateId":{"description":"template ID configured for the ping automation.","format":"GUID","title":"templateId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appDefId":{"description":"ID of the initiating vertical.","title":"appDefId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pingTemplateId":{"description":"Ping template ID.","title":"pingTemplateId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"language":{"description":"Preferred language.","format":"LANGUAGE","title":"language","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"automationRuleId":{"description":"rule ID in automations","format":"GUID","title":"automationRuleId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetPingCampaignMappingRequest","description":""},"wix.emailmarketing.api.v1.GetPingCampaignMappingResponse":{"type":"object","properties":{"campaignId":{"description":"","format":"GUID","title":"campaignId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetPingCampaignMappingResponse","description":""},"wix.emailmarketing.api.v1.QueryAutomationTemplatesRequest":{"type":"object","properties":{"query":{"description":"https://github.com/wix-private/p13n/blob/master/protos/query/src/main/proto/wix/common/query.proto","$ref":"#/components/schemas/wix.common.Query","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryAutomationTemplatesRequest","description":""},"wix.common.Query":{"type":"object","properties":{"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`","title":"filter","$ref":"#/components/schemas/google.protobuf.Value","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sort":{"description":"Sort object in the following format:\n`[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`","title":"sort","type":"array","items":{"$ref":"#/components/schemas/wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"paging":{"description":"Paging options to limit and skip the number of items.","$ref":"#/components/schemas/wix.common.Paging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"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.","title":"fields","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"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.","title":"fieldsets","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Query","description":""},"wix.common.Sorting":{"type":"object","properties":{"fieldName":{"description":"Name of the field to sort by.","maxLength":512,"title":"fieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"order":{"description":"Sort order.","title":"order","type":"string","$ref":"#/components/schemas/wix.common.SortOrder","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Sorting","description":""},"wix.common.SortOrder":{"type":"string","description":"","title":"SortOrder","enum":["ASC","DESC"]},"wix.common.Paging":{"type":"object","properties":{"limit":{"description":"Number of items to load.","minimum":0,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"Number of items to skip in the current sort order.","minimum":0,"title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Paging","description":""},"wix.emailmarketing.api.v1.QueryAutomationTemplatesResponse":{"type":"object","properties":{"entries":{"description":"","title":"entries","type":"array","items":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.AutomationTemplateContainer"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"metaData":{"description":"","$ref":"#/components/schemas/com.wixpress.actiontriggers.integrator.entities.QueryMetadata","summary":"metaData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"total":{"description":"","title":"total","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryAutomationTemplatesResponse","description":""},"wix.emailmarketing.api.v1.AutomationTemplateContainer":{"type":"object","properties":{"automationTemplate":{"description":"","$ref":"#/components/schemas/com.wixpress.actiontriggers.integrator.entities.AutomationTemplate","summary":"automationTemplate","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"enrichmentData":{"description":"","$ref":"#/components/schemas/wix.emailmarketing.api.v1.AutomationTemplateEnrichmentData","summary":"enrichmentData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AutomationTemplateContainer","description":""},"com.wixpress.actiontriggers.integrator.entities.AutomationTemplate":{"type":"object","properties":{"id":{"description":"Automation template ID (unique)","format":"GUID","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"Automation template current revision","readOnly":true,"title":"revision","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"name":{"description":"Automation template name","title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"Automation template description","title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"rule":{"description":"Automation template rule configuration","$ref":"#/components/schemas/com.wixpress.actiontriggers.integrator.entities.RuleConfiguration","summary":"rule","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"correlationId":{"description":"Automation template correlation id - TODO: rename","format":"GUID","title":"correlationId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"templateType":{"description":"Automation template type","title":"templateType","type":"string","$ref":"#/components/schemas/com.wixpress.actiontriggers.integrator.entities.AutomationTemplate.TemplateType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"preconditions":{"description":"Automation template preconditions","title":"preconditions","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.actiontriggers.integrator.entities.Precondition"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"groupIds":{"description":"used to determine which users will see the Automation template while in internal state","format":"GUID","title":"groupIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"templateState":{"description":"Automation template state","readOnly":true,"title":"templateState","type":"string","$ref":"#/components/schemas/com.wixpress.actiontriggers.integrator.entities.AutomationTemplate.TemplateState","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"createdDate":{"description":"Automation template created date","readOnly":true,"title":"createdDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedDate":{"description":"Automation template updated date","readOnly":true,"title":"updatedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"translation":{"description":"","readOnly":true,"$ref":"#/components/schemas/com.wixpress.actiontriggers.integrator.entities.Translation","summary":"translation","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"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","title":"additionalTranslations","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"type":"string"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AutomationTemplate","description":""},"com.wixpress.actiontriggers.integrator.entities.RuleConfiguration":{"type":"object","properties":{"name":{"description":"Rule configuration name","title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"Rule configuration description","title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"trigger":{"description":"Trigger configuration","$ref":"#/components/schemas/com.wixpress.actiontriggers.integrator.entities.RuleConfiguration.TriggerConfiguration","summary":"trigger","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"actions":{"description":"Actions configuration","title":"actions","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.actiontriggers.integrator.entities.RuleConfiguration.ActionConfiguration"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"ruleStatus":{"description":"Rule status","title":"ruleStatus","type":"string","$ref":"#/components/schemas/com.wixpress.actiontriggers.integrator.RuleStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"activationCycle":{"description":"Activation cycle","$ref":"#/components/schemas/com.wixpress.actiontriggers.integrator.ActivationCycle","summary":"activationCycle","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"metadata":{"description":"","$ref":"#/components/schemas/com.wixpress.actiontriggers.integrator.RuleMetadata","summary":"metadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RuleConfiguration","description":""},"com.wixpress.actiontriggers.integrator.entities.RuleConfiguration.ConditionConfiguration":{"type":"object","properties":{"schemaKey":{"description":"Condition schema key","title":"schemaKey","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"operator":{"description":"Condition operator","title":"operator","type":"string","$ref":"#/components/schemas/com.wixpress.actiontriggers.integrator.entities.RuleConfiguration.ConditionConfiguration.Operator","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"values":{"description":"Condition values","title":"values","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"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":{"description":"Trigger source app def id","title":"appDefId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"triggerName":{"description":"Trigger name","title":"triggerName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"triggerSchema":{"description":"Trigger schema","title":"triggerSchema","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"conditions":{"description":"Condition configuration","title":"conditions","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.actiontriggers.integrator.entities.RuleConfiguration.ConditionConfiguration"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"triggerConfigurationId":{"description":"TODO - might need to replace the entire object","format":"GUID","title":"triggerConfigurationId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"reengagementDelaySec":{"description":"Trigger Reengagement delay internal in sec","title":"reengagementDelaySec","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TriggerConfiguration","description":""},"com.wixpress.actiontriggers.integrator.entities.RuleConfiguration.ActionConfiguration":{"type":"object","properties":{"id":{"description":"","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appDefId":{"description":"Action source app def id","title":"appDefId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"actionName":{"description":"Action name","title":"actionName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"configuration":{"description":"Action configuration","title":"configuration","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"delayIntervalSec":{"description":"Delay interval in seconds","title":"delayIntervalSec","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"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":{"description":"set a time frame in minutes for the once_per_user attribute, use 0 for infinite","minimum":0,"title":"timeFrame","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"activations":{"description":"number of activations allowed in the given time_frame","minimum":1,"title":"activations","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"rateLimitingJsonata":{"description":"","title":"rateLimitingJsonata","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ActivationCycle","description":""},"com.wixpress.actiontriggers.integrator.RuleMetadata":{"type":"object","properties":{"canBeSuspended":{"description":"default value is 'true', when this is set to 'false' user wont be able to toggle off the rule","title":"canBeSuspended","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"notes":{"description":"additional notes to describe the rule","title":"notes","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"versionType":{"description":"will be used to indicate to user how urgent is this change during \"version\" changes","title":"versionType","type":"string","$ref":"#/components/schemas/com.wixpress.actiontriggers.integrator.RuleMetadata.VersionType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"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":{"description":"Precondition type","title":"preconditionType","type":"string","$ref":"#/components/schemas/com.wixpress.actiontriggers.integrator.entities.Precondition.PreconditionType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"key":{"description":"Precondition unique key","title":"key","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"value":{"description":"Precondition value","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fallback":{"description":"Precondition fallback","title":"fallback","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"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":{"description":"","title":"state","type":"string","$ref":"#/components/schemas/com.wixpress.actiontriggers.integrator.entities.Translation.TranslationState","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"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":{"description":"","format":"GUID","title":"campaignId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"metaSiteId":{"description":"","format":"GUID","title":"metaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AutomationTemplateEnrichmentData","description":""},"com.wixpress.actiontriggers.integrator.entities.QueryMetadata":{"type":"object","properties":{"items":{"description":"Number of returned items","title":"items","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"Offset that was applied to the request","title":"offset","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryMetadata","description":""},"wix.emailmarketing.api.v1.QueryAppTemplatesRequest":{"type":"object","properties":{"queryType":{"description":"","title":"queryType","type":"string","$ref":"#/components/schemas/wix.emailmarketing.api.v1.TemplateQueryType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"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":{"description":"","title":"template","type":"array","items":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.TemplateData"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryAppTemplatesResponse","description":""},"wix.emailmarketing.api.v1.TemplateData":{"type":"object","properties":{"templateName":{"description":"","title":"templateName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"templateId":{"description":"","format":"GUID","title":"templateId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TemplateData","description":""},"wix.emailmarketing.api.v1.CampaignLookupRequest":{"type":"object","properties":{"campaignId":{"description":"","format":"GUID","title":"campaignId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CampaignLookupRequest","description":""},"wix.emailmarketing.api.v1.CampaignLookupResponse":{"type":"object","properties":{"campaignId":{"description":"","format":"GUID","title":"campaignId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"instanceId":{"description":"","title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"metasiteId":{"description":"","title":"metasiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CampaignLookupResponse","description":""},"wix.emailmarketing.api.v1.CampaignLookupBatchRequest":{"type":"object","properties":{"campaignIds":{"description":"","title":"campaignIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CampaignLookupBatchRequest","description":""},"wix.emailmarketing.api.v1.CampaignLookupBatchResponse":{"type":"object","properties":{"responses":{"description":"","title":"responses","type":"array","items":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.CampaignLookupResponse"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CampaignLookupBatchResponse","description":""},"wix.emailmarketing.api.v1.UpsertTranslationRequest":{"type":"object","properties":{"campaignId":{"description":"Campaign ID.","format":"GUID","title":"campaignId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"composer":{"description":"Composer data.","$ref":"#/components/schemas/wix.emailmarketing.api.v1.Composer","summary":"composer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"language":{"description":"Translation language (optional, default value \"EN\").","format":"LANGUAGE","title":"language","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"automationRuleId":{"description":"For BI event [36:1031] only (optional, default value \"n/a\").","format":"GUID","title":"automationRuleId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"publish":{"description":"Should campaign also be published or not (default value \"false\").","title":"publish","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"emailSubject":{"description":"Campaign subject (optional).","maxLength":1000,"title":"emailSubject","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"emailPreheader":{"description":"Campaign preheader (optional).","maxLength":1000,"title":"emailPreheader","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpsertTranslationRequest","description":""},"wix.emailmarketing.api.v1.Composer":{"type":"object","properties":{"composerDataJson":{"description":"Internal data structure for editor/viewer to render the campaign.","maxLength":10000000,"title":"composerDataJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"defaultValues":{"description":"Default values of existing placeholders.","$ref":"#/components/schemas/wix.emailmarketing.api.v1.DefaultValues","summary":"defaultValues","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Composer","description":""},"wix.emailmarketing.api.v1.DefaultValues":{"type":"object","properties":{"map":{"description":"","maxItems":500,"title":"map","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"type":"string"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DefaultValues","description":""},"wix.emailmarketing.api.v1.UpsertTranslationResponse":{"type":"object","properties":{},"title":"UpsertTranslationResponse","description":""},"wix.emailmarketing.api.v1.GetUsedPlaceholderKeysRequest":{"type":"object","properties":{"campaignId":{"description":"Campaign ID.","format":"GUID","title":"campaignId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetUsedPlaceholderKeysRequest","description":""},"wix.emailmarketing.api.v1.GetUsedPlaceholderKeysResponse":{"type":"object","properties":{"placeholderKeys":{"description":"Keys of placeholders used in the automation.","maxLength":200,"maxItems":300,"title":"placeholderKeys","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetUsedPlaceholderKeysResponse","description":""},"wix.emailmarketing.api.v1.GetCampaignRequest":{"type":"object","properties":{"campaignId":{"description":"Campaign ID.","format":"GUID","title":"campaignId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"optionIncludeStatistics":{"description":"Whether a returned campaign object should include `publishingData.statistics`.\nDefault: `false`","title":"optionIncludeStatistics","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetCampaignRequest","description":""},"wix.emailmarketing.api.v1.GetCampaignResponse":{"type":"object","properties":{"campaign":{"description":"Campaign information.","$ref":"#/components/schemas/wix.emailmarketing.api.v1.Campaign","summary":"campaign","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetCampaignResponse","description":""},"wix.emailmarketing.api.v1.ListCampaignsRequest":{"type":"object","properties":{"paging":{"description":"Paging parameters.","$ref":"#/components/schemas/wix.common.Paging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"optionIncludeStatistics":{"description":"Whether to include `publishingData.statistics` in the returned campaign object.\nDefault: `false`","title":"optionIncludeStatistics","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"statuses":{"description":"Include campaigns with the following statuses (no filtering by default).","title":"statuses","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.CampaignStatus.Enum"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"visibilityStatuses":{"description":"Include campaigns with the following visibility statuses (no filtering by default).","title":"visibilityStatuses","type":"array","enum":true,"items":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.CampaignVisibilityStatus.Enum"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"campaignType":{"description":"Filter by the following campaign types.","title":"campaignType","type":"string","$ref":"#/components/schemas/wix.emailmarketing.api.v1.CampaignType.Enum","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListCampaignsRequest","description":""},"wix.emailmarketing.api.v1.ListCampaignsResponse":{"type":"object","properties":{"paging":{"description":"Paging parameters.","$ref":"#/components/schemas/wix.common.Paging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"campaigns":{"description":"List of campaigns.","title":"campaigns","type":"array","items":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.Campaign"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListCampaignsResponse","description":""},"wix.emailmarketing.api.v1.CountCampaignsRequest":{"type":"object","properties":{"dateFrom":{"description":"Since when should we start counting (optional, default value \"1970-01-01T00:00:00.000Z\")","title":"dateFrom","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CountCampaignsRequest","description":""},"wix.emailmarketing.api.v1.CountCampaignsResponse":{"type":"object","properties":{"total":{"description":"\"drafts\" + \"scheduled\" + \"published\" (excluding \"archived\").","title":"total","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"drafts":{"description":"Non published (draft) campaigns.","title":"drafts","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"scheduled":{"description":"Campaigns scheduled for publishing in the future.","title":"scheduled","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"published":{"description":"Campaigns published or sent.","title":"published","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"archived":{"description":"Campaigns moved to archive (regardless of the status).","title":"archived","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CountCampaignsResponse","description":""},"wix.emailmarketing.api.v1.CreateFromTemplateRequest":{"type":"object","properties":{"templateId":{"description":"ID of the template to fork.","format":"GUID","title":"templateId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"variables":{"description":"Values to replace template placeholders with (unique for each template).","title":"variables","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"type":"string"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"campaignType":{"description":"Campaign type.","title":"campaignType","type":"string","$ref":"#/components/schemas/wix.emailmarketing.api.v1.CampaignType.Enum","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"campaignEditorType":{"description":"Campaign editor type. Either web app or mobile app.","title":"campaignEditorType","type":"string","$ref":"#/components/schemas/wix.emailmarketing.api.v1.CampaignEditorType.Enum","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateFromTemplateRequest","description":""},"wix.emailmarketing.api.v1.CreateFromTemplateResponse":{"type":"object","properties":{"campaign":{"description":"Campaign information.","$ref":"#/components/schemas/wix.emailmarketing.api.v1.Campaign","summary":"campaign","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateFromTemplateResponse","description":""},"wix.emailmarketing.api.v1.CreateUserTemplateRequest":{"type":"object","properties":{"campaignId":{"description":"ID of campaign to create template from.","format":"GUID","title":"campaignId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"title":{"description":"Title of template.","maxLength":1000,"title":"title","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateUserTemplateRequest","description":""},"wix.emailmarketing.api.v1.CreateUserTemplateResponse":{"type":"object","properties":{"campaign":{"description":"Created user template information.","$ref":"#/components/schemas/wix.emailmarketing.api.v1.Campaign","summary":"campaign","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateUserTemplateResponse","description":""},"wix.emailmarketing.api.v1.CreateFromUserTemplateRequest":{"type":"object","properties":{"campaignId":{"description":"ID of the user template campaign to use.","format":"GUID","title":"campaignId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateFromUserTemplateRequest","description":""},"wix.emailmarketing.api.v1.CreateFromUserTemplateResponse":{"type":"object","properties":{"campaign":{"description":"Campaign created from user template.","$ref":"#/components/schemas/wix.emailmarketing.api.v1.Campaign","summary":"campaign","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateFromUserTemplateResponse","description":""},"wix.emailmarketing.api.v1.PublishCampaignRequest":{"type":"object","properties":{"campaignId":{"description":"Campaign ID","format":"GUID","title":"campaignId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"emailDistributionOptions":{"description":"Email distribution options - provided only if marketing campaign is intended to be distributed via email.","$ref":"#/components/schemas/wix.emailmarketing.api.v1.PublishCampaignRequest.EmailDistributionOptions","summary":"emailDistributionOptions","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PublishCampaignRequest","description":""},"wix.emailmarketing.api.v1.PublishCampaignRequest.EmailDistributionOptions":{"type":"object","properties":{"emailSubject":{"description":"Subject of an email sent to recipient.","title":"emailSubject","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"labelIds":{"description":"Label IDs to send campaign to.","title":"labelIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"contactIds":{"description":"Contact IDs to send campaign to.","format":"GUID","title":"contactIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"filterIds":{"description":"Filter ids to send campaign to (unsupported).","format":"GUID","title":"filterIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{"message":"Filter ids to send campaign to (unsupported).","replacedBy":"contacts_filter","targetRemovalDate":"2023-10-10"}}},"sendAt":{"description":"For scheduling (at least one hour in the future, for premium users only).","title":"sendAt","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EmailDistributionOptions","description":""},"wix.emailmarketing.api.v1.PublishCampaignResponse":{"type":"object","properties":{"publishingData":{"description":"`publishingData.statistics` will be empty.","$ref":"#/components/schemas/wix.emailmarketing.api.v1.PublishingData","summary":"publishingData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PublishCampaignResponse","description":""},"wix.emailmarketing.api.v1.CampaignRejectedEvent":{"type":"object","properties":{"campaignId":{"description":"ID of the campaign that was rejected.","format":"GUID","title":"campaignId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CampaignRejectedEvent","description":""},"wix.emailmarketing.api.v1.CampaignPublishedEvent":{"type":"object","properties":{"campaignId":{"description":"ID of the campaign that was published.","format":"GUID","title":"campaignId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"landingPageUrl":{"description":"Campaign landing page URL.","title":"landingPageUrl","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"mailingListSizeEstimate":{"description":"Estimation of recipient list size (optional).","title":"mailingListSizeEstimate","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CampaignPublishedEvent","description":""},"wix.emailmarketing.api.v1.CampaignTerminatedEvent":{"type":"object","properties":{"campaignId":{"description":"ID of the campaign that was terminated.","format":"GUID","title":"campaignId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CampaignTerminatedEvent","description":""},"wix.emailmarketing.api.v1.CampaignDistributedEvent":{"type":"object","properties":{"campaignId":{"description":"ID of the campaign that was distributed.","format":"GUID","title":"campaignId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CampaignDistributedEvent","description":""},"wix.emailmarketing.api.v1.EmailActivityUpdated":{"type":"object","properties":{"campaignId":{"description":"Campaign ID.","format":"GUID","title":"campaignId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"contactId":{"description":"[Contact ID](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-object) of recipient.","format":"GUID","title":"contactId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"recipientEmailAddress":{"description":"Email address of recipient.","format":"EMAIL","title":"recipientEmailAddress","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"timestamp":{"description":"Date and time of the event.","title":"timestamp","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"activityType":{"description":"","title":"activityType","type":"string","$ref":"#/components/schemas/wix.emailmarketing.api.v1.EmailActivityUpdated.ActivityType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"metadata":{"description":"email metadata","maxItems":20,"title":"metadata","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"type":"string"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"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":{"description":"","$ref":"#/components/schemas/wix.emailmarketing.api.v1.EmailActivityUpdated.Click","summary":"click","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"open":{"description":"Recipient opened an email.","$ref":"#/components/schemas/wix.emailmarketing.api.v1.EmailActivityUpdated.Open","summary":"open","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"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.","$ref":"#/components/schemas/wix.emailmarketing.api.v1.EmailActivityUpdated.SoftBounce","summary":"softBounce","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"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.","$ref":"#/components/schemas/wix.emailmarketing.api.v1.EmailActivityUpdated.HardBounce","summary":"hardBounce","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"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":{"description":"URL that was clicked.","title":"url","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"userAgent":{"description":"Browser user agent of the recipient.","title":"userAgent","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Click","description":""},"wix.emailmarketing.api.v1.EmailActivityUpdated.Open":{"type":"object","properties":{"userAgent":{"description":"Browser user agent of the recipient.","title":"userAgent","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Open","description":""},"wix.emailmarketing.api.v1.EmailActivityUpdated.SoftBounce":{"type":"object","properties":{"reason":{"description":"Reason the email soft bounced.","title":"reason","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SoftBounce","description":""},"wix.emailmarketing.api.v1.EmailActivityUpdated.HardBounce":{"type":"object","properties":{"reason":{"description":"Reason the email hard bounced.","title":"reason","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"HardBounce","description":""},"wix.emailmarketing.api.v1.CampaignScheduledEvent":{"type":"object","properties":{"campaignId":{"description":"ID of the campaign that was scheduled.","format":"GUID","title":"campaignId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sendAt":{"description":"The timestamp campaign is scheduled for.","title":"sendAt","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CampaignScheduledEvent","description":""},"wix.emailmarketing.api.v1.SendTestRequest":{"type":"object","properties":{"campaignId":{"description":"Campaign ID.","format":"GUID","title":"campaignId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"emailSubject":{"description":"Subject of an email sent to recipient.","title":"emailSubject","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"toEmailAddress":{"description":"Recipient's email address.","format":"EMAIL","title":"toEmailAddress","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"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":{"description":"","$ref":"#/components/schemas/wix.emailmarketing.api.v1.PlaceholderContent.PlainText","summary":"text","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"html":{"description":"","$ref":"#/components/schemas/wix.emailmarketing.api.v1.PlaceholderContent.Html","summary":"html","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"money":{"description":"","$ref":"#/components/schemas/wix.common.Money","summary":"money","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dateTime":{"description":"","$ref":"#/components/schemas/wix.emailmarketing.api.v1.PlaceholderContent.DateTime","summary":"dateTime","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"map":{"description":"","$ref":"#/components/schemas/wix.emailmarketing.api.v1.PlaceholderContent.Map","summary":"map","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"array":{"description":"","$ref":"#/components/schemas/wix.emailmarketing.api.v1.PlaceholderContent.Array","summary":"array","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"enum":{"description":"","$ref":"#/components/schemas/wix.emailmarketing.api.v1.PlaceholderContent.Enum","summary":"enum","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"attachment":{"description":"","$ref":"#/components/schemas/wix.emailmarketing.api.v1.PlaceholderContent.Attachment","summary":"attachment","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"integer":{"description":"","$ref":"#/components/schemas/wix.emailmarketing.api.v1.PlaceholderContent.Integer","summary":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"decimal":{"description":"","$ref":"#/components/schemas/wix.emailmarketing.api.v1.PlaceholderContent.Decimal","summary":"decimal","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.emailmarketing.api.v1.PlaceholderContent.PlainText":{"type":"object","properties":{"text":{"description":"","title":"text","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PlainText","description":""},"wix.emailmarketing.api.v1.PlaceholderContent.Html":{"type":"object","properties":{"html":{"description":"","title":"html","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Html","description":""},"wix.common.Money":{"type":"object","properties":{"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","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"currency":{"description":"Currency code. Must be valid ISO 4217 currency code (e.g., USD).","format":"CURRENCY","title":"currency","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"formattedValue":{"description":"Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative.","title":"formattedValue","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"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":{"description":"","title":"timestamp","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"timeZone":{"description":"optional time zone is the full name. example: \"Asia/Jerusalem\"","title":"timeZone","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DateTime","description":""},"wix.emailmarketing.api.v1.PlaceholderContent.Map":{"type":"object","properties":{"variables":{"description":"","title":"variables","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.PlaceholderContent"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Map","description":""},"wix.emailmarketing.api.v1.PlaceholderContent.Array":{"type":"object","properties":{"items":{"description":"","title":"items","type":"array","items":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.PlaceholderContent"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Array","description":""},"wix.emailmarketing.api.v1.PlaceholderContent.Enum":{"type":"object","properties":{"value":{"description":"","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"translation":{"description":"","title":"translation","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Enum","description":""},"wix.emailmarketing.api.v1.PlaceholderContent.Attachment":{"type":"object","properties":{"fileName":{"description":"","title":"fileName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"downloadUrl":{"description":"","title":"downloadUrl","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Attachment","description":""},"wix.emailmarketing.api.v1.PlaceholderContent.Integer":{"type":"object","properties":{"value":{"description":"min value: -2147483648, max value: 2147483647","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Integer","description":""},"wix.emailmarketing.api.v1.PlaceholderContent.Decimal":{"type":"object","properties":{"value":{"description":"when converted from Double, has a limitation of max 16 digits (including fractional part)\nhighest possible value for precise representation is 9999999999999998 (9999999999999999 is represented as 10000000000000000)","format":"DECIMAL_VALUE","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Decimal","description":""},"wix.emailmarketing.api.v1.SendTestResponse":{"type":"object","properties":{},"title":"SendTestResponse","description":""},"wix.emailmarketing.api.v1.PauseSchedulingRequest":{"type":"object","properties":{"campaignId":{"description":"Campaign ID.","format":"GUID","title":"campaignId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PauseSchedulingRequest","description":""},"wix.emailmarketing.api.v1.PauseSchedulingResponse":{"type":"object","properties":{},"title":"PauseSchedulingResponse","description":""},"wix.emailmarketing.api.v1.CampaignPausedEvent":{"type":"object","properties":{"campaignId":{"description":"ID of the campaign that was paused.","format":"GUID","title":"campaignId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CampaignPausedEvent","description":""},"wix.emailmarketing.api.v1.RescheduleRequest":{"type":"object","properties":{"campaignId":{"description":"ID of the campaign to reschedule.","format":"GUID","title":"campaignId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sendAt":{"description":"The new time for sending out the campaign.","title":"sendAt","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RescheduleRequest","description":""},"wix.emailmarketing.api.v1.RescheduleResponse":{"type":"object","properties":{},"title":"RescheduleResponse","description":""},"wix.emailmarketing.api.v1.ArchiveCampaignRequest":{"type":"object","properties":{"campaignId":{"description":"ID of the campaign to archive.","format":"GUID","title":"campaignId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ArchiveCampaignRequest","description":""},"wix.emailmarketing.api.v1.ArchiveCampaignResponse":{"type":"object","properties":{},"title":"ArchiveCampaignResponse","description":""},"wix.emailmarketing.api.v1.CampaignArchivedEvent":{"type":"object","properties":{"campaignId":{"description":"ID of the campaign that was archived.","format":"GUID","title":"campaignId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CampaignArchivedEvent","description":"Sent when status of the campaign is changed from \"Active\" to \"Archived\""},"wix.emailmarketing.api.v1.UnarchiveCampaignRequest":{"type":"object","properties":{"campaignId":{"description":"ID of the campaign to unarchive.","format":"GUID","title":"campaignId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UnarchiveCampaignRequest","description":""},"wix.emailmarketing.api.v1.UnarchiveCampaignResponse":{"type":"object","properties":{},"title":"UnarchiveCampaignResponse","description":""},"wix.emailmarketing.api.v1.CampaignUnarchivedEvent":{"type":"object","properties":{"campaignId":{"description":"ID of the campaign whose status was changed to active.","format":"GUID","title":"campaignId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CampaignUnarchivedEvent","description":"Sent when status of the campaign is changed from \"Archived\" to \"Active\""},"wix.emailmarketing.api.v1.UpdateTitleRequest":{"type":"object","properties":{"campaignId":{"description":"ID of the campaign to change title of.","format":"GUID","title":"campaignId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"title":{"description":"","maxLength":1000,"title":"title","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateTitleRequest","description":""},"wix.emailmarketing.api.v1.UpdateTitleResponse":{"type":"object","properties":{},"title":"UpdateTitleResponse","description":""},"wix.emailmarketing.api.v1.DeleteCampaignRequest":{"type":"object","properties":{"campaignId":{"description":"Campaign ID.","format":"GUID","title":"campaignId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteCampaignRequest","description":""},"wix.emailmarketing.api.v1.DeleteCampaignResponse":{"type":"object","properties":{},"title":"DeleteCampaignResponse","description":""},"wix.emailmarketing.api.v1.ReuseCampaignRequest":{"type":"object","properties":{"campaignId":{"description":"ID of the message to be duplicated.","format":"GUID","title":"campaignId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ReuseCampaignRequest","description":""},"wix.emailmarketing.api.v1.ReuseCampaignResponse":{"type":"object","properties":{"campaign":{"description":"Campaign information.","$ref":"#/components/schemas/wix.emailmarketing.api.v1.Campaign","summary":"campaign","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ReuseCampaignResponse","description":""},"wix.emailmarketing.api.v1.PreviewCampaignRequest":{"type":"object","properties":{"campaignId":{"description":"ID of the campaign to preview.","format":"GUID","title":"campaignId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"language":{"description":"Preferred language for campaign content (optional).","format":"LANGUAGE","title":"language","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"placeholders":{"description":"Values to replace campaign placeholders with (unique for each campaign).","title":"placeholders","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/wix.emailmarketing.api.v1.PlaceholderContent"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"forceHideAd":{"description":"Whether to hide the ad (default value \"false\").","title":"forceHideAd","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PreviewCampaignRequest","description":""},"wix.emailmarketing.api.v1.PreviewCampaignResponse":{"type":"object","properties":{"html":{"description":"Preview HTML.","title":"html","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PreviewCampaignResponse","description":""},"wix.emailmarketing.api.v1.GetComposerRequest":{"type":"object","properties":{"campaignId":{"description":"Campaign ID.","format":"GUID","title":"campaignId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"language":{"description":"Preferred language for campaign content (optional).","format":"LANGUAGE","title":"language","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetComposerRequest","description":""},"wix.emailmarketing.api.v1.GetComposerResponse":{"type":"object","properties":{"composer":{"description":"Composer.","$ref":"#/components/schemas/wix.emailmarketing.api.v1.Composer","summary":"composer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"emailSubject":{"description":"Campaign subject.","maxLength":1000,"title":"emailSubject","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"emailPreheader":{"description":"Campaign preheader (optional).","maxLength":1000,"title":"emailPreheader","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetComposerResponse","description":""},"wix.emailmarketing.api.v1.UpdateComposerRequest":{"type":"object","properties":{"campaignId":{"description":"Campaign ID.","format":"GUID","title":"campaignId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"composer":{"description":"Campaign composer.","$ref":"#/components/schemas/wix.emailmarketing.api.v1.Composer","summary":"composer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"campaignEditorType":{"description":"Campaign editor type. Either web app or mobile app (optional, default \"Web\").","$ref":"#/components/schemas/wix.emailmarketing.api.v1.CampaignEditorType","summary":"campaignEditorType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"emailSubject":{"description":"Campaign subject (optional).","maxLength":1000,"title":"emailSubject","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"emailPreheader":{"description":"Campaign preheader (optional).","maxLength":1000,"title":"emailPreheader","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateComposerRequest","description":""},"wix.emailmarketing.api.v1.CampaignEditorType":{"type":"object","properties":{"value":{"description":"","title":"value","type":"string","$ref":"#/components/schemas/wix.emailmarketing.api.v1.CampaignEditorType.Enum","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CampaignEditorType","description":"specifies if campaign is being created and edited in web or mobile app"},"wix.emailmarketing.api.v1.UpdateComposerResponse":{"type":"object","properties":{},"title":"UpdateComposerResponse","description":""},"wix.emailmarketing.api.v1.CreateCampaignRequest":{"type":"object","properties":{"composer":{"description":"Campaign composer.","$ref":"#/components/schemas/wix.emailmarketing.api.v1.Composer","summary":"composer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"campaignEditorType":{"description":"Campaign editor type. Either web app or mobile app (optional, default \"Web\").","$ref":"#/components/schemas/wix.emailmarketing.api.v1.CampaignEditorType","summary":"campaignEditorType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateCampaignRequest","description":""},"wix.emailmarketing.api.v1.CreateCampaignResponse":{"type":"object","properties":{"campaign":{"description":"Campaign information.","$ref":"#/components/schemas/wix.emailmarketing.api.v1.Campaign","summary":"campaign","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateCampaignResponse","description":""},"wix.emailmarketing.api.v1.ResendToNonOpenersRequest":{"type":"object","properties":{"campaignId":{"description":"ID of the campaign to resend.","format":"GUID","title":"campaignId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"emailSubject":{"description":"Subject line to use with the resent copy of campaign.","title":"emailSubject","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ResendToNonOpenersRequest","description":""},"wix.emailmarketing.api.v1.ResendToNonOpenersResponse":{"type":"object","properties":{"campaignId":{"description":"ID of the newly created and resent campaign.","format":"GUID","title":"campaignId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ResendToNonOpenersResponse","description":""}}},"title":"Campaign","description":"","fqdn":"wix.email_marketing.v1.campaign"},"articles":[]},"reviewStatus":"APPROVED","isLocked":true,"metadata":{"packageVersion":""}}

Reschedule

Permission Scopes