How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Encharge Person Fields API

The Person Fields API from Encharge — 4 operation(s) for managing person fields.

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

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

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

Requests are made against a single base URL, https://api.encharge.io/v1.

4 operations 2 paths 5 schemas 1 DELETE1 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.encharge.io/v1
Authentication
API Key, API Key, OAuth 2.0
Contact
License
MIT
Resource Areas
1

Authentication & Security 3

Encharge Person Fields API declares 3 security schemes for authenticating requests. An API key is passed in the header as X-Encharge-Token (apiKeyHeader). An API key is passed in the query as token (apiKeyQuery). It supports OAuth 2.0 (oauth2) using the authorizationCode flow.

  • apiKeyHeader — You can use API key authentication if you are using the API for your Encharge account. If you are building an app for others to use, please use the OAuth2 auth…
  • apiKeyQuery — You can use API key authentication if you are using the API for your Encharge account. If you are building an app for others to use, please use the OAuth2 auth…
  • oauth2 — The Encharge API uses OAuth 2 with the authorization code flow. Get for your OAuth credentials (Client ID and Client Secret) by filling out [this form](https:/…

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.

PersonFields 4
GET
/fields
Get all Person Fields.
GetFields → 200
POST
/fields
Create Person Fields
CreateFields body → 200
PATCH
/fields/{fieldName}
Modify Person Field
EditField 1 param body → 200
DELETE
/fields/{fieldName}
Delete Person Field
DeleteField 1 param → 204

Schemas 5

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

Exclude_JSONSchema6TypeName.object-or-array-or-null_
string
Exclude from T those types that are assignable to U
FieldDisplayType
string
PersonField
object
15 properties 9 required
PersonFieldFormat
stringnull
Format of the field. Applies to String fields only. JSON schema compatible
IPersonField
object
Represents a field (i.e. property) of a person in Encharge.
15 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

encharge-personfields-api-openapi.yml Raw ↑

Other APIs Encharge publishes across the network.

Encharge Transactional Email API
Encharge Ingest API
Encharge Account API
Encharge Broadcasts API
Encharge Custom Objects API
Encharge Custom Objects Schema API
Encharge Email Templates API
Encharge Folders API
Encharge People API
Encharge Segments API
Encharge Email Domain Settings API
Encharge Tags API
Where this information came from

This is an independent, third-party profile of Encharge Person Fields API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.