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

Encharge People API

The People API from Encharge — 2 operation(s) for people.

Encharge People API is one of 11 APIs that Encharge publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include People. The published artifact set on APIs.io includes an OpenAPI specification.

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

Requests are made against 2 base URLs: https://api.encharge.io/v1, https://ingest.encharge.io/v1.

4 operations 2 paths 0 schemas 1 DELETE1 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.encharge.io/v1
Authentication
API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Encharge People API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-Encharge-Token (tokenHeader). It accepts HTTP bearer tokens (bearer). By default, every request must be authenticated.

Paths & Operations 4

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

People 4
GET
/people
List people
listPeople 4 params → 200
POST
/people
Create or update person
upsertPerson body → 200
DELETE
/people
Archive person
archivePerson body → 204
POST
/people/unsubscribe
Unsubscribe a person
unsubscribePerson body → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

encharge-people-api-openapi.yml Raw ↑

Other APIs Encharge publishes across the network.

Encharge REST API
Encharge Transactional Email API
Encharge Ingest API
Encharge Account API
Encharge Events API
Encharge Fields API
Encharge Ingest API
Encharge Segments API
Encharge Tags API
Encharge Transactional Email API