Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Whippy Messaging API

Send SMS / MMS, email, and fax messages.

Whippy Messaging API is one of 7 APIs that Whippy publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Messaging. 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 11 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.

4 operations 4 paths 11 schemas 4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api.whippy.co/v1
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Whippy Messaging 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 — 4 POST. Each is listed below with its method, path, parameters, and response codes.

Messaging 4

Send SMS / MMS, email, and fax messages.

POST
/messaging/sms
Send an SMS / MMS
sendSms body → 201401422
POST
/messaging/email
Send an email
sendEmail body → 201401422
POST
/messaging/fax
Send a fax
sendFax body → 201401422
POST
/messaging/sms/campaign
Send an SMS campaign
sendCampaign body → 202401422

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are SendEmailRequest (14 properties), CreateContactRequest (11 properties), SendSmsRequest (8 properties), Address (6 properties). Each schema is shown below with its type and property counts.

SendMessageResponse
object
1 property
Address
object
6 properties
CreateContactRequest
object
11 properties 1 required
SendEmailRequest
object
14 properties 2 required
OptInChannel
object
2 properties
SendCampaignRequest
object
6 properties 3 required
BirthDate
object
3 properties
Error
object
2 properties
AcceptedResponse
object
1 property
SendFaxRequest
object
4 properties 3 required
SendSmsRequest
object
8 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

whippy-messaging-api-openapi.yml Raw ↑

Other APIs Whippy publishes across the network.

Whippy Campaigns API
Whippy Channels API
Whippy Contacts API
Whippy Conversations API
Whippy Sequences API
Whippy Webhooks API