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

Manage automated multi-step sequences and their contacts.

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

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

This API exposes 6 operations across 4 paths, and defines 14 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.

6 operations 4 paths 14 schemas 1 DELETE4 GET1 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 Sequences 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 6

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

Sequences 6

Manage automated multi-step sequences and their contacts.

GET
/sequences
List sequences
getSequences 2 params → 200401
GET
/sequences/{id}
Show a sequence
getSequence 1 param → 200401
GET
/sequences/{id}/contacts
List sequence contacts
getSequenceContacts 3 params → 200401
POST
/sequences/{id}/contacts
Add contacts to a sequence
createSequenceContacts 1 param body → 202401422
DELETE
/sequences/{id}/contacts
Remove contacts from a sequence
removeSequenceContacts 1 param body → 202401
GET
/sequences/runs
List sequence runs
getSequenceRuns 2 params → 200401

Schemas 14

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

Sequence
object
6 properties
Address
object
6 properties
CreateContactRequest
object
11 properties 1 required
SequenceList
object
2 properties
ContactList
object
2 properties
Error
object
2 properties
SequenceStep
object
4 properties
AcceptedResponse
object
1 property
CreateSequenceContactsRequest
object
6 properties 1 required
SequenceRun
object
5 properties
Contact
object
12 properties
BirthDate
object
3 properties
CommunicationPreference
object
3 properties
OptInChannel
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

whippy-sequences-api-openapi.yml Raw ↑

Other APIs Whippy publishes across the network.

Whippy Campaigns API
Whippy Channels API
Whippy Contacts API
Whippy Conversations API
Whippy Messaging API
Whippy Webhooks API