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 Custom Objects Schema API

The Custom Objects Schema API from Encharge — 10 operation(s) for defining object types, their fields, and the associations between them.

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

Tagged areas include Custom Objects and Schema. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 10 operations across 6 paths, and defines 17 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.

10 operations 6 paths 17 schemas 3 DELETE2 GET2 PATCH3 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 Custom Objects Schema 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 10

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

CustomObjectsSchema 10
GET
/schemas
Get all custom objects.
GetCustomObjectsSchema → 200
POST
/schemas
Get custom objects counts.
CreateCustomObjectSchema body → 200
GET
/schemas/{objectName}
Get custom object by name.
GetCustomObjectSchema 1 param → 200
PATCH
/schemas/{objectName}
Update custom object.
UpdateCustomObjectSchema 1 param body → 200
DELETE
/schemas/{objectName}
Remove custom object definition. Note that this will delete all data stored in these custom objects.
DeleteCustomObjectSchema 1 param → 204
POST
/schemas/{objectName}/fields
Create fields for Custom Object
CreateObjectFields 1 param body → 200
PATCH
/schemas/{objectName}/fields/{fieldName}
Modify field for Custom Object. Note: Field type and format can only be changed for People fields.
EditObjectField 2 params body → 200
DELETE
/schemas/{objectName}/fields/{fieldName}
Delete Person Field
DeleteObjectField 2 params → 204
POST
/schemas/associations
Define association between custom objects.
DefineCustomObjectsAssociationSchema body → 200
DELETE
/schemas/associations/{id}
Remove a defined association between custom objects.
RemoveCustomObjectsAssociationSchema 1 param → 204

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are IPersonField (15 properties), PersonField (15 properties), CustomObjectSchema (9 properties), Partial_Pick_CustomObjectField.title-or-tooltip-or-displayType-or-icon-or-enumNames-or-enum-or-type-or-format__ (8 properties). Each schema is shown below with its type and property counts.

Pick_CustomObjectSchemaCreatable.Exclude_keyofCustomObjectSchemaCreatable.searchableFields__
object
From T, pick a set of properties whose keys are in the union K
6 properties 3 required
CustomObjectFieldEdit
CustomObjectSchemaUpdatable
Partial_Pick_CustomObjectField.title-or-tooltip-or-displayType-or-icon-or-enumNames-or-enum-or-type-or-format__
object
Make all properties in T optional
8 properties
Omit_CustomObjectSchemaAssociation.id_
Construct a type with the properties of T except for those in type K.
Partial_Omit_CustomObjectSchema.fields-or-associations-or-name__
object
Make all properties in T optional
6 properties
CustomObjectSchemaAssociationCreatable
CustomObjectSchema
object
9 properties 3 required
Exclude_JSONSchema6TypeName.object-or-array-or-null_
string
Exclude from T those types that are assignable to U
CustomObjectSchemaAssociation
object
5 properties 4 required
FieldDisplayType
string
CustomObjectField
Omit_CustomObjectSchemaCreatable.searchableFields_
Construct a type with the properties of T except for those in type K.
PersonField
object
15 properties 9 required
Pick_CustomObjectSchemaAssociation.Exclude_keyofCustomObjectSchemaAssociation.id__
object
From T, pick a set of properties whose keys are in the union K
4 properties 3 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-customobjectsschema-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 Email Templates API
Encharge Folders API
Encharge People API
Encharge Person Fields 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 Custom Objects Schema 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.