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

engageSPARK SMS API

The SMS API from engageSPARK — 4 operation(s) for sms.

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

Tagged areas include SMS. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 4 operations across 4 paths, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://api.engagespark.com.

4 operations 4 paths 2 schemas 2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.engagespark.com
Authentication
HTTP Token
License
Terms of Service
Resource Areas
1

Authentication & Security 1

engageSPARK SMS API declares 1 security scheme for authenticating requests. It uses HTTP token authentication (apiToken). By default, every request must be authenticated.

  • apiToken — Token based HTTP authentication. Use the header "Authorization". The value must be the word "Token" followed by your token. For example: "Authorization: Token…

Paths & Operations 4

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

SMS 4
POST
/v1/sms/contact
Send an SMS to a contact
sendSmsContact body → 200400401402409
POST
/v1/sms/phonenumber
Send SMS without contact
sendSmsPhonenumber body → 200400401402409
GET
/v1/organizations/{orgId}/messages/
List SMSs for an organization
getSmsList 10 params → 200400401
GET
/v1/organizations/{orgId}/messages/{messageId}/
Get a single SMS by ID
getSms 2 params → 200401404

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are schema_model_sms (18 properties), schema_sms (14 properties). Each schema is shown below with its type and property counts.

schema_sms
object
14 properties 13 required
schema_model_sms
object
18 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engagespark-sms-api-openapi.yml Raw ↑

Other APIs engageSPARK publishes across the network.

engageSPARK Balance API
engageSPARK Campaigns API
engageSPARK Contacts API
engageSPARK Files API
engageSPARK Top-Up API
engageSPARK WhatsApp API