How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

SuprSend Workflow API

The Workflow API from SuprSend — 4 operation(s) for workflow.

SuprSend Workflow API is one of 21 APIs that SuprSend publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 6 operations across 4 paths, and defines 29 schemas. It is described by OpenAPI 3.2.0, at version 1.2.2.

Requests are made against a single base URL, https://hub.suprsend.com.

6 operations 4 paths 29 schemas 1 DELETE2 GET2 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.2.2
Base URL
https://hub.suprsend.com
Authentication
HTTP Bearer, API Key, API Key
Resource Areas
1

Authentication & Security 3

SuprSend Workflow API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (API_Key) (BearerAuth). An API key is passed in the header as ServiceToken (ServiceTokenAuth). An API key is passed in the header as Authorization (sec0). By default, every request must be authenticated.

  • BearerAuth — Pass as Bearer . Get API Key from SuprSend dashboard Developers - API Keys section.
  • ServiceTokenAuth — You can get Service Token from [SuprSend dashboard - Account Settings - Service Tokens](https://app.suprsend.com/en/account-settings/service-tokens) section.
  • sec0 — Bearer authentication header of the form Bearer , where is your auth token.

Paths & Operations 6

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

Workflow 6
GET
/v1/{workspace}/workflow/
List Workflows
list-workflows 3 params → 200404401
GET
/v1/{workspace}/workflow/{slug}/
Get Workflow Details
get-workflow 3 params → 200404401
POST
/v1/{workspace}/workflow/{slug}/
Create or Update Workflow
upsert-workflow 4 params body → 201404401
DELETE
/v1/{workspace}/workflow/{slug}/
Delete Workflow
delete-workflow 2 params → 204404401
PATCH
/v1/{workspace}/workflow/{slug}/commit/
Commit Workflow
commit-workflow 3 params → 202404401
PATCH
/v1/{workspace}/workflow/{slug}/enable/
Enable/Disable Workflow
toggle-workflow 2 params body → 202404401

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are Workflow (26 properties), WorkflowCreateUpdate (16 properties), BatchNode (11 properties), SendSmartChannelRoutingNode (11 properties). Each schema is shown below with its type and property counts.

SendSlackNode
object
[Slack](https://docs.suprsend.com/docs/delivery-single-channel): Sends Slack message notifications using a specified template.
4 properties 3 required
BatchNode
object
[Batch](https://docs.suprsend.com/docs/batch): Batches incoming workflow triggers/events for a duration to send consolidated notifications.
11 properties 4 required
DigestNode
object
[Digest](https://docs.suprsend.com/docs/digest): Batches and sends summary notifications at a recurring digest schedule.
9 properties 3 required
SendMultiChannelNode
object
[Multi-Channel](https://docs.suprsend.com/docs/delivery-multi-channel): Sends notifications across multiple channels simultaneously using a specified template.
6 properties 3 required
SendWhatsappNode
object
[WhatsApp](https://docs.suprsend.com/docs/delivery-single-channel): Sends WhatsApp message notifications using a specified template.
4 properties 3 required
HttpApiWebhookNode
object
[Webhook](https://docs.suprsend.com/docs/webhook): Makes an HTTP API request to an endpoint.
10 properties 4 required
ObjectOperationRemoveSubscriptionNode
object
[Unsubscribe from Object](https://docs.suprsend.com/docs/unsubscribe-from-object): Removes users (actor or recipient) as subscribers from an object. Object mus…
7 properties 5 required
SubscriberListOperationRemoveUserNode
object
[Remove User from List](https://docs.suprsend.com/docs/remove-user-from-list): Removes users (actor or recipient) from the list. List must exist for the operat…
6 properties 4 required
ErrorResponse
object
5 properties
SendWebpushNode
object
[Web Push](https://docs.suprsend.com/docs/delivery-single-channel): Sends web push notifications using a specified template.
4 properties 3 required
ObjectOperationAddSubscriptionNode
object
[Subscribe to Object](https://docs.suprsend.com/docs/subscribe-to-object): Adds users (actor or recipient) as subscribers to an object. Can create the object i…
9 properties 5 required
BranchWaitUntilNode
object
[Wait Until](https://docs.suprsend.com/docs/wait-until): Waits until a condition is met or the maximum time is reached. Uses branch structure with conditions.
4 properties 3 required
SendSmsNode
object
[SMS](https://docs.suprsend.com/docs/delivery-single-channel)): Sends SMS text message notifications using a specified template.
4 properties 3 required
SubscriberListOperationAddUserNode
object
[Add User to List](https://docs.suprsend.com/docs/add-user-to-list): Adds users (actor or recipient) to a subscriber list. Can create the list if it doesn't ex…
8 properties 4 required
HttpApiFetchNode
object
[Fetch](https://docs.suprsend.com/docs/fetch): Fetches data from an API endpoint using GET method only.
8 properties 4 required
InvokeWorkflowNode
object
[Invoke Workflow](https://docs.suprsend.com/docs/invoke-workflow): Triggers another workflow using data from the current workflow run. Generally used when you…
10 properties 4 required
Schedule
object
Static schedule configuration for digest notifications.
8 properties
UserUpdateNode
object
[Update User Profile](https://docs.suprsend.com/docs/update-user-profile): Updates user profile properties for either the actor or recipient using JSONNET expr…
5 properties 4 required
WorkflowCreateUpdate
object
16 properties 4 required
SendSmartChannelRoutingNode
object
[Smart Channel Routing](https://docs.suprsend.com/docs/smart-delivery): Sends notification subsequently at each consecutive channel with a delay (computed usin…
11 properties 3 required
TimeWindowNode
object
[Time Window](https://docs.suprsend.com/docs/time-window): Restricts workflow execution to specific time windows based on recurrence rules.
6 properties 3 required
Workflow
object
26 properties
SendInboxNode
object
[Inbox](https://docs.suprsend.com/docs/delivery-single-channel): Sends in-app inbox notifications using a specified template.
4 properties 3 required
SendEmailNode
object
[Email](https://docs.suprsend.com/docs/delivery-single-channel): Sends email notifications using a specified template.
4 properties 3 required
SendMsTeamsNode
object
[Microsoft Teams](https://docs.suprsend.com/docs/delivery-single-channel): Sends Microsoft Teams chat notifications using a specified template.
4 properties 3 required
DelayNode
object
[Delay](https://docs.suprsend.com/docs/delay): Pauses workflow execution for a specified duration.
6 properties 3 required
SendMobilePushNode
object
[Mobile Push](https://docs.suprsend.com/docs/delivery-single-channel): Sends push notifications to mobile devices (Android and iOS) using a specified template.
4 properties 3 required
TransformNode
object
[Data Transform](https://docs.suprsend.com/docs/data-transform): Transforms data or generates/overrides variables using scripting languages like JSONNET or Han…
4 properties 3 required
BranchNode
object
[Branch](https://docs.suprsend.com/docs/branch): Divides the workflow in different branches and executes the first branch that matches the branch condition.
4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

suprsend-workflow-api-openapi.yml Raw ↑

Other APIs SuprSend publishes across the network.

SuprSend Management API
SuprSend Broadcast API
SuprSend Broadcast Run API
SuprSend Bulk API
SuprSend Event API
SuprSend Message API
SuprSend Object API
SuprSend Preference Category API
SuprSend Schema API
SuprSend Subscriber List API
SuprSend Template API
SuprSend Tenant API
Where this information came from

This is an independent, third-party profile of SuprSend Workflow 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.