Flipdish WhiteLabelConfig API
Operations for White Label Config.
OpenAPI Specification
openapi: 3.0.3
info:
title: Flipdish API - Apps Accounts WhiteLabelConfig API
version: v1.0
description: Flipdish Open API v1.0 — Apps operations. Flipdish is an online ordering and branded-app platform for restaurants and takeaways. This specification was derived from the official Flipdish Swagger document and grouped by resource domain.
contact:
name: Flipdish Support
email: help@flipdish.com
url: https://help.flipdish.com
x-generated-from: https://api.flipdish.co/swagger/docs/v1.0
x-last-validated: '2026-06-02'
servers:
- url: https://api.flipdish.co
description: Flipdish production API
security:
- oauth2:
- api
tags:
- name: WhiteLabelConfig
description: Operations for White Label Config.
paths:
/api/v1.0/whitelabelconfig/health:
get:
tags:
- WhiteLabelConfig
operationId: HealthCheck
responses:
'200':
description: OK
content:
application/json:
schema:
type: string
examples:
HealthCheck200Example:
summary: Default HealthCheck 200 response
x-microcks-default: true
value: string
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
HealthCheck400Example:
summary: Default HealthCheck 400 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'401':
description: Authentication has been denied for this request.
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
HealthCheck401Example:
summary: Default HealthCheck 401 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'403':
description: Successful authentication, but authorization has been denied for this request.
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
HealthCheck403Example:
summary: Default HealthCheck 403 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
HealthCheck500Example:
summary: Default HealthCheck 500 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
security:
- oauth2:
- api
summary: Flipdish Health Check
description: Health Check via the Flipdish Open API v1.0 (GET /api/v1.0/whitelabelconfig/health).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/whitelabelconfig/id/{wlid}:
get:
tags:
- WhiteLabelConfig
operationId: GetWhiteLabelConfig
parameters:
- name: wlid
in: path
required: true
schema:
type: integer
format: int32
description: The wlid path parameter.
example: 500123
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiResult_WhiteLabelConfigModel_'
examples:
GetWhiteLabelConfig200Example:
summary: Default GetWhiteLabelConfig 200 response
x-microcks-default: true
value:
Data:
WhiteLabelLanguages: []
WhiteLabelAssets: []
ColorScheme:
WhiteLabelColorSchemeId: 500123
Font: string
Color: string
Color2: string
Color3: string
Color4: string
Color5: string
Color6: string
Color7: string
Color8: string
Color9: string
Color10: string
Color11: string
Color12: string
WhiteLabelConfigId: 500123
WhiteLabelId: 500123
WhiteLabelName: Example Name
AppNameId: '500123'
OrgId: '500123'
SmsRestaurantName: Example Name
DeepLinkUrlScheme: https://api.flipdish.co/example
HostName: Example Name
NexmoSupportSmsNumber: string
TwilioSupportSmsNumber: string
MixpanelToken: string
IntercomAppId: '500123'
ShareMessageEmailSubject: owner@example.com
ShareMessageEmailMessage: owner@example.com
ShareMessageSmsMessage: string
ShareMessageWhatsAppMessage: string
ShareMessageFacebookMessage: string
ShareMessageTwitterMessage: string
ShareMessageGenericMessage: string
DisplayDeliveryRestaurantListScreen: true
ContactFormType: 1
ContactPhoneNumber: '+353000000000'
DisplayBumpSideMenuItem: true
DisplayFreeCokeSideMenuItem: true
AppStoreUrl: https://api.flipdish.co/example
DeliveryEnabled: true
PickupEnabled: true
DisplayPickupRestaurantListScreen: true
DisplayCuisineTypeListAndRestaurantSearchBar: true
DisplayUserRestaurantRatings: true
ReadyToPublishWeb: true
ReadyToPublishIos: true
ReadyToPublishAndroid: true
DisplayFooterLinksToOtherSites: true
DisplayOnlineOrderingMenu: true
HideAppConfigFromAdminList: true
ComplianceType: Default
IsMenuMigratedToRms: true
MapBoundryMaxLongitude: 1.0
MapBoundryMinLongitude: 1.0
MapBoundryMaxLatitude: 1.0
MapBoundryMinLatitude: 1.0
AppStoreAppleId: '500123'
AppStoreToken: string
WebsiteDisplayStaticMenuPage: true
IsEmbed: true
DisplayTipOptionToUsersByDefault: true
EmailRequestMode: 1
AddressEntryType: 1
AddressLayout: 1
Category: 1
MapCenterLatitude: 1.0
MapCenterLongitude: 1.0
IntercomTokenIos: string
IntercomTokenAndroid: '500123'
GoogleAnalyticsTokensCsv: string
FacebookTokensCsv: string
ShareMessageGenericUrl: https://api.flipdish.co/example
PrivateSupportEmailAddress: owner@example.com
AppStoreId: '500123'
PlayConsoleAccount: 3
ApnCertificateValidAfter: '2026-06-02T12:00:00Z'
ApnCertificateValidBefore: '2026-06-02T12:00:00Z'
DineInEnabled: true
AppFont: string
WhiteLabelColorSchemeId: 500123
WhiteLabelImagesId: 500123
AppStoreCopyright: string
AppStoreDescription: string
AppStoreShortDescription: string
AppStoreKeywords: string
AppStoreMarketingUrl: https://api.flipdish.co/example
AppStoreName: Example Name
AppStorePrivacyUrl: https://api.flipdish.co/example
AppStoreSupportUrl: https://api.flipdish.co/example
AppStoreReleaseNotes: string
AppStoreIconUrl: https://api.flipdish.co/example
AppStoreIconThumbnail100Url: https://api.flipdish.co/example
TransparentLogoUrl: https://api.flipdish.co/example
LogoImageName: Example Name
KioskNameScreenImage: Example Name
WebToAppRedirect: 1
FeaturesCsv: string
AppStorePassword: string
AppStoreTeamId: '500123'
AppStoreAppGroup: string
AppStoreSigningIdentity: string
AppStoreItcTeamId: '500123'
HeadHtml: string
SocialTwitterUrl: https://api.flipdish.co/example
SocialFacebookUrl: https://api.flipdish.co/example
SocialInstagramUrl: https://api.flipdish.co/example
SocialPintrestUrl: https://api.flipdish.co/example
SocialTripAdvisorUrl: https://api.flipdish.co/example
SocialGooglePlusUrl: https://api.flipdish.co/example
SocialFourSquareUrl: https://api.flipdish.co/example
SocialYelpUrl: https://api.flipdish.co/example
WebsiteType: 1
ExternalOrderingPageUrl: https://api.flipdish.co/example
PanaceaEnabled: true
CookieConsentPromptEnabled: true
PanaceaVanityUrl: https://api.flipdish.co/example
CountryId: '500123'
ReferralUserId: 500123
ReferralCampaignId: '500123'
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetWhiteLabelConfig400Example:
summary: Default GetWhiteLabelConfig 400 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetWhiteLabelConfig401Example:
summary: Default GetWhiteLabelConfig 401 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'403':
description: Successful authentication, but authorization has been denied for this request.
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetWhiteLabelConfig403Example:
summary: Default GetWhiteLabelConfig 403 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'404':
description: NotFound
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetWhiteLabelConfig404Example:
summary: Default GetWhiteLabelConfig 404 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetWhiteLabelConfig500Example:
summary: Default GetWhiteLabelConfig 500 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
security:
- oauth2:
- api
summary: Flipdish Get White Label Config
description: Get White Label Config via the Flipdish Open API v1.0 (GET /api/v1.0/whitelabelconfig/id/{wlid}).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/whitelabelconfig/name/{appId}:
get:
tags:
- WhiteLabelConfig
operationId: GetWhiteLabelConfigByAppNameId
parameters:
- name: appId
in: path
required: true
schema:
type: string
description: The app id path parameter.
example: '500123'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiResult_WhiteLabelConfigModel_'
examples:
GetWhiteLabelConfigByAppNameId200Example:
summary: Default GetWhiteLabelConfigByAppNameId 200 response
x-microcks-default: true
value:
Data:
WhiteLabelLanguages: []
WhiteLabelAssets: []
ColorScheme:
WhiteLabelColorSchemeId: 500123
Font: string
Color: string
Color2: string
Color3: string
Color4: string
Color5: string
Color6: string
Color7: string
Color8: string
Color9: string
Color10: string
Color11: string
Color12: string
WhiteLabelConfigId: 500123
WhiteLabelId: 500123
WhiteLabelName: Example Name
AppNameId: '500123'
OrgId: '500123'
SmsRestaurantName: Example Name
DeepLinkUrlScheme: https://api.flipdish.co/example
HostName: Example Name
NexmoSupportSmsNumber: string
TwilioSupportSmsNumber: string
MixpanelToken: string
IntercomAppId: '500123'
ShareMessageEmailSubject: owner@example.com
ShareMessageEmailMessage: owner@example.com
ShareMessageSmsMessage: string
ShareMessageWhatsAppMessage: string
ShareMessageFacebookMessage: string
ShareMessageTwitterMessage: string
ShareMessageGenericMessage: string
DisplayDeliveryRestaurantListScreen: true
ContactFormType: 1
ContactPhoneNumber: '+353000000000'
DisplayBumpSideMenuItem: true
DisplayFreeCokeSideMenuItem: true
AppStoreUrl: https://api.flipdish.co/example
DeliveryEnabled: true
PickupEnabled: true
DisplayPickupRestaurantListScreen: true
DisplayCuisineTypeListAndRestaurantSearchBar: true
DisplayUserRestaurantRatings: true
ReadyToPublishWeb: true
ReadyToPublishIos: true
ReadyToPublishAndroid: true
DisplayFooterLinksToOtherSites: true
DisplayOnlineOrderingMenu: true
HideAppConfigFromAdminList: true
ComplianceType: Default
IsMenuMigratedToRms: true
MapBoundryMaxLongitude: 1.0
MapBoundryMinLongitude: 1.0
MapBoundryMaxLatitude: 1.0
MapBoundryMinLatitude: 1.0
AppStoreAppleId: '500123'
AppStoreToken: string
WebsiteDisplayStaticMenuPage: true
IsEmbed: true
DisplayTipOptionToUsersByDefault: true
EmailRequestMode: 1
AddressEntryType: 1
AddressLayout: 1
Category: 1
MapCenterLatitude: 1.0
MapCenterLongitude: 1.0
IntercomTokenIos: string
IntercomTokenAndroid: '500123'
GoogleAnalyticsTokensCsv: string
FacebookTokensCsv: string
ShareMessageGenericUrl: https://api.flipdish.co/example
PrivateSupportEmailAddress: owner@example.com
AppStoreId: '500123'
PlayConsoleAccount: 3
ApnCertificateValidAfter: '2026-06-02T12:00:00Z'
ApnCertificateValidBefore: '2026-06-02T12:00:00Z'
DineInEnabled: true
AppFont: string
WhiteLabelColorSchemeId: 500123
WhiteLabelImagesId: 500123
AppStoreCopyright: string
AppStoreDescription: string
AppStoreShortDescription: string
AppStoreKeywords: string
AppStoreMarketingUrl: https://api.flipdish.co/example
AppStoreName: Example Name
AppStorePrivacyUrl: https://api.flipdish.co/example
AppStoreSupportUrl: https://api.flipdish.co/example
AppStoreReleaseNotes: string
AppStoreIconUrl: https://api.flipdish.co/example
AppStoreIconThumbnail100Url: https://api.flipdish.co/example
TransparentLogoUrl: https://api.flipdish.co/example
LogoImageName: Example Name
KioskNameScreenImage: Example Name
WebToAppRedirect: 1
FeaturesCsv: string
AppStorePassword: string
AppStoreTeamId: '500123'
AppStoreAppGroup: string
AppStoreSigningIdentity: string
AppStoreItcTeamId: '500123'
HeadHtml: string
SocialTwitterUrl: https://api.flipdish.co/example
SocialFacebookUrl: https://api.flipdish.co/example
SocialInstagramUrl: https://api.flipdish.co/example
SocialPintrestUrl: https://api.flipdish.co/example
SocialTripAdvisorUrl: https://api.flipdish.co/example
SocialGooglePlusUrl: https://api.flipdish.co/example
SocialFourSquareUrl: https://api.flipdish.co/example
SocialYelpUrl: https://api.flipdish.co/example
WebsiteType: 1
ExternalOrderingPageUrl: https://api.flipdish.co/example
PanaceaEnabled: true
CookieConsentPromptEnabled: true
PanaceaVanityUrl: https://api.flipdish.co/example
CountryId: '500123'
ReferralUserId: 500123
ReferralCampaignId: '500123'
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetWhiteLabelConfigByAppNameId400Example:
summary: Default GetWhiteLabelConfigByAppNameId 400 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetWhiteLabelConfigByAppNameId401Example:
summary: Default GetWhiteLabelConfigByAppNameId 401 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'403':
description: Successful authentication, but authorization has been denied for this request.
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetWhiteLabelConfigByAppNameId403Example:
summary: Default GetWhiteLabelConfigByAppNameId 403 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'404':
description: NotFound
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetWhiteLabelConfigByAppNameId404Example:
summary: Default GetWhiteLabelConfigByAppNameId 404 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetWhiteLabelConfigByAppNameId500Example:
summary: Default GetWhiteLabelConfigByAppNameId 500 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
security:
- oauth2:
- api
summary: Flipdish Get White Label Config by App Name Id
description: Get White Label Config by App Name Id via the Flipdish Open API v1.0 (GET /api/v1.0/whitelabelconfig/name/{appId}).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/whitelabelconfig/{appId}/general:
get:
tags:
- WhiteLabelConfig
operationId: GetAppGeneralConfig
parameters:
- name: appId
in: path
required: true
schema:
type: string
description: The app id path parameter.
example: '500123'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiResult_AppGeneralConfigModel_'
examples:
GetAppGeneralConfig200Example:
summary: Default GetAppGeneralConfig 200 response
x-microcks-default: true
value:
Data:
WhiteLabelId: 500123
DeepLinkUrlScheme: https://api.flipdish.co/example
SmsRestaurantName: Example Name
NexmoSupportSmsNumber: string
TwilioSupportSmsNumber: string
FallbackPhoneNumberPrefix: '+353000000000'
AutocompletePhoneNumberLength: 3
ContactFormType: string
PrivateSupportEmailAddress: owner@example.com
ContactPhoneNumber: '+353000000000'
DeliveryEnabled: true
PickupEnabled: true
DineInEnabled: true
DisplayDeliveryRestaurantListScreen: true
DisplayPickupRestaurantListScreen: true
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetAppGeneralConfig400Example:
summary: Default GetAppGeneralConfig 400 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetAppGeneralConfig401Example:
summary: Default GetAppGeneralConfig 401 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'403':
description: Successful authentication, but authorization has been denied for this request.
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetAppGeneralConfig403Example:
summary: Default GetAppGeneralConfig 403 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'404':
description: NotFound
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetAppGeneralConfig404Example:
summary: Default GetAppGeneralConfig 404 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetAppGeneralConfig500Example:
summary: Default GetAppGeneralConfig 500 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
security:
- oauth2:
- api
summary: Flipdish Get App General Config
description: Get App General Config via the Flipdish Open API v1.0 (GET /api/v1.0/whitelabelconfig/{appId}/general).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
post:
tags:
- WhiteLabelConfig
operationId: UpdateAppGeneralConfig
parameters:
- name: appId
in: path
required: true
schema:
type: string
description: The app id path parameter.
example: '500123'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AppGeneralConfigModel'
examples:
UpdateAppGeneralConfigRequestExample:
summary: Default UpdateAppGeneralConfig request
x-microcks-default: true
value:
WhiteLabelId: 500123
DeepLinkUrlScheme: https://api.flipdish.co/example
SmsRestaurantName: Example Name
NexmoSupportSmsNumber: string
TwilioSupportSmsNumber: string
FallbackPhoneNumberPrefix: '+353000000000'
AutocompletePhoneNumberLength: 3
ContactFormType: string
PrivateSupportEmailAddress: owner@example.com
ContactPhoneNumber: '+353000000000'
DeliveryEnabled: true
PickupEnabled: true
DineInEnabled: true
DisplayDeliveryRestaurantListScreen: true
DisplayPickupRestaurantListScreen: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiResult_AppGeneralConfigModel_'
examples:
UpdateAppGeneralConfig200Example:
summary: Default UpdateAppGeneralConfig 200 response
x-microcks-default: true
value:
Data:
WhiteLabelId: 500123
DeepLinkUrlScheme: https://api.flipdish.co/example
SmsRestaurantName: Example Name
NexmoSupportSmsNumber: string
TwilioSupportSmsNumber: string
FallbackPhoneNumberPrefix: '+353000000000'
AutocompletePhoneNumberLength: 3
ContactFormType: string
PrivateSupportEmailAddress: owner@example.com
ContactPhoneNumber: '+353000000000'
DeliveryEnabled: true
PickupEnabled: true
DineInEnabled: true
DisplayDeliveryRestaurantListScreen: true
DisplayPickupRestaurantListScreen: true
'400':
description: BadRequest
con
# --- truncated at 32 KB (86 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/openapi/flipdish-whitelabelconfig-api-openapi.yml