How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Flipdish Campaigns API

Operations for Campaigns.

Flipdish Campaigns API is one of 85 APIs that Flipdish publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Campaigns. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 10 operations across 8 paths, and defines 11 schemas. It is described by OpenAPI 3.0.3, at version v1.0.

Requests are made against a single base URL, https://api.flipdish.co.

10 operations 8 paths 11 schemas 1 DELETE5 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v1.0
Base URL
https://api.flipdish.co
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Flipdish Campaigns API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the implicit and clientCredentials flows, exposing 1 scope. By default, every request must be authenticated.

  • oauth2 — 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 bear…

Paths & Operations 10

Across 8 paths, the API surfaces 10 operations — 1 DELETE, 5 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Campaigns 10

Operations for Campaigns.

GET
/api/v1.0/{appId}/campaigns/loyalty
Flipdish Get Loyalty Campaigns for App
GetLoyaltyCampaignsForApp 1 param → 200400401403404500
POST
/api/v1.0/{appId}/campaigns/loyalty
Flipdish Create Loyalty Campaign
CreateLoyaltyCampaign 1 param body → 200400401403404500
GET
/api/v1.0/{appId}/campaigns/retention
Flipdish Get Retention Campaigns for App
GetRetentionCampaignsForApp 1 param → 200400401403404500
POST
/api/v1.0/{appId}/campaigns/retention
Flipdish Create Retention Campaign
CreateRetentionCampaign 1 param body → 200400401403404500
GET
/api/v1.0/{appId}/campaigns/loyalty/{storeId}
Flipdish Get Loyalty Campaigns for Store
GetLoyaltyCampaignsForStore 2 params → 200400401403404500
GET
/api/v1.0/{appId}/campaigns/retention/{storeId}
Flipdish Get Retention Campaigns for Store
GetRetentionCampaignsForStore 2 params → 200400401403404500
GET
/api/v1.0/{appId}/campaigns/stores
Flipdish Get Store List
GetStoreList 2 params → 200400401403404500
POST
/api/v1.0/{appId}/campaigns/loyalty/{campaignId}
Flipdish Update Loyalty Campaign
UpdateLoyaltyCampaign 2 params body → 200400401403404500
POST
/api/v1.0/{appId}/campaigns/retention/{campaignId}
Flipdish Update Retention Campaign
UpdateRetentionCampaign 2 params body → 200400401403404500
DELETE
/api/v1.0/{appId}/campaigns/{campaignId}
Flipdish Remove Campaign
RemoveCampaign 2 params → 200400401403404500

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are LoyaltyCampaign (17 properties), RetentionCampaign (16 properties), StoreListItem (7 properties), CampaignStatistics (5 properties). Each schema is shown below with its type and property counts.

RestApiArrayResult_StoreListItem_
object
Rest api array result
1 property 1 required
RestApiResult_RetentionCampaign_
object
Rest api result
1 property 1 required
CampaignStatistics
object
Campaign statistics
5 properties
RetentionCampaign
object
Retention campaign
16 properties
RestApiArrayResult_RetentionCampaign_
object
Rest api array result
1 property 1 required
RestApiResult_LoyaltyCampaign_
object
Rest api result
1 property 1 required
StoreCampaignStartTime
object
Store campaign start time
2 properties
FlipdishError
object
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.…
1 property
LoyaltyCampaign
object
Loyalty campaign
17 properties
RestApiArrayResult_LoyaltyCampaign_
object
Rest api array result
1 property 1 required
StoreListItem
object
Store id and name
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

flipdish-campaigns-api-openapi.yml Raw ↑

Other APIs Flipdish publishes across the network.

Flipdish Accounts API
Flipdish Address API
Flipdish Apm API
Flipdish Apps API
Flipdish AppStore API
Flipdish AppStoreConfigurations API
Flipdish AppStoreDeveloper API
Flipdish AppStoreEntitlements API
Flipdish AuditLogs API
Flipdish AuthorizationTokens API
Flipdish BankAccount API
Flipdish CardReaders API
Where this information came from

This is an independent, third-party profile of Flipdish Campaigns API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.