Whippy Campaigns API
Send campaigns and inspect campaign analytics.
Whippy Campaigns API is one of 7 APIs that Whippy 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, API documentation, and an API reference.
This API exposes 4 operations across 4 paths, and defines 12 schemas. It is described by OpenAPI 3.0.1, at version 1.0.
Requests are made against a single base URL, https://api.whippy.co/v1.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Whippy Campaigns API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as X-WHIPPY-KEY (WhippyApiKey).
By default, every request must be authenticated.
WhippyApiKey— Organization API key. Generated in the Whippy app under Settings Developers. OAuth 2.0 bearer tokens are also accepted via the Authorization header.
Paths & Operations 4
Across 4 paths, the API surfaces 4 operations — 3 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Send campaigns and inspect campaign analytics.
Schemas 12
The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are Contact (12 properties), CreateContactRequest (11 properties), Campaign (8 properties), Address (6 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Whippy 6
Other APIs Whippy publishes across the network.