Flipdish Push Notifications API
Operations for Push Notifications.
Operations for Push Notifications.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/flipdish-push-notifications-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Flipdish API - Marketing Push Notifications API
version: v1.0
description: Flipdish Open API v1.0 — Marketing 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: Push Notifications
description: Operations for Push Notifications.
paths:
/api/v1.0/{appId}/pushnotifications:
get:
tags:
- Push Notifications
operationId: GetPushNotifications
parameters:
- name: appId
in: path
required: true
schema:
type: string
description: The app id path parameter.
example: '500123'
- name: page
in: query
required: false
schema:
type: integer
format: int32
description: The page query parameter.
example: 1
- name: limit
in: query
required: false
schema:
type: integer
format: int32
description: The limit query parameter.
example: 1
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiPaginationResult_PushNotificationResponse_'
examples:
GetPushNotifications200Example:
summary: Default GetPushNotifications 200 response
x-microcks-default: true
value:
Page: 1
Limit: 1
TotalRecordCount: 12.5
Data: []
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetPushNotifications400Example:
summary: Default GetPushNotifications 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:
GetPushNotifications401Example:
summary: Default GetPushNotifications 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:
GetPushNotifications403Example:
summary: Default GetPushNotifications 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:
GetPushNotifications500Example:
summary: Default GetPushNotifications 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 Push Notifications
description: Get Push Notifications via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/pushnotifications).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
post:
tags:
- Push Notifications
operationId: SchedulePushNotification
parameters:
- name: appId
in: path
required: true
schema:
type: string
description: The app id path parameter.
example: '500123'
requestBody:
required: false
content: {}
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiResult_PushNotificationResponse_'
examples:
SchedulePushNotification200Example:
summary: Default SchedulePushNotification 200 response
x-microcks-default: true
value:
Data:
Sent: true
ScheduledPushNotificationId: 500123
ScheduledTime: '2026-06-02T12:00:00Z'
Title: string
Message: string
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
SchedulePushNotification400Example:
summary: Default SchedulePushNotification 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:
SchedulePushNotification401Example:
summary: Default SchedulePushNotification 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:
SchedulePushNotification403Example:
summary: Default SchedulePushNotification 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:
SchedulePushNotification500Example:
summary: Default SchedulePushNotification 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 Schedule Push Notification
description: Schedule Push Notification via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/pushnotifications).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/{appId}/pushnotifications/{scheduledPushNotificationId}:
post:
tags:
- Push Notifications
operationId: UpdatePushNotification
parameters:
- name: appId
in: path
required: true
schema:
type: string
description: The app id path parameter.
example: '500123'
- name: scheduledPushNotificationId
in: path
required: true
schema:
type: integer
format: int32
description: The scheduled push notification id path parameter.
example: 500123
requestBody:
required: false
content: {}
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiResult_PushNotificationResponse_'
examples:
UpdatePushNotification200Example:
summary: Default UpdatePushNotification 200 response
x-microcks-default: true
value:
Data:
Sent: true
ScheduledPushNotificationId: 500123
ScheduledTime: '2026-06-02T12:00:00Z'
Title: string
Message: string
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
UpdatePushNotification400Example:
summary: Default UpdatePushNotification 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:
UpdatePushNotification401Example:
summary: Default UpdatePushNotification 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:
UpdatePushNotification403Example:
summary: Default UpdatePushNotification 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:
UpdatePushNotification500Example:
summary: Default UpdatePushNotification 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 Update Push Notification
description: Update Push Notification via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/pushnotifications/{scheduledPushNotificationId}).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
delete:
tags:
- Push Notifications
operationId: DeletePushNotification
parameters:
- name: appId
in: path
required: true
schema:
type: string
description: The app id path parameter.
example: '500123'
- name: scheduledPushNotificationId
in: path
required: true
schema:
type: integer
format: int32
description: The scheduled push notification id path parameter.
example: 500123
responses:
'200':
description: OK
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
DeletePushNotification400Example:
summary: Default DeletePushNotification 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:
DeletePushNotification401Example:
summary: Default DeletePushNotification 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:
DeletePushNotification403Example:
summary: Default DeletePushNotification 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:
DeletePushNotification500Example:
summary: Default DeletePushNotification 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 Delete Push Notification
description: Delete Push Notification via the Flipdish Open API v1.0 (DELETE /api/v1.0/{appId}/pushnotifications/{scheduledPushNotificationId}).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
components:
schemas:
RestApiResult_PushNotificationResponse_:
description: Rest api result
required:
- Data
type: object
properties:
Data:
$ref: '#/components/schemas/PushNotificationResponse'
FlipdishError:
type: object
description: Standard Flipdish API error response. Errors are returned as a JSON object with a human-readable message and a programmatic error code (see https://developers.flipdish.com/docs/error-handling).
properties:
error:
type: object
description: Error detail object.
properties:
errorMessage:
type: string
description: Descriptive explanation of the issue.
example: Invalid or missing parameters.
errorCode:
type: string
description: Unique identifier for programmatic error handling.
example: BadRequest
details:
type: string
description: Additional context returned in non-production environments.
example: Validation failed for field 'storeId'.
PushNotificationResponse:
description: Push Notification
required:
- Message
type: object
properties:
Sent:
description: Sent
type: boolean
example: true
ScheduledPushNotificationId:
format: int32
description: Push notification identifier
type: integer
example: 500123
ScheduledTime:
format: date-time
description: UTC Time at which to send the push notification
type: string
example: '2026-06-02T12:00:00Z'
Title:
description: Title of the notification
type: string
example: string
Message:
description: Message of the notification
type: string
example: string
RestApiPaginationResult_PushNotificationResponse_:
description: Rest api pagination result
required:
- Page
- Limit
- TotalRecordCount
- Data
type: object
properties:
Page:
format: int32
description: Current page index
type: integer
example: 1
Limit:
format: int32
description: Current page size
type: integer
example: 1
TotalRecordCount:
format: int32
description: Total record count
type: integer
example: 12.5
Data:
description: Generic data object.
type: array
items:
$ref: '#/components/schemas/PushNotificationResponse'
example: []
securitySchemes:
oauth2:
type: oauth2
description: OAuth 2.0. Implicit grant for first-party portal apps; client credentials grant for server-to-server App Store apps (exchange Client ID + Secret Key for a bearer access token).
flows:
implicit:
authorizationUrl: https://api.flipdish.co/identity/connect/authorize
scopes:
api: Access to the Flipdish API
clientCredentials:
tokenUrl: https://api.flipdish.co/identity/connect/token
scopes:
api: Access to the Flipdish API