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

The Fields API from Encharge — 2 operation(s) for fields.

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

Tagged areas include Fields. 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 GET1 PATCH1 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 Fields 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, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Fields 4
GET
/fields
List person fields
listFields → 200
POST
/fields
Create field
createField body → 201
PATCH
/fields/{fieldName}
Update field
updateField 1 param body → 200
DELETE
/fields/{fieldName}
Delete field
deleteField 1 param → 204

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

encharge-fields-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 Ingest API
Encharge People API
Encharge Segments API
Encharge Tags API
Encharge Transactional Email API