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 Contacts API

Manage contacts and communication preferences.

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

Tagged areas include Contacts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 10 operations across 7 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.

10 operations 7 paths 11 schemas 1 DELETE3 GET4 POST2 PUT

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 Contacts 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 10

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

Contacts 10

Manage contacts and communication preferences.

GET
/contacts
List contacts
getContacts 2 params → 200401
POST
/contacts
Create a contact
createContact body → 201401422
GET
/contacts/{id}
Show a contact
getContact 1 param → 200401
PUT
/contacts/{id}
Update a contact
updateContact 1 param body → 200401422
DELETE
/contacts/{id}
Delete a contact
deleteContact 1 param → 200401
POST
/contacts/search
Search contacts
searchContacts body → 200401
PUT
/contacts/upsert
Upsert contacts
upsertContacts body → 202401
GET
/contacts/{id}/communication_preferences
List a contact's communication preferences
getContactCommunicationPreferences 1 param → 200401
POST
/contacts/{id}/communication_preferences/opt_in
Opt a contact into a channel
optInCommunicationPreference 1 param body → 200401
POST
/contacts/{id}/communication_preferences/opt_out
Opt a contact out of a channel
optOutCommunicationPreference 1 param body → 200401

Schemas 11

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

Address
object
6 properties
CreateContactRequest
object
11 properties 1 required
Contact
object
12 properties
OptInChannel
object
2 properties
BirthDate
object
3 properties
ContactResponse
object
1 property
OptPreferenceRequest
object
2 properties
ContactList
object
2 properties
CommunicationPreference
object
3 properties
AcceptedResponse
object
1 property
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

whippy-contacts-api-openapi.yml Raw ↑

Other APIs Whippy publishes across the network.

Whippy Campaigns API
Whippy Channels API
Whippy Conversations API
Whippy Messaging API
Whippy Sequences API
Whippy Webhooks API