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

The Campaigns API from engageSPARK — 2 operation(s) for campaigns.

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

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

This API exposes 2 operations across 2 paths, and defines 3 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.

2 operations 2 paths 3 schemas 2 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 Campaigns 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 2

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

Campaigns 2
POST
/v1/organizations/{orgId}/engagements/{campaignId}/subscribe
Subscribe a contact to a campaign
subscribeContact 2 params body → 200400401500
POST
/v1/organizations/{orgId}/engagements/{campaignId}/unsubscribe
Unsubscribe a contact from a campaign
unsubscribeContact 2 params body → 200400401500

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are schema_sub_delay (9 properties), properties_daysofweek (7 properties), properties_contact (6 properties). Each schema is shown below with its type and property counts.

properties_contact
object
6 properties
schema_sub_delay
object
Delays the start of the subscription. If omitted, the subscriptions start immediately. You must always set the value field. When using the day unit, you can ad…
9 properties
properties_daysofweek
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engagespark-campaigns-api-openapi.yml Raw ↑

Other APIs engageSPARK publishes across the network.

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