Agent-ready OpenAPI document · curated by JenticMarketingMarketing AutomationapiKey8 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For Agents
Create and update people, tag for segmentation, track events that drive flows, and send transactional emails through Encharge.
Use for: I need to create or update a contact in Encharge, Tag a contact as a paying customer, Track a 'plan_upgraded' event for a user, Send a transactional welcome email through Encharge
Not supported: Does not handle CRM deal pipelines, SMS, or ad campaign management - use for SaaS marketing automation and transactional email only.
Jentic publishes the only available OpenAPI specification for Encharge API, keeping it validated and agent-ready. Encharge is a marketing automation platform built around people (contacts), tags, events, and broadcast and transactional emails. The API exposes the operations needed to create or update people, tag them for segmentation, track behavioural events that drive flows, and send transactional emails. Use it to wire product activity directly into nurture sequences without writing custom integration glue.
Install Jentic One Beta
Connect the Encharge API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Encharge API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fencharge.io%2Fencharge" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fencharge.io%2Fencharge" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with Encharge API.
Create or update a person record by email to keep the contact graph in sync
Add or remove tags on a person to drive segmentation and flow entry
Track product or behavioural events that fire automation flows
Send a transactional email triggered by application logic
Look up a person by email to read their current state before updating
Delete a person to honour data subject deletion requests
Use Cases
Patterns agents use Encharge API for, with concrete tasks.
★ Product Event-Driven Nurture
Wire product activity into Encharge so behavioural events drive automation flows automatically. The API exposes POST /events for tracking and POST /people for upserts so the contact and event graph stays current as users interact with the product. Marketing operations teams use this to replace generic time-based campaigns with flows that fire on real product behaviour.
POST /people to upsert the contact, then POST /events with the event name and properties to fire the matching flow.
Lifecycle Tagging
Tag contacts as their lifecycle changes - trial started, paid, churned - so segmentation in Encharge stays in sync with the source of truth in product or billing systems. The API exposes POST /tags and DELETE /tags for managing tag membership per person. Lifecycle marketing teams use this to keep audience segmentation reliable without manual list uploads.
POST /tags with {tag, email} to add the tag, and DELETE /tags with the same payload to remove a stale tag.
Transactional Email from Application Code
Send transactional emails - receipts, password resets, in-app notifications - through Encharge so transactional and marketing email share the same template and tracking layer. The API exposes POST /emails/send with the recipient and template payload. Engineering teams use this to consolidate sender domains and reporting across both email types.
POST /emails/send with the recipient email, template identifier, and merge variables for the message.
Agent-Driven Lifecycle Sync
An agent watching billing webhooks updates the matching Encharge contact, tags lifecycle status, and tracks the event so the right nurture flow fires. Through Jentic the agent searches by intent, loads the schemas, and chains calls without bespoke client code. The lifecycle sync that previously required custom middleware drops to a single agent task.
Search Jentic for 'update a marketing automation contact', execute POST /people, POST /tags, and POST /events for the lifecycle event in sequence.
Key Endpoints
8 endpoints — jentic publishes the only available openapi specification for encharge api, keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
POST
/people
Create or update a person
GET
/people/{email}
Get a person by email
DELETE
/people/{email}
Delete a person
POST
/tags
Add a tag to a person
DELETE
/tags
Remove a tag from a person
POST
/events
Track an event for a person
POST
/emails/send
Send a transactional email
POST
/people
Create or update a person
GET
/people/{email}
Get a person by email
DELETE
/people/{email}
Delete a person
POST
/tags
Add a tag to a person
DELETE
/tags
Remove a tag from a person
POST
/events
Track an event for a person
POST
/emails/send
Send a transactional email
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
E
Encharge API
- AI-Aware (B+)67/100
93
Foundational Compliance63
Developer Experience & Jentic Compatibility51
AI-Readiness & Agent Experience94
Agent Usability50
Security100
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
93
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: A+Signals: 4
99%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
100%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
75%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
63
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: B-Signals: 4
0%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
50%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
51
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: C-Signals: 4
41%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
100%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
62%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
50
Security
Trust, risk posture, and security compliance.
Grade: C-Signals: 1
50%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
100
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A+Signals: 1
100%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the Encharge API by hand means setting up its X-Encharge-Token header, formatting people, tag, event, and email calls, and handling your own retries against https://api.encharge.io/v1. Through Jentic you install once, import the Encharge API from the API Directory, store the token once, and your agent calls it.
Permission scoping
The Encharge API puts the person's email in the URL path (/people/{email}), so a rule can pin your agent to one person: it can read that person and nothing else. You choose the operations it may call, so ones like deleting a person or sending transactional email are not included unless you add them.
Credential isolation
Your Encharge token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'add a person to Encharge' or 'send a transactional email', and Jentic returns the matching Encharge operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using Encharge API through Jentic.
Why is there no official OpenAPI spec for Encharge API?
Encharge does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Encharge API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.
What authentication does the Encharge API use?
The API uses an API key passed in the X-Encharge-Token header. Through Jentic the token is held encrypted in the vault and injected into the header at execution time, so it never enters an agent's context.
Can I track a product event with the Encharge API?
Yes. POST /events accepts the event name, the person's email, and a properties object. Encharge uses the event to fire any matching automation flows.
How do I send a transactional email through Jentic?
Search Jentic for 'send a transactional email Encharge', load the schema for POST /emails/send, and execute it with the recipient and template variables.
What are the rate limits for the Encharge API?
The OpenAPI spec does not declare quantitative rate limits. Encharge enforces limits at the account level; treat HTTP 429 responses as authoritative and respect any Retry-After header.
Can I delete a person from Encharge for GDPR compliance?
Yes. DELETE /people/{email} removes the person record so subsequent calls referencing that email return 404. Use this path for data subject deletion requests.
Can I limit what my agent is allowed to do with the Encharge API?
Yes. Because you run Jentic One yourself, your own rules decide which Encharge operations and credentials the agent can use. Since the person's email sits in the URL path at /people/{email}, a rule can pin the agent to a single person so it reads that record and nothing else. You also choose the operations it may call, so higher-impact ones like DELETE /people/{email} or POST /emails/send stay off unless you add them.
GET STARTED