Official vendor OpenAPI document · agent-readyMarketingEmail MarketingapiKey19 EndpointsREST
For Agents
Manage Ediware sub-accounts, IP pools, contact lists, and automated email campaigns with an api_key query parameter on every POST call.
Use for: List all Ediware sub-accounts under my agency master account, Create a new Ediware sub-account for a client onboarding, Retrieve the API key for a specific Ediware sub-account, List the IP pools available on my Ediware account
Not supported: Does not handle SMS sending, push notifications, or transactional payment receipts - use for Ediware sub-account, contact list, IP pool, and automated email campaign management only.
Ediware is an email marketing platform offering campaigns, contact lists, sub-account management, and unsubscribe handling. The API exposes 19 POST endpoints covering sub-accounts (list, create, update, delete, language, sub-account API key retrieval), IP pools, automated campaign sending, contact list management (list, create, delete, insert contacts), and supporting capabilities for forms and unsubscriptions. Agencies running multi-tenant email programs use Ediware to provision sub-accounts and orchestrate sends without rebuilding sending infrastructure per client.
Install Jentic One Beta
Connect the Ediware API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Ediware 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%2Fediware.net%2Fediware" | 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%2Fediware.net%2Fediware" | 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 Ediware API.
Create, list, update, and delete Ediware sub-accounts for multi-tenant email programs
Retrieve a sub-account's API key to delegate further operations to that tenant
Manage IP pools used to route outbound campaign traffic
Send an automated campaign email through envoi_mail_auto
Manage contact lists end to end including list creation, deletion, and bulk contact insertion
Set the language of a sub-account so transactional content reaches the right locale
Use Cases
Patterns agents use Ediware API for, with concrete tasks.
★ Agency Multi-Tenant Email Provisioning
Agencies running email programs for many clients need to provision sub-accounts quickly. The Ediware API exposes user_create, user_update, user_delete, user_list, and get_sub_account_api_key so the agency's onboarding tool can create a sub-account, capture its API key, and store it against the client record. The agency can then operate either as the master account or directly as the sub-account using its own key.
POST /user_create with the new client's details and immediately POST /get_sub_account_api_key to capture the tenant's API key for delegated calls.
Contact List Management and Bulk Imports
Marketers maintain lists per campaign segment and need to keep them current with bulk inserts. The Ediware API exposes list_list, list_create, list_delete, and list_insert so an integration can mirror lists from a CRM or warehouse. list_insert accepts contact batches so a single call covers a large import rather than per-contact loops.
POST /list_create for a new segment, then POST /list_insert with the batch of contacts pulled from the CRM.
Automated Campaign Dispatch
Once a list is in place, marketers trigger sends programmatically. POST /envoi_mail_auto runs an automated campaign email against a configured list and template, returning a send acknowledgement. This fits scheduled jobs (newsletter, abandoned cart) where the trigger lives in the marketer's stack rather than the Ediware UI.
POST /envoi_mail_auto with the listId and template reference for the weekly newsletter and confirm the send acknowledgement.
IP Pool and Sending Reputation Management
Senders running multiple segments often want to isolate sending IPs by reputation tier. POST /pools_list lists the IP pools configured on the Ediware account so an integration can assign campaigns to the right pool. This supports basic reputation hygiene without needing to manage SMTP relays directly.
POST /pools_list to enumerate available pools and pass the chosen pool to the campaign send call.
AI Agent Email Operations Assistant
An AI agent embedded in an agency tool can use Jentic to discover Ediware operations and run client onboarding, list maintenance, and campaign sends from natural-language prompts. The agent provisions a sub-account, imports contacts, and triggers a send in one chained workflow without an engineer wiring each call.
Through Jentic, search 'create ediware sub-account and send campaign', load the user_create, list_insert, and envoi_mail_auto schemas, and execute the onboarding-to-send flow.
Key Endpoints
19 endpoints — ediware is an email marketing platform offering campaigns, contact lists, sub-account management, and unsubscribe handling.
METHOD
PATH
DESCRIPTION
POST
/user_list
List sub-accounts
POST
/user_create
Create a sub-account
POST
/get_sub_account_api_key
Get a sub-account's API key
POST
/pools_list
List IP pools
POST
/list_create
Create a contact list
POST
/list_insert
Insert contacts into a list
POST
/envoi_mail_auto
Send an automated campaign email
POST
/user_list
List sub-accounts
POST
/user_create
Create a sub-account
POST
/get_sub_account_api_key
Get a sub-account's API key
POST
/pools_list
List IP pools
POST
/list_create
Create a contact list
POST
/list_insert
Insert contacts into a list
POST
/envoi_mail_auto
Send an automated campaign 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
Ediware API
- Foundational (D+)48/100
87
Foundational Compliance63
Developer Experience & Jentic Compatibility47
AI-Readiness & Agent Experience94
Agent Usability15
Security100
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
87
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: ASignals: 4
98%
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).
50%
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.
47
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: DSignals: 4
36%
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.
50%
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.
15
Security
Trust, risk posture, and security compliance.
Grade: FSignals: 1
15%
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 Ediware API by hand means appending its api_key query parameter on every request across sub-account, contact list, IP pool, and campaign endpoints on the mdworks.fr host. Through Jentic you install once, import the Ediware API from the API Directory, store the api_key once, and your agent calls it.
Permission scoping
Ediware operations are flat POST endpoints, such as /user_create, /list_create, and /envoi_mail_auto, with no resource id in the URL path, so scope it by operation: you limit the agent to the operations it needs, such as listing users or sending a campaign, and leave sub-account key retrieval out unless you add it. The rule constrains which operations run, not a single target record.
Credential isolation
Your Ediware api_key is stored once, encrypted, by your own Jentic One instance and injected as the request query parameter at execution time. It never enters the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'create an Ediware sub-account' or 'send an Ediware campaign', and Jentic returns the matching user_create or envoi_mail_auto 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 Ediware API through Jentic.
What authentication does the Ediware API use?
The Ediware API uses an api_key passed as a query parameter on every POST request (the apiKeyAuth scheme). Through Jentic, the api_key is stored encrypted in your Jentic One instance and added to the query string at call time so it never enters the agent's context or logs.
Can I provision sub-accounts and retrieve their API keys with the Ediware API?
Yes. POST /user_create creates a sub-account and POST /get_sub_account_api_key returns its API key. The agency stores that key per client and uses it for delegated operations.
What are the rate limits for the Ediware API?
The OpenAPI spec does not declare rate limits. Ediware applies platform-level fair-use throttling on the api_http endpoint; bulk endpoints like list_insert reduce request volume by accepting many contacts per call.
How do I send a campaign through Jentic?
Search 'send ediware campaign' in Jentic, load the POST /envoi_mail_auto schema, pass the listId and template reference, and Jentic submits the send. The response confirms acceptance for delivery.
Can I bulk-import contacts into an Ediware list?
Yes. POST /list_insert accepts a batch of contacts and an existing listId. Use it to mirror a segment from a CRM or warehouse instead of inserting contacts one at a time.
Can I limit what my agent is allowed to do with the Ediware API?
Yes. Because you run Jentic One yourself, your own rules decide which Ediware operations and credentials your agent may use. Ediware exposes flat POST endpoints with no resource id in the path, so you scope by operation: allow only what the agent needs, such as list_create and envoi_mail_auto for building a list and sending a campaign, while leaving user_create and get_sub_account_api_key out unless you explicitly grant them. The stored api_key is injected at call time only for the operations you permit.
GET STARTED