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

The Contacts API from engageSPARK — 2 operation(s) for contacts.

engageSPARK Contacts API is one of 7 APIs that engageSPARK 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 and authentication docs.

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

5 operations 2 paths 2 schemas 1 DELETE2 GET1 POST1 PUT

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

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

Contacts 5
GET
/v1/organizations/{orgId}/contacts/
List all contacts for an organization
listContacts 12 params → 200400401500
POST
/v1/organizations/{orgId}/contacts/
Create a new contact in the system
createContact 1 param body → 200400401500
GET
/v1/organizations/{orgId}/contacts/{contactId}/
Get a single contact by ID
getContact 3 params → 200401404500
PUT
/v1/organizations/{orgId}/contacts/{contactId}/
Update an existing contact
updateContact 2 params body → 200400401500
DELETE
/v1/organizations/{orgId}/contacts/{contactId}/
Delete a contact from the system
deleteContact 2 params → 200401404500

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are schema_contact (15 properties), schema_substatus (8 properties). Each schema is shown below with its type and property counts.

schema_contact
object
15 properties
schema_substatus
object
Status of a subscription for a contact.
8 properties 7 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engagespark-contacts-api-openapi.yml Raw ↑

Other APIs engageSPARK publishes across the network.

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