{"id":"6d7307b8-c542-4880-ab5f-d75ca84937b3","createdDate":"2023-08-17T13:31:46.698Z","updatedDate":"2023-08-17T13:31:46.698Z","resourceId":"f6b4c41b-1dee-4fa0-985e-dfc8d1b2918e","api":{"schema":{"object":{"displayName":"Properties Object","description":"","slug":"properties-object","$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.Properties","legacyExamples":[],"sourceRepo":"git@github.com:wix-private/wixos.git"},"methods":[{"summary":"Get Site Properties","description":"Retrieves a current snapshot of a site's properties.","operationId":"com.wixpress.siteproperties.api.v4.SitePropertiesV4.Read","parameters":[{"name":"fields","in":"query","description":"The set of desired fields.","required":false,"schema":{"title":"fields","description":"The set of desired fields.","$ref":"#/components/schemas/google.protobuf.FieldMask","x-wix-docs":{"exposure":"PUBLIC"}}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.PropertiesReadResponse","description":"The resulting properties for the requested site."}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/site-properties/v4/properties","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/site-properties/v4/properties","destinationPath":"/v4/properties","url":"www.wixapis.com"}},{"url":"https://www.wixapis.com/site-properties","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/site-properties","destinationPath":"","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.siteproperties.api.v4.SitePropertiesV4","errors":[{"httpCode":403,"statusCode":"PERMISSION_DENIED","applicationCode":"PERMISSION_DENIED"},{"httpCode":401,"statusCode":"UNAUTHENTICATED","applicationCode":"META_SITE_NOT_FOUND"}],"exposure":"PUBLIC","permissions":["SITE_SETTINGS.VIEW"],"externalPermissionScopes":[{"name":"Manage Your App","scopeId":"SCOPE.DC.MANAGE-YOUR-APP"}],"protoArtifactId":"com.wixpress.siteproperties:site-properties-api-proto","serviceArtifactId":"com.wixpress.siteproperties.site-properties-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.siteproperties.api.v4.PropertiesReadRequest","responseMessage":"com.wixpress.siteproperties.api.v4.PropertiesReadResponse"},"legacyExamples":[{"name":"Read","type":"METHOD","order":2,"content":{"title":"Example with Fieldmask","request":"curl -X GET \\\n 'https://www.wixapis.com/site-properties/v4/properties?fields.paths=locale&fields.paths=businessName'\n -H 'Authorization: '","response":"{\n \"version\": \"207\",\n \"properties\": {\n \"locale\": {\n \"languageCode\": \"en\",\n \"country\": \"US\"\n },\n \"businessName\": \"My Business Name\",\n }\n}"}},{"name":"Read","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X GET \\\n 'https://www.wixapis.com/site-properties/v4/properties'\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"version\": \"207\",\n \"properties\": {\n \"categories\": {\n \"primary\": \"business\",\n \"secondary\": [\n \"services-maintenance\"\n ]\n },\n \"locale\": {\n \"languageCode\": \"en\",\n \"country\": \"US\"\n },\n \"language\": \"en\",\n \"paymentCurrency\": \"USD\",\n \"timeZone\": \"Asia/Jerusalem\",\n \"email\": \"useremail@domain.com\",\n \"phone\": \"+18008000000\",\n \"fax\": \"12345678\",\n \"address\": {\n \"street\": \"\",\n \"city\": \"New York\",\n \"country\": \"US\",\n \"state\": \"NY\",\n \"zip\": \"10036\",\n \"isPhysical\": true,\n \"googleFormattedAddress\": \"Times Square, Manhattan, NY, USA\",\n \"streetNumber\": \"\",\n \"apartmentNumber\": \"\",\n \"coordinates\": {\n \"latitude\": 40.7579747,\n \"longitude\": -73.9855426\n }\n },\n \"siteDisplayName\": \"My Site Display Name\",\n \"businessName\": \"My Business Name\",\n \"businessConfig\": \"fitness\",\n \"logo\": \"663051_3dd7332ef233f245419432ffba703a4370~mv2.jpg\",\n \"description\": \"This is a site for my business\",\n \"businessSchedule\": {\n \"periods\": [\n {\n \"openDay\": \"MONDAY\",\n \"openTime\": \"10:20\",\n \"closeDay\": \"MONDAY\",\n \"closeTime\": \"23:00\"\n },\n {\n \"openDay\": \"TUESDAY\",\n \"openTime\": \"10:20\",\n \"closeDay\": \"TUESDAY\",\n \"closeTime\": \"23:00\"\n },\n {\n \"openDay\": \"WEDNESDAY\",\n \"openTime\": \"10:20\",\n \"closeDay\": \"WEDNESDAY\",\n \"closeTime\": \"23:00\"\n },\n {\n \"openDay\": \"THURSDAY\",\n \"openTime\": \"10:20\",\n \"closeDay\": \"THURSDAY\",\n \"closeTime\": \"23:00\"\n },\n {\n \"openDay\": \"FRIDAY\",\n \"openTime\": \"10:20\",\n \"closeDay\": \"FRIDAY\",\n \"closeTime\": \"23:00\"\n },\n {\n \"openDay\": \"SATURDAY\",\n \"openTime\": \"10:20\",\n \"closeDay\": \"SATURDAY\",\n \"closeTime\": \"23:00\"\n }\n ],\n \"specialHourPeriod\": [\n~~~"}}],"sourceRepo":"git@github.com:wix-private/wixos.git"},"httpMethod":"get","path":"/v4/properties","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.siteproperties.api.v4.SitePropertiesV4","errors":[{"httpCode":403,"statusCode":"PERMISSION_DENIED","applicationCode":"PERMISSION_DENIED"},{"httpCode":401,"statusCode":"UNAUTHENTICATED","applicationCode":"META_SITE_NOT_FOUND"}],"exposure":"PUBLIC","permissions":["SITE_SETTINGS.VIEW"],"externalPermissionScopes":[{"name":"Manage Your App","scopeId":"SCOPE.DC.MANAGE-YOUR-APP"}],"protoArtifactId":"com.wixpress.siteproperties:site-properties-api-proto","serviceArtifactId":"com.wixpress.siteproperties.site-properties-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.siteproperties.api.v4.PropertiesReadRequest","responseMessage":"com.wixpress.siteproperties.api.v4.PropertiesReadResponse"},"legacyExamples":[{"name":"Read","type":"METHOD","order":2,"content":{"title":"Example with Fieldmask","request":"curl -X GET \\\n 'https://www.wixapis.com/site-properties/v4/properties?fields.paths=locale&fields.paths=businessName'\n -H 'Authorization: '","response":"{\n \"version\": \"207\",\n \"properties\": {\n \"locale\": {\n \"languageCode\": \"en\",\n \"country\": \"US\"\n },\n \"businessName\": \"My Business Name\",\n }\n}"}},{"name":"Read","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X GET \\\n 'https://www.wixapis.com/site-properties/v4/properties'\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"version\": \"207\",\n \"properties\": {\n \"categories\": {\n \"primary\": \"business\",\n \"secondary\": [\n \"services-maintenance\"\n ]\n },\n \"locale\": {\n \"languageCode\": \"en\",\n \"country\": \"US\"\n },\n \"language\": \"en\",\n \"paymentCurrency\": \"USD\",\n \"timeZone\": \"Asia/Jerusalem\",\n \"email\": \"useremail@domain.com\",\n \"phone\": \"+18008000000\",\n \"fax\": \"12345678\",\n \"address\": {\n \"street\": \"\",\n \"city\": \"New York\",\n \"country\": \"US\",\n \"state\": \"NY\",\n \"zip\": \"10036\",\n \"isPhysical\": true,\n \"googleFormattedAddress\": \"Times Square, Manhattan, NY, USA\",\n \"streetNumber\": \"\",\n \"apartmentNumber\": \"\",\n \"coordinates\": {\n \"latitude\": 40.7579747,\n \"longitude\": -73.9855426\n }\n },\n \"siteDisplayName\": \"My Site Display Name\",\n \"businessName\": \"My Business Name\",\n \"businessConfig\": \"fitness\",\n \"logo\": \"663051_3dd7332ef233f245419432ffba703a4370~mv2.jpg\",\n \"description\": \"This is a site for my business\",\n \"businessSchedule\": {\n \"periods\": [\n {\n \"openDay\": \"MONDAY\",\n \"openTime\": \"10:20\",\n \"closeDay\": \"MONDAY\",\n \"closeTime\": \"23:00\"\n },\n {\n \"openDay\": \"TUESDAY\",\n \"openTime\": \"10:20\",\n \"closeDay\": \"TUESDAY\",\n \"closeTime\": \"23:00\"\n },\n {\n \"openDay\": \"WEDNESDAY\",\n \"openTime\": \"10:20\",\n \"closeDay\": \"WEDNESDAY\",\n \"closeTime\": \"23:00\"\n },\n {\n \"openDay\": \"THURSDAY\",\n \"openTime\": \"10:20\",\n \"closeDay\": \"THURSDAY\",\n \"closeTime\": \"23:00\"\n },\n {\n \"openDay\": \"FRIDAY\",\n \"openTime\": \"10:20\",\n \"closeDay\": \"FRIDAY\",\n \"closeTime\": \"23:00\"\n },\n {\n \"openDay\": \"SATURDAY\",\n \"openTime\": \"10:20\",\n \"closeDay\": \"SATURDAY\",\n \"closeTime\": \"23:00\"\n }\n ],\n \"specialHourPeriod\": [\n~~~"}}],"sourceRepo":"git@github.com:wix-private/wixos.git","contentLink":{"displayName":"Get Site Properties","slugifiedName":"get-site-properties"},"permissionScopes":[{"name":"Manage Your App","scopeId":"SCOPE.DC.MANAGE-YOUR-APP"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"Update Business Profile","description":"Updates a site's business profile.","operationId":"com.wixpress.siteproperties.api.v4.SitePropertiesV4.UpdateBusinessProfile","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.UpdateBusinessProfileResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/site-properties/v4/properties","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/site-properties/v4/properties","destinationPath":"/v4/properties","url":"www.wixapis.com"}},{"url":"https://www.wixapis.com/site-properties","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/site-properties","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateBusinessProfileRequest","description":"","properties":{"businessProfile":{"$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.BusinessProfileData","summary":"businessProfile","description":"The site's business profile.","x-wix-docs":{"exposure":"PUBLIC"}},"fields":{"title":"fields","description":"The properties of `businessProfile` to be updated. Properties not explicitly specified here are ignored. Properties included here but excluded from `businessProfile` are cleared.","$ref":"#/components/schemas/google.protobuf.FieldMask","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.siteproperties.api.v4.SitePropertiesV4","errors":[{"httpCode":403,"statusCode":"PERMISSION_DENIED","applicationCode":"PERMISSION_DENIED"},{"httpCode":401,"statusCode":"UNAUTHENTICATED","applicationCode":"META_SITE_NOT_FOUND"}],"exposure":"PUBLIC","permissions":["SITE_PROPERTIES.UPDATE_BUSINESS_PROFILE"],"externalPermissionScopes":[{"name":"Manage Business Profile","scopeId":"SCOPE.DC-SITEPROP.MANAGE-BUSINESS-PROFILE"}],"protoArtifactId":"com.wixpress.siteproperties:site-properties-api-proto","serviceArtifactId":"com.wixpress.siteproperties.site-properties-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.siteproperties.api.v4.UpdateBusinessProfileRequest","responseMessage":"com.wixpress.siteproperties.api.v4.UpdateBusinessProfileResponse"},"legacyExamples":[{"name":"UpdateBusinessProfile","type":"METHOD","content":{"title":"Update site business profile","request":"curl -X POST \\\n 'https://www.wixapis.com/site-properties/v4/properties/business-profile'\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"businessProfile\": {\n \"siteDisplayName\": \"My Site Display Name\",\n \"businessName\": \"My Business Name\",\n \"logo\": \"663051_3dd7332ef233f245419432ffba703a4370~mv2.jpg\",\n \"description\": \"This is a site for my business\",\n },\n \"fields\": {\n \"paths\":[\"siteDisplayName\",\"businessName\",\"logo\",\"description\"]\n }\n }'"}}],"sourceRepo":"git@github.com:wix-private/wixos.git"},"httpMethod":"post","path":"/v4/properties/business-profile","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.siteproperties.api.v4.SitePropertiesV4","errors":[{"httpCode":403,"statusCode":"PERMISSION_DENIED","applicationCode":"PERMISSION_DENIED"},{"httpCode":401,"statusCode":"UNAUTHENTICATED","applicationCode":"META_SITE_NOT_FOUND"}],"exposure":"PUBLIC","permissions":["SITE_PROPERTIES.UPDATE_BUSINESS_PROFILE"],"externalPermissionScopes":[{"name":"Manage Business Profile","scopeId":"SCOPE.DC-SITEPROP.MANAGE-BUSINESS-PROFILE"}],"protoArtifactId":"com.wixpress.siteproperties:site-properties-api-proto","serviceArtifactId":"com.wixpress.siteproperties.site-properties-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.siteproperties.api.v4.UpdateBusinessProfileRequest","responseMessage":"com.wixpress.siteproperties.api.v4.UpdateBusinessProfileResponse"},"legacyExamples":[{"name":"UpdateBusinessProfile","type":"METHOD","content":{"title":"Update site business profile","request":"curl -X POST \\\n 'https://www.wixapis.com/site-properties/v4/properties/business-profile'\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"businessProfile\": {\n \"siteDisplayName\": \"My Site Display Name\",\n \"businessName\": \"My Business Name\",\n \"logo\": \"663051_3dd7332ef233f245419432ffba703a4370~mv2.jpg\",\n \"description\": \"This is a site for my business\",\n },\n \"fields\": {\n \"paths\":[\"siteDisplayName\",\"businessName\",\"logo\",\"description\"]\n }\n }'"}}],"sourceRepo":"git@github.com:wix-private/wixos.git","contentLink":{"displayName":"Update Business Profile","slugifiedName":"update-business-profile"},"permissionScopes":[{"name":"Manage Business Profile","scopeId":"SCOPE.DC-SITEPROP.MANAGE-BUSINESS-PROFILE"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"Update Business Contact","description":"Updates a site's business contact information.","operationId":"com.wixpress.siteproperties.api.v4.SitePropertiesV4.UpdateBusinessContact","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.UpdateBusinessContactResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/site-properties/v4/properties","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/site-properties/v4/properties","destinationPath":"/v4/properties","url":"www.wixapis.com"}},{"url":"https://www.wixapis.com/site-properties","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/site-properties","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateBusinessContactRequest","description":"","properties":{"businessContact":{"$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.BusinessContactData","summary":"businessContact","description":"The site's business contact information.","x-wix-docs":{"exposure":"PUBLIC"}},"fields":{"title":"fields","description":"The properties of `businessContact` to be updated. Properties not explicitly specified here are ignored. Properties included here but excluded from `businessContact` are cleared.","$ref":"#/components/schemas/google.protobuf.FieldMask","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.siteproperties.api.v4.SitePropertiesV4","errors":[{"httpCode":403,"statusCode":"PERMISSION_DENIED","applicationCode":"PERMISSION_DENIED"},{"httpCode":401,"statusCode":"UNAUTHENTICATED","applicationCode":"META_SITE_NOT_FOUND"}],"exposure":"PUBLIC","permissions":["SITE_PROPERTIES.UPDATE_BUSINESS_CONTACT"],"externalPermissionScopes":[{"name":"Manage Business Contact","scopeId":"SCOPE.DC-SITEPROP.MANAGE-BUSINESS-CONTACT"}],"protoArtifactId":"com.wixpress.siteproperties:site-properties-api-proto","serviceArtifactId":"com.wixpress.siteproperties.site-properties-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.siteproperties.api.v4.UpdateBusinessContactRequest","responseMessage":"com.wixpress.siteproperties.api.v4.UpdateBusinessContactResponse"},"legacyExamples":[{"name":"UpdateBusinessContact","type":"METHOD","content":{"title":"Update site business contact","request":"curl -X POST \\\n 'https://www.wixapis.com/site-properties/v4/properties/business-contact'\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"businessContact\": {\n \"email\": \"useremail@domain.com\",\n \"phone\": \"+18008000000\",\n \"fax\": \"12345678\",\n \"address\": {\n \"street\": \"\",\n \"city\": \"New York\",\n \"country\": \"US\",\n \"state\": \"NY\",\n \"zip\": \"10036\",\n \"isPhysical\": true,\n \"googleFormattedAddress\": \"Times Square, Manhattan, NY, USA\",\n \"streetNumber\": \"\",\n \"apartmentNumber\": \"\",\n \"coordinates\": {\n \"latitude\": 40.7579747,\n \"longitude\": -73.9855426\n }\n }\n },\n \"fields\": {\n \"paths\":[\"phone\",\"fax\",\"email\",\"address\", \"businessSchedule\"]\n }\n }'"}}],"sourceRepo":"git@github.com:wix-private/wixos.git"},"httpMethod":"post","path":"/v4/properties/business-contact","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.siteproperties.api.v4.SitePropertiesV4","errors":[{"httpCode":403,"statusCode":"PERMISSION_DENIED","applicationCode":"PERMISSION_DENIED"},{"httpCode":401,"statusCode":"UNAUTHENTICATED","applicationCode":"META_SITE_NOT_FOUND"}],"exposure":"PUBLIC","permissions":["SITE_PROPERTIES.UPDATE_BUSINESS_CONTACT"],"externalPermissionScopes":[{"name":"Manage Business Contact","scopeId":"SCOPE.DC-SITEPROP.MANAGE-BUSINESS-CONTACT"}],"protoArtifactId":"com.wixpress.siteproperties:site-properties-api-proto","serviceArtifactId":"com.wixpress.siteproperties.site-properties-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.siteproperties.api.v4.UpdateBusinessContactRequest","responseMessage":"com.wixpress.siteproperties.api.v4.UpdateBusinessContactResponse"},"legacyExamples":[{"name":"UpdateBusinessContact","type":"METHOD","content":{"title":"Update site business contact","request":"curl -X POST \\\n 'https://www.wixapis.com/site-properties/v4/properties/business-contact'\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"businessContact\": {\n \"email\": \"useremail@domain.com\",\n \"phone\": \"+18008000000\",\n \"fax\": \"12345678\",\n \"address\": {\n \"street\": \"\",\n \"city\": \"New York\",\n \"country\": \"US\",\n \"state\": \"NY\",\n \"zip\": \"10036\",\n \"isPhysical\": true,\n \"googleFormattedAddress\": \"Times Square, Manhattan, NY, USA\",\n \"streetNumber\": \"\",\n \"apartmentNumber\": \"\",\n \"coordinates\": {\n \"latitude\": 40.7579747,\n \"longitude\": -73.9855426\n }\n }\n },\n \"fields\": {\n \"paths\":[\"phone\",\"fax\",\"email\",\"address\", \"businessSchedule\"]\n }\n }'"}}],"sourceRepo":"git@github.com:wix-private/wixos.git","contentLink":{"displayName":"Update Business Contact","slugifiedName":"update-business-contact"},"permissionScopes":[{"name":"Manage Business Contact","scopeId":"SCOPE.DC-SITEPROP.MANAGE-BUSINESS-CONTACT"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"Update Business Schedule","description":"Updates a site's business schedule.","operationId":"com.wixpress.siteproperties.api.v4.SitePropertiesV4.UpdateBusinessSchedule","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.UpdateBusinessScheduleResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/site-properties/v4/properties","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/site-properties/v4/properties","destinationPath":"/v4/properties","url":"www.wixapis.com"}},{"url":"https://www.wixapis.com/site-properties","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/site-properties","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateBusinessScheduleRequest","description":"","properties":{"businessSchedule":{"$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.BusinessSchedule","summary":"businessSchedule","description":"The site's business schedule in the site time zone.","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.siteproperties.api.v4.SitePropertiesV4","errors":[{"httpCode":403,"statusCode":"PERMISSION_DENIED","applicationCode":"PERMISSION_DENIED"},{"httpCode":401,"statusCode":"UNAUTHENTICATED","applicationCode":"META_SITE_NOT_FOUND"}],"exposure":"PUBLIC","permissions":["SITE_PROPERTIES.UPDATE_BUSINESS_SCHEDULE"],"externalPermissionScopes":[{"name":"Manage Business Schedule","scopeId":"SCOPE.DC-SITEPROP.MANAGE-BUSINESS-SCHEDULE"}],"protoArtifactId":"com.wixpress.siteproperties:site-properties-api-proto","serviceArtifactId":"com.wixpress.siteproperties.site-properties-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.siteproperties.api.v4.UpdateBusinessScheduleRequest","responseMessage":"com.wixpress.siteproperties.api.v4.UpdateBusinessScheduleResponse"},"legacyExamples":[{"name":"UpdateBusinessSchedule","type":"METHOD","content":{"title":"Update site business schedule","request":"curl -X POST \\\n 'https://www.wixapis.com/site-properties/v4/properties/business-schedule'\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"businessSchedule\": {\n \"periods\": [\n {\n \"openDay\": \"MONDAY\",\n \"openTime\": \"10:20\",\n \"closeDay\": \"MONDAY\",\n \"closeTime\": \"23:00\"\n },\n {\n \"openDay\": \"TUESDAY\",\n \"openTime\": \"10:20\",\n \"closeDay\": \"TUESDAY\",\n \"closeTime\": \"23:00\"\n }\n ],\n \"specialHourPeriod\": [\n {\n \"startDate\": \"2023-12-25T00:00\",\n \"endDate\": \"2024-01-01T24:00\",\n \"isClosed\": \"true\",\n \"comment\": \"Closed for Christmas-New Year break.\"\n },\n {\n \"startDate\": \"2024-07-04T00:00\",\n \"endDate\": \"2024-07-04T24:00\",\n \"isClosed\": \"true\",\n \"comment\": \"Closed for Independence Day.\"\n }\n ]\n }\n }'"}}],"sourceRepo":"git@github.com:wix-private/wixos.git"},"httpMethod":"post","path":"/v4/properties/business-schedule","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.siteproperties.api.v4.SitePropertiesV4","errors":[{"httpCode":403,"statusCode":"PERMISSION_DENIED","applicationCode":"PERMISSION_DENIED"},{"httpCode":401,"statusCode":"UNAUTHENTICATED","applicationCode":"META_SITE_NOT_FOUND"}],"exposure":"PUBLIC","permissions":["SITE_PROPERTIES.UPDATE_BUSINESS_SCHEDULE"],"externalPermissionScopes":[{"name":"Manage Business Schedule","scopeId":"SCOPE.DC-SITEPROP.MANAGE-BUSINESS-SCHEDULE"}],"protoArtifactId":"com.wixpress.siteproperties:site-properties-api-proto","serviceArtifactId":"com.wixpress.siteproperties.site-properties-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.siteproperties.api.v4.UpdateBusinessScheduleRequest","responseMessage":"com.wixpress.siteproperties.api.v4.UpdateBusinessScheduleResponse"},"legacyExamples":[{"name":"UpdateBusinessSchedule","type":"METHOD","content":{"title":"Update site business schedule","request":"curl -X POST \\\n 'https://www.wixapis.com/site-properties/v4/properties/business-schedule'\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"businessSchedule\": {\n \"periods\": [\n {\n \"openDay\": \"MONDAY\",\n \"openTime\": \"10:20\",\n \"closeDay\": \"MONDAY\",\n \"closeTime\": \"23:00\"\n },\n {\n \"openDay\": \"TUESDAY\",\n \"openTime\": \"10:20\",\n \"closeDay\": \"TUESDAY\",\n \"closeTime\": \"23:00\"\n }\n ],\n \"specialHourPeriod\": [\n {\n \"startDate\": \"2023-12-25T00:00\",\n \"endDate\": \"2024-01-01T24:00\",\n \"isClosed\": \"true\",\n \"comment\": \"Closed for Christmas-New Year break.\"\n },\n {\n \"startDate\": \"2024-07-04T00:00\",\n \"endDate\": \"2024-07-04T24:00\",\n \"isClosed\": \"true\",\n \"comment\": \"Closed for Independence Day.\"\n }\n ]\n }\n }'"}}],"sourceRepo":"git@github.com:wix-private/wixos.git","contentLink":{"displayName":"Update Business Schedule","slugifiedName":"update-business-schedule"},"permissionScopes":[{"name":"Manage Business Schedule","scopeId":"SCOPE.DC-SITEPROP.MANAGE-BUSINESS-SCHEDULE"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"Update Consent Policy","description":"Updates a site's default consent policy.","operationId":"com.wixpress.siteproperties.api.v4.SitePropertiesV4.UpdateConsentPolicy","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.UpdateConsentPolicyResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/site-properties/v4/properties","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/site-properties/v4/properties","destinationPath":"/v4/properties","url":"www.wixapis.com"}},{"url":"https://www.wixapis.com/site-properties","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/site-properties","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateConsentPolicyRequest","description":"The request used to update site's default consent policy","properties":{"consentPolicy":{"$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.ConsentPolicy","summary":"consentPolicy","description":"Default consent policy defined by the site owner. Can be further limited by site visitors.","x-wix-docs":{"exposure":"PUBLIC"}}},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.siteproperties.api.v4.SitePropertiesV4","errors":[{"httpCode":403,"statusCode":"PERMISSION_DENIED","applicationCode":"PERMISSION_DENIED"},{"httpCode":401,"statusCode":"UNAUTHENTICATED","applicationCode":"META_SITE_NOT_FOUND"}],"exposure":"PUBLIC","permissions":["SITE_PROPERTIES.UPDATE_CONSENT_POLICY"],"externalPermissionScopes":[{"name":"Manage Consent Policy","scopeId":"SCOPE.DC-SITEPROP.MANAGE-PROPERTIES"}],"protoArtifactId":"com.wixpress.siteproperties:site-properties-api-proto","serviceArtifactId":"com.wixpress.siteproperties.site-properties-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.siteproperties.api.v4.UpdateConsentPolicyRequest","responseMessage":"com.wixpress.siteproperties.api.v4.UpdateConsentPolicyResponse"},"legacyExamples":[{"name":"UpdateConsentPolicy","type":"METHOD","content":{"title":"Update site consent policy","request":"curl -X POST \\\n 'https://www.wixapis.com/site-properties/v4/properties/policy'\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"consentPolicy\": {\n \"essential\": false,\n \"functional\": true,\n \"analytics\": false,\n \"advertising\": true,\n \"dataToThirdParty\": true\n }\n }'"}}],"sourceRepo":"git@github.com:wix-private/wixos.git"},"httpMethod":"post","path":"/v4/properties/policy","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.siteproperties.api.v4.SitePropertiesV4","errors":[{"httpCode":403,"statusCode":"PERMISSION_DENIED","applicationCode":"PERMISSION_DENIED"},{"httpCode":401,"statusCode":"UNAUTHENTICATED","applicationCode":"META_SITE_NOT_FOUND"}],"exposure":"PUBLIC","permissions":["SITE_PROPERTIES.UPDATE_CONSENT_POLICY"],"externalPermissionScopes":[{"name":"Manage Consent Policy","scopeId":"SCOPE.DC-SITEPROP.MANAGE-PROPERTIES"}],"protoArtifactId":"com.wixpress.siteproperties:site-properties-api-proto","serviceArtifactId":"com.wixpress.siteproperties.site-properties-service","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.siteproperties.api.v4.UpdateConsentPolicyRequest","responseMessage":"com.wixpress.siteproperties.api.v4.UpdateConsentPolicyResponse"},"legacyExamples":[{"name":"UpdateConsentPolicy","type":"METHOD","content":{"title":"Update site consent policy","request":"curl -X POST \\\n 'https://www.wixapis.com/site-properties/v4/properties/policy'\n -H 'Content-Type: application/json' \\\n -H 'Authorization: ' \\\n --data-binary '{\n \"consentPolicy\": {\n \"essential\": false,\n \"functional\": true,\n \"analytics\": false,\n \"advertising\": true,\n \"dataToThirdParty\": true\n }\n }'"}}],"sourceRepo":"git@github.com:wix-private/wixos.git","contentLink":{"displayName":"Update Consent Policy","slugifiedName":"update-consent-policy"},"permissionScopes":[{"name":"Manage Consent Policy","scopeId":"SCOPE.DC-SITEPROP.MANAGE-PROPERTIES"}]}],"webhooks":[{"summary":"Properties Site Properties Updated","title":"Properties Site Properties Updated","description":"Triggered when site properties are updated","permissions":["SITE_SETTINGS.VIEW"],"payload":{"schemaName":"com.wixpress.siteproperties.api.v4.SitePropertiesUpdated"},"exposure":"PUBLIC","maturity":"BETA","slug":"site_properties_updated","eventTopic":"site-properties.changes.external","serviceName":"com.wixpress.siteproperties.api.v4.SitePropertiesV4","domainEvent":"NOT_DOMAIN_EVENT","legacyExamples":[{"name":"Site Properties Updated","type":"LEGACY_EVENT","content":"{\n \"metasiteId\": \"884aa31e-c73e-40c7-94b2-c67db9f0ee5c\",\n \"event\": {\n \"version\": \"12\",\n \"fields\": {\n \"paths\": [\"locale\", \"language\", \"paymentCurrency\", \"timeZone\"]\n },\n \"properties\": {\n \"locale\": {\n \"languageCode\": \"en\",\n \"country\": \"US\"\n },\n \"language\": \"en\",\n \"paymentCurrency\": \"USD\",\n \"timeZone\": \"America/New_York\"\n }\n }\n}"}],"sourceRepo":"git@github.com:wix-private/wixos.git","$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.SitePropertiesUpdated","contentLink":{"displayName":"Site Properties Updated","slugifiedName":"site-properties-updated"},"labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Your App","scopeId":"SCOPE.DC.MANAGE-YOUR-APP"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]}],"articles":[],"components":{"schemas":{"com.wixpress.siteproperties.api.v4.Properties":{"type":"object","properties":{"categories":{"$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.Categories","summary":"categories","description":"Site categories.","x-wix-docs":{"exposure":"PUBLIC"}},"locale":{"$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.Locale","summary":"locale","description":"Site locale.","x-wix-docs":{"exposure":"PUBLIC"}},"language":{"title":"language","description":"Site language.\n\nTwo-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"paymentCurrency":{"title":"paymentCurrency","description":"Site currency format used to bill customers.\n\nThree-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"timeZone":{"title":"timeZone","description":"Timezone in `America/New_York` format.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"email":{"title":"email","description":"Email address.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"phone":{"title":"phone","description":"Phone number.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"fax":{"title":"fax","description":"Fax number.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"address":{"$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.Address","summary":"address","description":"Address.","x-wix-docs":{"exposure":"PUBLIC"}},"siteDisplayName":{"title":"siteDisplayName","description":"Site display name.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"businessName":{"title":"businessName","description":"Business name.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"logo":{"title":"logo","description":"Path to the site's logo in Wix Media (without Wix Media base URL).","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"description":{"title":"description","description":"Site description.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"businessSchedule":{"$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.BusinessSchedule","summary":"businessSchedule","description":"Business schedule. Regular and exceptional time periods when the business is open or the service is available.\n\n__Note:__ Not supported by Wix Bookings.","x-wix-docs":{"exposure":"PUBLIC"}},"multilingual":{"$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.Multilingual","summary":"multilingual","description":"Supported languages of a site and the primary language.","x-wix-docs":{"exposure":"PUBLIC"}},"consentPolicy":{"$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.ConsentPolicy","summary":"consentPolicy","description":"Cookie policy the site owner defined for their site (before the users interacts with/limits it).","x-wix-docs":{"exposure":"PUBLIC"}},"businessConfig":{"title":"businessConfig","description":"Supported values: `FITNESS SERVICE`, `RESTAURANT`, `BLOG`, `STORE`, `EVENT`, `UNKNOWN`.\n\nSite business type.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"externalSiteUrl":{"title":"externalSiteUrl","description":"External site url that uses Wix as its headless business solution","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"trackClicksAnalytics":{"title":"trackClicksAnalytics","description":"Track clicks analytics","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Properties","description":""},"com.wixpress.siteproperties.api.v4.Categories":{"type":"object","properties":{"primary":{"title":"primary","description":"Primary site category.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"secondary":{"title":"secondary","description":"Secondary site category.","maxItems":50,"type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}},"businessTermId":{"title":"businessTermId","description":"Business Term Id","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Categories","description":""},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"title":"value","description":"","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"StringValue","description":""},"com.wixpress.siteproperties.api.v4.Locale":{"type":"object","properties":{"languageCode":{"title":"languageCode","description":"Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"country":{"title":"country","description":"Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Locale","description":""},"com.wixpress.siteproperties.api.v4.Address":{"type":"object","properties":{"street":{"title":"street","description":"Street name.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"city":{"title":"city","description":"City name.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"country":{"title":"country","description":"Two-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"state":{"title":"state","description":"State.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"zip":{"title":"zip","description":"Zip or postal code.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"hint":{"$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.AddressHint","summary":"hint","description":"Extra information to be displayed in the address.","x-wix-docs":{"exposure":"PUBLIC"}},"isPhysical":{"title":"isPhysical","description":"Whether this address represents a physical location.","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"googleFormattedAddress":{"title":"googleFormattedAddress","description":"Google-formatted version of this address.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"streetNumber":{"title":"streetNumber","description":"Street number.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"apartmentNumber":{"title":"apartmentNumber","description":"Apartment number.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"coordinates":{"$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.GeoCoordinates","summary":"coordinates","description":"Geographic coordinates of location.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Address","description":""},"com.wixpress.siteproperties.api.v4.AddressHint":{"type":"object","properties":{"text":{"title":"text","description":"Extra text displayed next to, or instead of, the actual address.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"placement":{"title":"placement","description":"Where the extra text should be displayed.","type":"string","$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.PlacementType","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"AddressHint","description":"Extra information on displayed addresses.\nThis is used for display purposes. Used to add additional data about the address, such as \"In the passage\".\nFree text. In addition the user can state where he wants that additional description - before, after, or instead\nthe address string."},"com.wixpress.siteproperties.api.v4.PlacementType":{"type":"string","description":"Where the extra text should be displayed: before, after or instead of the actual address.","title":"PlacementType","enum":["BEFORE","AFTER","REPLACE"]},"com.wixpress.siteproperties.api.v4.GeoCoordinates":{"type":"object","properties":{"latitude":{"title":"latitude","description":"Latitude of the location. Must be between -90 and 90.","type":"number","x-wix-docs":{"exposure":"PUBLIC"}},"longitude":{"title":"longitude","description":"Longitude of the location. Must be between -180 and 180.","type":"number","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"GeoCoordinates","description":"Geocoordinates for a particular address."},"com.wixpress.siteproperties.api.v4.BusinessSchedule":{"type":"object","properties":{"periods":{"title":"periods","description":"Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods.","maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.TimePeriod"},"x-wix-docs":{"exposure":"PUBLIC"}},"specialHourPeriod":{"title":"specialHourPeriod","description":"Exceptions to the business's regular hours. The business can be open or closed during the exception.","maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.SpecialHourPeriod"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BusinessSchedule","description":"Business schedule. Regular and exceptional time periods when the business is open or the service is available."},"com.wixpress.siteproperties.api.v4.TimePeriod":{"type":"object","properties":{"openDay":{"title":"openDay","description":"Day of the week the period starts on.","type":"string","$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.DayOfWeek","x-wix-docs":{"exposure":"PUBLIC"}},"openTime":{"title":"openTime","description":"Time the period starts in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents\nmidnight at the end of the specified day.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"closeDay":{"title":"closeDay","description":"Day of the week the period ends on.","type":"string","$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.DayOfWeek","x-wix-docs":{"exposure":"PUBLIC"}},"closeTime":{"title":"closeTime","description":"Time the period ends in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents\nmidnight at the end of the specified day.\n\n__Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"TimePeriod","description":"Weekly recurring time periods when the business is regularly open or the service is available."},"com.wixpress.siteproperties.api.v4.DayOfWeek":{"type":"string","description":"Enumerates the days of the week.","title":"DayOfWeek","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]},"com.wixpress.siteproperties.api.v4.SpecialHourPeriod":{"type":"object","properties":{"startDate":{"title":"startDate","description":"Start date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time).","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"endDate":{"title":"endDate","description":"End date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time).","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"isClosed":{"title":"isClosed","description":"Whether the business is closed (or the service is not available) during the exception.\n\nDefault: `true`.","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"comment":{"title":"comment","description":"Additional info about the exception. For example, \"We close earlier on New Year's Eve.\"","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"SpecialHourPeriod","description":"Exception to the business's regular hours. The business can be open or closed during the exception."},"com.wixpress.siteproperties.api.v4.Multilingual":{"type":"object","properties":{"supportedLanguages":{"title":"supportedLanguages","description":"Supported languages list.","maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.SupportedLanguage"},"x-wix-docs":{"exposure":"PUBLIC"}},"autoRedirect":{"title":"autoRedirect","description":"Whether to redirect to user language.","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Multilingual","description":""},"com.wixpress.siteproperties.api.v4.SupportedLanguage":{"type":"object","properties":{"languageCode":{"title":"languageCode","description":"Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"locale":{"$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.Locale","summary":"locale","description":"Locale.","x-wix-docs":{"exposure":"PUBLIC"}},"isPrimary":{"title":"isPrimary","description":"Whether the supported language is the primary language for the site.","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"countryCode":{"title":"countryCode","description":"Language icon.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"resolutionMethod":{"title":"resolutionMethod","description":"How the language will be resolved. For internal use.","type":"string","$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.ResolutionMethod","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"SupportedLanguage","description":""},"com.wixpress.siteproperties.api.v4.ResolutionMethod":{"type":"string","description":"","title":"ResolutionMethod","enum":["QUERY_PARAM","SUBDOMAIN","SUBDIRECTORY"]},"com.wixpress.siteproperties.api.v4.ConsentPolicy":{"type":"object","properties":{"essential":{"title":"essential","description":"Whether the site uses cookies that are essential to site operation.","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"functional":{"title":"functional","description":"Whether the site uses cookies that affect site performance and other functional measurements.","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"analytics":{"title":"analytics","description":"Whether the site uses cookies that collect analytics about how the site is used (in order to improve it).","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"advertising":{"title":"advertising","description":"Whether the site uses cookies that collect information allowing better customization of the experience for a current visitor.","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}},"dataToThirdParty":{"title":"dataToThirdParty","description":"CCPA compliance flag.","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"ConsentPolicy","description":""},"google.protobuf.BoolValue":{"type":"object","properties":{"value":{"title":"value","description":"","type":"boolean","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BoolValue","description":""},"com.wixpress.siteproperties.api.v4.PropertiesReadRequest":{"type":"object","properties":{"fields":{"title":"fields","description":"The set of desired fields.","$ref":"#/components/schemas/google.protobuf.FieldMask","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"PropertiesReadRequest","description":"The parameters of a site properties read request."},"google.protobuf.FieldMask":{"type":"object","properties":{"paths":{"title":"paths","description":"","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"FieldMask","description":""},"com.wixpress.siteproperties.api.v4.PropertiesReadResponse":{"type":"object","properties":{"version":{"title":"version","description":"Current version of the stored property site. For internal use.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"properties":{"$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.Properties","summary":"properties","description":"Properties for the requested site.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"PropertiesReadResponse","description":"The resulting properties for the requested site."},"com.wixpress.siteproperties.api.v4.PropertiesUpdateRequest":{"type":"object","properties":{"properties":{"$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.Properties","summary":"properties","description":"","x-wix-docs":{"exposure":"PUBLIC"}},"fields":{"title":"fields","description":"The properties to be updated. Properties not explicitly specified here are ignored. Properties included here but excluded from `properties` are cleared.","$ref":"#/components/schemas/google.protobuf.FieldMask","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"PropertiesUpdateRequest","description":"The request used to update a site's properties."},"com.wixpress.siteproperties.api.v4.PropertiesUpdateResponse":{"type":"object","properties":{"version":{"title":"version","description":"The new version of the stored properties after the update. For internal use.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"PropertiesUpdateResponse","description":"The details resulting from an update operation."},"com.wixpress.siteproperties.api.v4.SitePropertiesNotification":{"type":"object","properties":{"metasiteId":{"title":"metasiteId","description":"The site ID for which this update notification applies.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"event":{"$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.SitePropertiesEvent","summary":"event","description":"The actual update event.","x-wix-docs":{"exposure":"PUBLIC"}},"translations":{"title":"translations","description":"A convenience set of mappings from the MetaSite ID to its constituent services.","maxItems":500,"type":"array","items":{"$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.Translation"},"x-wix-docs":{"exposure":"PUBLIC"}},"changeContext":{"$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.ChangeContext","summary":"changeContext","description":"Context of the notification","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"SitePropertiesNotification","description":"Encapsulates all details written to the Greyhound topic when a site's properties are updated."},"com.wixpress.siteproperties.api.v4.SitePropertiesEvent":{"type":"object","properties":{"version":{"title":"version","description":"Version of the site's properties represented by this update.","type":"number","x-wix-docs":{"exposure":"PUBLIC"}},"fields":{"title":"fields","description":"Set of properties that were updated - corresponds to the fields in \"properties\".","$ref":"#/components/schemas/google.protobuf.FieldMask","x-wix-docs":{"exposure":"PUBLIC"}},"properties":{"$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.Properties","summary":"properties","description":"Updated properties.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"SitePropertiesEvent","description":"The actual update event for a particular notification."},"com.wixpress.siteproperties.api.v4.Translation":{"type":"object","properties":{"serviceType":{"title":"serviceType","description":"The service type.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"appDefId":{"title":"appDefId","description":"The application definition ID; this only applies to services of type ThirdPartyApps.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"instanceId":{"title":"instanceId","description":"The instance ID of the service.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"Translation","description":"A single mapping from the MetaSite ID to a particular service."},"com.wixpress.siteproperties.api.v4.ChangeContext":{"type":"object","properties":{},"title":"ChangeContext","description":"","oneOf":[{"description":"","summary":"payload","$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.ChangeContext.payload"}]},"com.wixpress.siteproperties.api.v4.ChangeContext.payload":{"type":"object","title":"payload","properties":{"propertiesChange":{"$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.PropertiesChange","summary":"propertiesChange","description":"Properties were updated.","x-wix-docs":{"exposure":"PUBLIC"}},"siteCreated":{"$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.SiteCreated","summary":"siteCreated","description":"Default properties were created on site creation.","x-wix-docs":{"exposure":"PUBLIC"}},"siteCloned":{"$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.SiteCloned","summary":"siteCloned","description":"Properties were cloned on site cloning.","x-wix-docs":{"exposure":"PUBLIC"}}}},"com.wixpress.siteproperties.api.v4.PropertiesChange":{"type":"object","properties":{},"title":"PropertiesChange","description":""},"com.wixpress.siteproperties.api.v4.SiteCreated":{"type":"object","properties":{"originTemplateId":{"title":"originTemplateId","description":"Origin template site id.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"SiteCreated","description":""},"com.wixpress.siteproperties.api.v4.SiteCloned":{"type":"object","properties":{"originMetaSiteId":{"title":"originMetaSiteId","description":"Origin site id.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"SiteCloned","description":""},"com.wixpress.siteproperties.api.v4.SitePropertiesUpdated":{"type":"object","properties":{"metasiteId":{"title":"metasiteId","description":"ID of the Wix site that has been updated.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"event":{"$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.SitePropertiesEvent","summary":"event","description":"Update details.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"SitePropertiesUpdated","description":"Encapsulates all changes when site properties are updated"},"com.wixpress.siteproperties.api.v4.SitePropertiesFullNotification":{"type":"object","properties":{"metaSiteId":{"title":"metaSiteId","description":"The site ID for which this snapshot applies.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"version":{"title":"version","description":"Version of the site's properties current snapshot.","type":"number","x-wix-docs":{"exposure":"PUBLIC"}},"properties":{"$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.Properties","summary":"properties","description":"Snapshot properties.","x-wix-docs":{"exposure":"PUBLIC"}},"changeContext":{"$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.ChangeContext","summary":"changeContext","description":"Context of the notification","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"SitePropertiesFullNotification","description":"Snapshot of latest site properties."},"com.wixpress.siteproperties.api.v4.UpdateBusinessProfileRequest":{"type":"object","properties":{"businessProfile":{"$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.BusinessProfileData","summary":"businessProfile","description":"The site's business profile.","x-wix-docs":{"exposure":"PUBLIC"}},"fields":{"title":"fields","description":"The properties of `businessProfile` to be updated. Properties not explicitly specified here are ignored. Properties included here but excluded from `businessProfile` are cleared.","$ref":"#/components/schemas/google.protobuf.FieldMask","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"UpdateBusinessProfileRequest","description":""},"com.wixpress.siteproperties.api.v4.BusinessProfileData":{"type":"object","properties":{"siteDisplayName":{"title":"siteDisplayName","description":"Site display name.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"businessName":{"title":"businessName","description":"Business name.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"logo":{"title":"logo","description":"Path to the site's logo in Wix Media (without Wix Media base URL).","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"description":{"title":"description","description":"Site description.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BusinessProfileData","description":""},"com.wixpress.siteproperties.api.v4.UpdateBusinessProfileResponse":{"type":"object","properties":{},"title":"UpdateBusinessProfileResponse","description":""},"com.wixpress.siteproperties.api.v4.UpdateBusinessContactRequest":{"type":"object","properties":{"businessContact":{"$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.BusinessContactData","summary":"businessContact","description":"The site's business contact information.","x-wix-docs":{"exposure":"PUBLIC"}},"fields":{"title":"fields","description":"The properties of `businessContact` to be updated. Properties not explicitly specified here are ignored. Properties included here but excluded from `businessContact` are cleared.","$ref":"#/components/schemas/google.protobuf.FieldMask","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"UpdateBusinessContactRequest","description":""},"com.wixpress.siteproperties.api.v4.BusinessContactData":{"type":"object","properties":{"email":{"title":"email","description":"Publicly-available business email address.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"phone":{"title":"phone","description":"Publicly-available business phone number.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"fax":{"title":"fax","description":"Publicly-available business fax number.","type":"string","x-wix-docs":{"exposure":"PUBLIC"}},"address":{"$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.Address","summary":"address","description":"Publicly-available business address.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BusinessContactData","description":""},"com.wixpress.siteproperties.api.v4.UpdateBusinessContactResponse":{"type":"object","properties":{},"title":"UpdateBusinessContactResponse","description":""},"com.wixpress.siteproperties.api.v4.UpdateBusinessScheduleRequest":{"type":"object","properties":{"businessSchedule":{"$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.BusinessSchedule","summary":"businessSchedule","description":"The site's business schedule in the site time zone.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"UpdateBusinessScheduleRequest","description":""},"com.wixpress.siteproperties.api.v4.UpdateBusinessScheduleResponse":{"type":"object","properties":{},"title":"UpdateBusinessScheduleResponse","description":""},"com.wixpress.siteproperties.api.v4.UpdateConsentPolicyRequest":{"type":"object","properties":{"consentPolicy":{"$ref":"#/components/schemas/com.wixpress.siteproperties.api.v4.ConsentPolicy","summary":"consentPolicy","description":"Default consent policy defined by the site owner. Can be further limited by site visitors.","x-wix-docs":{"exposure":"PUBLIC"}}},"title":"UpdateConsentPolicyRequest","description":"The request used to update site's default consent policy"},"com.wixpress.siteproperties.api.v4.UpdateConsentPolicyResponse":{"type":"object","properties":{},"title":"UpdateConsentPolicyResponse","description":""},"com.wixpress.siteproperties.api.v4.BulkPropertiesReadRequest":{"type":"object","properties":{"sites":{"title":"sites","description":"Sites ids.","maxItems":1000,"type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BulkPropertiesReadRequest","description":""},"com.wixpress.siteproperties.api.v4.BulkPropertiesReadResponse":{"type":"object","properties":{"sites":{"title":"sites","description":"The ID of the resolved MetaSite for the request.","type":"object","format":"map","properties":{"key:value":{"type":"object","description":"\"key\" of type string, \"value\" of type object","title":"key:value"}},"x-wix-docs":{"exposure":"PUBLIC"}}},"title":"BulkPropertiesReadResponse","description":"The resulting properties for the requested site."}}},"title":"Properties","description":"","fqdn":"wix.siteproperties.v4.properties"},"articles":[]},"reviewStatus":"APPROVED","isLocked":true}

Get Site Properties

Permission Scopes