The complete Vibes Platform REST API as Vibes publishes it — 48 paths and 75 operations across the Acquisition Campaign, Broadcast, Callback, Event, Event-Triggered Campaign, Incentive Code, Incentive Pool, Person, Push Device Manager, Source Code, Subscription, Subscription List, Wallet Campaign, Wallet Messaging, Android/iOS Wallet Template, Wallet Location Selector and Wallet Store Location APIs. HTTP Basic authentication, JSON only, versioned by the X-API-Version header, with US and EU regional hosts.
Vibes Platform API is one of 12 APIs that Vibes Platform publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Mobile Messaging, SMS, MMS, Push Notifications, and Wallet Passes. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
75 operations
across 48 paths,
organized into 18 resource areas,
and defines 85 schemas.
It is described by OpenAPI 3.0.0, at version 1.0.0.
Requests are made against 2 base URLs: https://public-api.vibescm.com, https://public-api.eu.vibes.com/.
75 operations48 paths85 schemas8 DELETE39 GET17 POST11 PUT
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://public-api.vibescm.com
Authentication
HTTP Basic
Resource Areas
18
Authentication & Security 1
Vibes Platform API declares
1 security scheme
for authenticating requests.
It accepts HTTP basic authentication (basicAuth).
By default, every request must be authenticated.
Paths & Operations 75
Across 48 paths, the API surfaces 75 operations — 8 DELETE, 39 GET, 17 POST, 11 PUT. They span 18 resource areas, including Acquisition Campaign API, Broadcast API, Callback API, Event API, Event-Triggered Campaign API, Incentive Code API, Incentive Pool API, Person API, and 10 more. Each is listed below with its method, path, parameters, and response codes.
Manage mobile wallet campaigns and the individual wallet items (passes) issued from them. A wallet campaign is the container for a single offer, loyalty card, or event ticket prog…
Send push-style messages to the holders of a wallet campaign's passes and review messages that have already been sent. Messages can be targeted to specific recipients with filters…
Define the design and content of the Google Wallet (Android) pass for a wallet campaign. Each campaign has a single Google Wallet template whose fields map to Google Wallet pass c…
Define the design and content of the Apple Wallet (iOS) pass for a wallet campaign. Each campaign has a single Apple Wallet (passbook) template whose fields map to PassKit pass co…
Manage the store locations attached to a wallet campaign. Locations drive geofenced lock-screen notifications that remind pass holders about a nearby store.
The contract defines 85 schemas that model the data the API accepts and returns. The most detailed are googleWalletTemplateBody (32 properties), callbackResponse (19 properties), appleWalletTemplateBody (15 properties), pushDeviceResponse (13 properties). Each schema is shown below with its type and property counts.
acquisitionResponse
object
10 properties
acquisitionsResponse
array
acquisitionParticipantResponse
object
4 properties
acquisitionParticipantsResponse
array
addParticipantRequest
object
4 properties
addParticipantResponse
object
4 properties
broadcastRequest
object
4 properties2 required
broadcastResponse
object
7 properties
broadcastsResponse
array
callbackResponse
object
19 properties
callbacksResponse
array
testcallbackRequest
object
8 properties1 required
callbackRequest-Ack
object
6 properties2 required
callbackRequest-Event
object
5 properties3 required
callbackRequest-Person
object
4 properties2 required
callbackRequest-Push
object
7 properties2 required
callbackRequest-Sub
object
6 properties2 required
callbackRequest-SubList
object
4 properties2 required
callbackRequest-Unmatched
object
5 properties3 required
callbackRequest-Wallet
object
6 properties2 required
testCallbackResponse
object
2 properties
eventRequest
object
3 properties2 required
eventResponse
object
1 property
eventTriggeredResponse
object
8 properties
eventTriggeredsResponse
array
eventTriggeredRequest
object
5 properties4 required
eventTriggeredRequestMMS
object
5 properties4 required
eventTriggeredRequestPush
object
5 properties4 required
incentivePoolResponse
object
10 properties
incentivePoolsResponse
array
incentivePoolRequest
object
6 properties6 required
incentiveCodeResponse
object
7 properties
incentiveCodeIssuanceRequest
object
4 properties
incentiveCodeIssuanceResponse
object
9 properties
incentiveCodeIssuancesResponse
array
personResponse
object
7 properties
personsResponse
array
personRequest
object
3 properties
pushDeviceResponse
object
13 properties
pushDevicesResponse
array
assignPushDeviceRequest
object
One of externalpersonid OR personkey is required.
2 properties
sourceCodeResponse
object
7 properties
sourceCodesResponse
array
subscriptionResponse
object
6 properties
subscriptionsResponse
array
subscriptionListResponse
object
5 properties
subscriptionListsResponse
array
walletCampaignRequest
object
1 property1 required
walletCampaignResponse
object
12 properties
walletCampaignsResponse
array
walletItemRequest
object
4 properties
walletItemResponse
object
12 properties
walletItemsResponse
array
walletMessageRequest
object
2 properties1 required
walletMessageResponse
object
7 properties
walletMessagesResponse
array
locationSelectorBody
object
Branding for the "Add to Wallet" landing page a customer sees before the pass is generated — the page where they pick their store location (drawn from the camp…
6 properties
locationSelectorRequest
object
1 property1 required
locationSelectorResponse
walletLocation
object
A store location attached to a wallet campaign.
12 properties
walletLocationResponse
walletLocationsResponse
array
walletLocationsBulkRequest
object
1 property1 required
googleWalletTemplateBody
object
Design and content of a Google Wallet (Android) pass. Google models three pass kinds — Offer, Loyalty, and Event Ticket — that share a common frame; field sema…
32 properties
androidTemplateRequest
object
1 property1 required
androidTemplateResponse
appleWalletTemplateBody
object
Design and content of an Apple Wallet (iOS) pass — a card with a front and a back whose fields map to fixed regions on the card. Field semantics follow Apple W…
15 properties
passbookField
object
A single label/value entry within an Apple Wallet pass field region.
3 properties
iosTemplateRequest
object
1 property1 required
iosTemplateResponse
mmsurl
object
2 properties
mmstext
object
2 properties
filters-number
number
filters-string
string
wallet-filters
object
3 properties
wallet-filters-any
object
3 properties
first-class-filters
object
Learn more about first-class fields.
4 properties
first-class-filters-any
object
Learn more about first-class fields.
4 properties
testcallbackRequest-Ack
object
2 properties1 required
testcallbackRequest-Event
object
2 properties1 required
testcallbackRequest-Person
object
2 properties1 required
testcallbackRequest-Push
object
3 properties1 required
testcallbackRequest-Sub
object
2 properties1 required
testcallbackRequest-SubList
object
2 properties1 required
testcallbackRequest-Wallet
object
1 property1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Vibes Platform 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.
