Flipdish · Schema
WhiteLabelConfigModel
WhiteLabelConfig model
RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks
Properties
| Name | Type | Description |
|---|---|---|
| WhiteLabelLanguages | array | White label languages |
| WhiteLabelAssets | array | White label assets |
| ColorScheme | object | |
| WhiteLabelConfigId | integer | White label configuration ID |
| WhiteLabelId | integer | White label ID |
| WhiteLabelName | string | White label name |
| AppNameId | string | App name ID (Bundle ID Suffix) |
| OrgId | string | Organization ID |
| SmsRestaurantName | string | SMS restaurant name |
| DeepLinkUrlScheme | string | Deep link URL scheme |
| HostName | string | Host name |
| NexmoSupportSmsNumber | string | Nexmo support SMS number |
| TwilioSupportSmsNumber | string | Twilio support SMS number |
| MixpanelToken | string | Mixpanel token |
| IntercomAppId | string | Intercom app ID |
| ShareMessageEmailSubject | string | Share message email subject |
| ShareMessageEmailMessage | string | Share message email message |
| ShareMessageSmsMessage | string | Share message SMS message |
| ShareMessageWhatsAppMessage | string | Share message WhatsApp message |
| ShareMessageFacebookMessage | string | Share message Facebook message |
| ShareMessageTwitterMessage | string | Share message Twitter message |
| ShareMessageGenericMessage | string | Share message generic message |
| DisplayDeliveryRestaurantListScreen | boolean | Display delivery restaurant list screen |
| ContactFormType | integer | Contact form type |
| ContactPhoneNumber | string | Contact phone number |
| DisplayBumpSideMenuItem | boolean | Display bump side menu item |
| DisplayFreeCokeSideMenuItem | boolean | Display free coke side menu item |
| AppStoreUrl | string | App store URL |
| DeliveryEnabled | boolean | Delivery enabled |
| PickupEnabled | boolean | Pickup enabled |
| DisplayPickupRestaurantListScreen | boolean | Display pickup restaurant list screen |
| DisplayCuisineTypeListAndRestaurantSearchBar | boolean | Display cuisine type list and restaurant search bar |
| DisplayUserRestaurantRatings | boolean | Display user restaurant ratings |
| ReadyToPublishWeb | boolean | Ready to publish web |
| ReadyToPublishIos | boolean | Ready to publish iOS |
| ReadyToPublishAndroid | boolean | Ready to publish Android |
| DisplayFooterLinksToOtherSites | boolean | Display footer links to other sites |
| DisplayOnlineOrderingMenu | boolean | Display online ordering menu |
| HideAppConfigFromAdminList | boolean | Hide app config from admin list |
| ComplianceType | string | Compliance type |
| IsMenuMigratedToRms | boolean | Is menu migrated to RMS |
| MapBoundryMaxLongitude | number | Map boundary max longitude |
| MapBoundryMinLongitude | number | Map boundary min longitude |
| MapBoundryMaxLatitude | number | Map boundary max latitude |
| MapBoundryMinLatitude | number | Map boundary min latitude |
| AppStoreAppleId | string | App store Apple ID |
| AppStoreToken | string | App store token |
| WebsiteDisplayStaticMenuPage | boolean | Website display static menu page |
| IsEmbed | boolean | Is embed |
| DisplayTipOptionToUsersByDefault | boolean | Display tip option to users by default |
| EmailRequestMode | integer | Email request mode |
| AddressEntryType | integer | Address entry type |
| AddressLayout | integer | Address layout |
| Category | integer | Category |
| MapCenterLatitude | number | Map center latitude |
| MapCenterLongitude | number | Map center longitude |
| IntercomTokenIos | string | Intercom token iOS |
| IntercomTokenAndroid | string | Intercom token Android |
| GoogleAnalyticsTokensCsv | string | Google Analytics tokens CSV |
| FacebookTokensCsv | string | Facebook tokens CSV |
| ShareMessageGenericUrl | string | Share message generic URL |
| PrivateSupportEmailAddress | string | Private support email address |
| AppStoreId | string | App store ID |
| PlayConsoleAccount | integer | Play console account |
| ApnCertificateValidAfter | string | APN certificate valid after |
| ApnCertificateValidBefore | string | APN certificate valid before |
| DineInEnabled | boolean | Dine in enabled |
| AppFont | string | App font |
| WhiteLabelColorSchemeId | integer | White label color scheme ID |
| WhiteLabelImagesId | integer | White label images ID |
| AppStoreCopyright | string | App store copyright |
| AppStoreDescription | string | App store description |
| AppStoreShortDescription | string | App store short description |
| AppStoreKeywords | string | App store keywords |
| AppStoreMarketingUrl | string | App store marketing URL |
| AppStoreName | string | App store name |
| AppStorePrivacyUrl | string | App store privacy URL |
| AppStoreSupportUrl | string | App store support URL |
| AppStoreReleaseNotes | string | App store release notes |
| AppStoreIconUrl | string | App store icon URL |
| AppStoreIconThumbnail100Url | string | App store icon thumbnail 100 URL |
| TransparentLogoUrl | string | Transparent logo URL |
| LogoImageName | string | Logo image name |
| KioskNameScreenImage | string | Kiosk name screen image |
| WebToAppRedirect | integer | Web to app redirect |
| FeaturesCsv | string | Features CSV |
| AppStorePassword | string | App store password |
| AppStoreTeamId | string | App store team ID |
| AppStoreAppGroup | string | App store app group |
| AppStoreSigningIdentity | string | App store signing identity |
| AppStoreItcTeamId | string | App store ITC team ID |
| HeadHtml | string | Head HTML |
| SocialTwitterUrl | string | Social Twitter URL |
| SocialFacebookUrl | string | Social Facebook URL |
| SocialInstagramUrl | string | Social Instagram URL |
| SocialPintrestUrl | string | Social Pinterest URL |
| SocialTripAdvisorUrl | string | Social TripAdvisor URL |
| SocialGooglePlusUrl | string | Social Google Plus URL |
| SocialFourSquareUrl | string | Social FourSquare URL |
| SocialYelpUrl | string | Social Yelp URL |
| WebsiteType | integer | Website type |
| ExternalOrderingPageUrl | string | External ordering page URL |
| PanaceaEnabled | boolean | Panacea enabled |
| CookieConsentPromptEnabled | boolean | Cookie consent prompt enabled |
| PanaceaVanityUrl | string | Panacea vanity URL |
| CountryId | string | Country ID |
| ReferralUserId | integer | Referral user ID |
| ReferralCampaignId | string | Referral campaign ID |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/json-schema/apps-white-label-config-model-schema.json",
"title": "WhiteLabelConfigModel",
"description": "WhiteLabelConfig model",
"type": "object",
"properties": {
"WhiteLabelLanguages": {
"description": "White label languages",
"type": "array",
"items": {
"$ref": "#/components/schemas/WhiteLabelLanguageModel"
},
"example": []
},
"WhiteLabelAssets": {
"description": "White label assets",
"type": "array",
"items": {
"$ref": "#/components/schemas/WhiteLabelAssetModel"
},
"example": []
},
"ColorScheme": {
"$ref": "#/components/schemas/WhiteLabelColorSchemeModel"
},
"WhiteLabelConfigId": {
"format": "int32",
"description": "White label configuration ID",
"type": "integer",
"example": 500123
},
"WhiteLabelId": {
"format": "int32",
"description": "White label ID",
"type": "integer",
"example": 500123
},
"WhiteLabelName": {
"description": "White label name",
"type": "string",
"example": "Example Name"
},
"AppNameId": {
"description": "App name ID (Bundle ID Suffix)",
"type": "string",
"example": "500123"
},
"OrgId": {
"description": "Organization ID",
"type": "string",
"example": "500123"
},
"SmsRestaurantName": {
"description": "SMS restaurant name",
"type": "string",
"example": "Example Name"
},
"DeepLinkUrlScheme": {
"description": "Deep link URL scheme",
"type": "string",
"example": "https://api.flipdish.co/example"
},
"HostName": {
"description": "Host name",
"type": "string",
"example": "Example Name"
},
"NexmoSupportSmsNumber": {
"description": "Nexmo support SMS number",
"type": "string",
"example": "string"
},
"TwilioSupportSmsNumber": {
"description": "Twilio support SMS number",
"type": "string",
"example": "string"
},
"MixpanelToken": {
"description": "Mixpanel token",
"type": "string",
"example": "string"
},
"IntercomAppId": {
"description": "Intercom app ID",
"type": "string",
"example": "500123"
},
"ShareMessageEmailSubject": {
"description": "Share message email subject",
"type": "string",
"example": "[email protected]"
},
"ShareMessageEmailMessage": {
"description": "Share message email message",
"type": "string",
"example": "[email protected]"
},
"ShareMessageSmsMessage": {
"description": "Share message SMS message",
"type": "string",
"example": "string"
},
"ShareMessageWhatsAppMessage": {
"description": "Share message WhatsApp message",
"type": "string",
"example": "string"
},
"ShareMessageFacebookMessage": {
"description": "Share message Facebook message",
"type": "string",
"example": "string"
},
"ShareMessageTwitterMessage": {
"description": "Share message Twitter message",
"type": "string",
"example": "string"
},
"ShareMessageGenericMessage": {
"description": "Share message generic message",
"type": "string",
"example": "string"
},
"DisplayDeliveryRestaurantListScreen": {
"description": "Display delivery restaurant list screen",
"type": "boolean",
"example": true
},
"ContactFormType": {
"format": "int32",
"description": "Contact form type",
"type": "integer",
"example": 1
},
"ContactPhoneNumber": {
"description": "Contact phone number",
"type": "string",
"example": "+353000000000"
},
"DisplayBumpSideMenuItem": {
"description": "Display bump side menu item",
"type": "boolean",
"example": true
},
"DisplayFreeCokeSideMenuItem": {
"description": "Display free coke side menu item",
"type": "boolean",
"example": true
},
"AppStoreUrl": {
"description": "App store URL",
"type": "string",
"example": "https://api.flipdish.co/example"
},
"DeliveryEnabled": {
"description": "Delivery enabled",
"type": "boolean",
"example": true
},
"PickupEnabled": {
"description": "Pickup enabled",
"type": "boolean",
"example": true
},
"DisplayPickupRestaurantListScreen": {
"description": "Display pickup restaurant list screen",
"type": "boolean",
"example": true
},
"DisplayCuisineTypeListAndRestaurantSearchBar": {
"description": "Display cuisine type list and restaurant search bar",
"type": "boolean",
"example": true
},
"DisplayUserRestaurantRatings": {
"description": "Display user restaurant ratings",
"type": "boolean",
"example": true
},
"ReadyToPublishWeb": {
"description": "Ready to publish web",
"type": "boolean",
"example": true
},
"ReadyToPublishIos": {
"description": "Ready to publish iOS",
"type": "boolean",
"example": true
},
"ReadyToPublishAndroid": {
"description": "Ready to publish Android",
"type": "boolean",
"example": true
},
"DisplayFooterLinksToOtherSites": {
"description": "Display footer links to other sites",
"type": "boolean",
"example": true
},
"DisplayOnlineOrderingMenu": {
"description": "Display online ordering menu",
"type": "boolean",
"example": true
},
"HideAppConfigFromAdminList": {
"description": "Hide app config from admin list",
"type": "boolean",
"example": true
},
"ComplianceType": {
"description": "Compliance type",
"enum": [
"Default",
"GdprCompliance"
],
"type": "string",
"example": "Default"
},
"IsMenuMigratedToRms": {
"description": "Is menu migrated to RMS",
"type": "boolean",
"example": true
},
"MapBoundryMaxLongitude": {
"format": "double",
"description": "Map boundary max longitude",
"type": "number",
"nullable": true,
"example": 1.0
},
"MapBoundryMinLongitude": {
"format": "double",
"description": "Map boundary min longitude",
"type": "number",
"nullable": true,
"example": 1.0
},
"MapBoundryMaxLatitude": {
"format": "double",
"description": "Map boundary max latitude",
"type": "number",
"nullable": true,
"example": 1.0
},
"MapBoundryMinLatitude": {
"format": "double",
"description": "Map boundary min latitude",
"type": "number",
"nullable": true,
"example": 1.0
},
"AppStoreAppleId": {
"description": "App store Apple ID",
"type": "string",
"example": "500123"
},
"AppStoreToken": {
"description": "App store token",
"type": "string",
"example": "string"
},
"WebsiteDisplayStaticMenuPage": {
"description": "Website display static menu page",
"type": "boolean",
"example": true
},
"IsEmbed": {
"description": "Is embed",
"type": "boolean",
"nullable": true,
"example": true
},
"DisplayTipOptionToUsersByDefault": {
"description": "Display tip option to users by default",
"type": "boolean",
"example": true
},
"EmailRequestMode": {
"format": "int32",
"description": "Email request mode",
"type": "integer",
"example": 1
},
"AddressEntryType": {
"format": "int32",
"description": "Address entry type",
"type": "integer",
"example": 1
},
"AddressLayout": {
"format": "int32",
"description": "Address layout",
"type": "integer",
"example": 1
},
"Category": {
"format": "int32",
"description": "Category",
"type": "integer",
"example": 1
},
"MapCenterLatitude": {
"format": "double",
"description": "Map center latitude",
"type": "number",
"example": 1.0
},
"MapCenterLongitude": {
"format": "double",
"description": "Map center longitude",
"type": "number",
"example": 1.0
},
"IntercomTokenIos": {
"description": "Intercom token iOS",
"type": "string",
"example": "string"
},
"IntercomTokenAndroid": {
"description": "Intercom token Android",
"type": "string",
"example": "500123"
},
"GoogleAnalyticsTokensCsv": {
"description": "Google Analytics tokens CSV",
"type": "string",
"example": "string"
},
"FacebookTokensCsv": {
"description": "Facebook tokens CSV",
"type": "string",
"example": "string"
},
"ShareMessageGenericUrl": {
"description": "Share message generic URL",
"type": "string",
"example": "https://api.flipdish.co/example"
},
"PrivateSupportEmailAddress": {
"description": "Private support email address",
"type": "string",
"example": "[email protected]"
},
"AppStoreId": {
"description": "App store ID",
"type": "string",
"example": "500123"
},
"PlayConsoleAccount": {
"format": "int32",
"description": "Play console account",
"type": "integer",
"example": 3
},
"ApnCertificateValidAfter": {
"format": "date-time",
"description": "APN certificate valid after",
"type": "string",
"nullable": true,
"example": "2026-06-02T12:00:00Z"
},
"ApnCertificateValidBefore": {
"format": "date-time",
"description": "APN certificate valid before",
"type": "string",
"nullable": true,
"example": "2026-06-02T12:00:00Z"
},
"DineInEnabled": {
"description": "Dine in enabled",
"type": "boolean",
"example": true
},
"AppFont": {
"description": "App font",
"type": "string",
"example": "string"
},
"WhiteLabelColorSchemeId": {
"format": "int32",
"description": "White label color scheme ID",
"type": "integer",
"example": 500123
},
"WhiteLabelImagesId": {
"format": "int32",
"description": "White label images ID",
"type": "integer",
"example": 500123
},
"AppStoreCopyright": {
"description": "App store copyright",
"type": "string",
"example": "string"
},
"AppStoreDescription": {
"description": "App store description",
"type": "string",
"example": "string"
},
"AppStoreShortDescription": {
"description": "App store short description",
"type": "string",
"example": "string"
},
"AppStoreKeywords": {
"description": "App store keywords",
"type": "string",
"example": "string"
},
"AppStoreMarketingUrl": {
"description": "App store marketing URL",
"type": "string",
"example": "https://api.flipdish.co/example"
},
"AppStoreName": {
"description": "App store name",
"type": "string",
"example": "Example Name"
},
"AppStorePrivacyUrl": {
"description": "App store privacy URL",
"type": "string",
"example": "https://api.flipdish.co/example"
},
"AppStoreSupportUrl": {
"description": "App store support URL",
"type": "string",
"example": "https://api.flipdish.co/example"
},
"AppStoreReleaseNotes": {
"description": "App store release notes",
"type": "string",
"example": "string"
},
"AppStoreIconUrl": {
"description": "App store icon URL",
"type": "string",
"example": "https://api.flipdish.co/example"
},
"AppStoreIconThumbnail100Url": {
"description": "App store icon thumbnail 100 URL",
"type": "string",
"example": "https://api.flipdish.co/example"
},
"TransparentLogoUrl": {
"description": "Transparent logo URL",
"type": "string",
"example": "https://api.flipdish.co/example"
},
"LogoImageName": {
"description": "Logo image name",
"type": "string",
"example": "Example Name"
},
"KioskNameScreenImage": {
"description": "Kiosk name screen image",
"type": "string",
"example": "Example Name"
},
"WebToAppRedirect": {
"format": "int32",
"description": "Web to app redirect",
"type": "integer",
"example": 1
},
"FeaturesCsv": {
"description": "Features CSV",
"type": "string",
"example": "string"
},
"AppStorePassword": {
"description": "App store password",
"type": "string",
"example": "string"
},
"AppStoreTeamId": {
"description": "App store team ID",
"type": "string",
"example": "500123"
},
"AppStoreAppGroup": {
"description": "App store app group",
"type": "string",
"example": "string"
},
"AppStoreSigningIdentity": {
"description": "App store signing identity",
"type": "string",
"example": "string"
},
"AppStoreItcTeamId": {
"description": "App store ITC team ID",
"type": "string",
"example": "500123"
},
"HeadHtml": {
"description": "Head HTML",
"type": "string",
"example": "string"
},
"SocialTwitterUrl": {
"description": "Social Twitter URL",
"type": "string",
"example": "https://api.flipdish.co/example"
},
"SocialFacebookUrl": {
"description": "Social Facebook URL",
"type": "string",
"example": "https://api.flipdish.co/example"
},
"SocialInstagramUrl": {
"description": "Social Instagram URL",
"type": "string",
"example": "https://api.flipdish.co/example"
},
"SocialPintrestUrl": {
"description": "Social Pinterest URL",
"type": "string",
"example": "https://api.flipdish.co/example"
},
"SocialTripAdvisorUrl": {
"description": "Social TripAdvisor URL",
"type": "string",
"example": "https://api.flipdish.co/example"
},
"SocialGooglePlusUrl": {
"description": "Social Google Plus URL",
"type": "string",
"example": "https://api.flipdish.co/example"
},
"SocialFourSquareUrl": {
"description": "Social FourSquare URL",
"type": "string",
"example": "https://api.flipdish.co/example"
},
"SocialYelpUrl": {
"description": "Social Yelp URL",
"type": "string",
"example": "https://api.flipdish.co/example"
},
"WebsiteType": {
"format": "int32",
"description": "Website type",
"type": "integer",
"example": 1
},
"ExternalOrderingPageUrl": {
"description": "External ordering page URL",
"type": "string",
"example": "https://api.flipdish.co/example"
},
"PanaceaEnabled": {
"description": "Panacea enabled",
"type": "boolean",
"example": true
},
"CookieConsentPromptEnabled": {
"description": "Cookie consent prompt enabled",
"type": "boolean",
"example": true
},
"PanaceaVanityUrl": {
"description": "Panacea vanity URL",
"type": "string",
"example": "https://api.flipdish.co/example"
},
"CountryId": {
"description": "Country ID",
"type": "string",
"example": "500123"
},
"ReferralUserId": {
"format": "int32",
"description": "Referral user ID",
"type": "integer",
"nullable": true,
"example": 500123
},
"ReferralCampaignId": {
"description": "Referral campaign ID",
"type": "string",
"example": "500123"
}
}
}