canonical: https://jentic.com/apis/e-goi.com/e-goi-api

# E-goi API

E-goi is a multichannel marketing automation platform that consolidates email, SMS, push notification, voice, and web push campaigns into a single API surface. The E-goi API exposes endpoints for managing contact lists, adding and segmenting subscribers, sending email campaigns, and pulling campaign-level performance reports. It is designed for agencies and product teams that orchestrate cross-channel nurture flows and need programmatic control over list hygiene and dispatch.

## For AI agents

Manage contact lists, add subscribers, send email campaigns, and retrieve campaign reports on the E-goi multichannel marketing platform.

## Scope

Does not handle SMS dispatch, push notifications, voice campaigns, or web tracking - use for E-goi list management, email campaign sending, and campaign reporting only.

## Capabilities

- Create and curate subscriber lists for segmented marketing sends
- Add, update, and remove contacts within an E-goi list
- Dispatch email campaigns to a target list with subject, sender, and content payloads
- Retrieve open, click, bounce, and delivery counts for a specific campaign report
- Audit list metadata and contact membership before triggering a send

## Use cases

### Newsletter list onboarding

Synchronise newly registered users from a SaaS signup flow into an E-goi list so they receive welcome and onboarding emails. Each new account triggers a POST to /lists/{list_id}/contacts with the email and any custom fields, ensuring the contact is reachable for transactional and lifecycle messaging within minutes of signup.

Example prompt: Add a contact with email user@example.com and first_name Alex to E-goi list 12345 and confirm the contact ID returned.

### Triggered email campaigns

Send broadcast email campaigns to a list when a marketing-managed event occurs, such as a product launch or webinar invite. The /campaigns/email endpoint accepts the list ID, subject, sender, and HTML body, allowing campaign dispatch directly from a workflow without using the E-goi UI.

Example prompt: Send an email campaign to E-goi list 12345 with subject 'Spring Sale' and the supplied HTML body, then return the campaign_id.

### Campaign performance reporting

Pull engagement metrics back into a BI dashboard or weekly digest by calling /reports/campaigns/{campaign_id}. The endpoint returns counts for opens, clicks, bounces, and unsubscribes, enabling automated reporting without exporting CSVs from the E-goi web app.

Example prompt: Fetch the report for E-goi campaign 67890 and summarise total opens, clicks, and unsubscribes in a one-line message.

### Agent-driven contact maintenance

An AI assistant can keep an E-goi list clean by responding to natural-language requests like 'remove bounced contacts' or 'add these five new leads'. Through Jentic, the agent finds the right list and contact endpoints by intent and executes the calls without the user touching the E-goi dashboard.

Example prompt: Given a list of five lead emails, add each to E-goi list 12345 and report how many succeeded and how many already existed.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | /lists | List all contact lists |
| POST | /lists | Create a new contact list |
| GET | /lists/{list_id}/contacts | Retrieve contacts on a list |
| POST | /lists/{list_id}/contacts | Add a contact to a list |
| POST | /campaigns/email | Send an email campaign |
| GET | /reports/campaigns/{campaign_id} | Get campaign engagement report |

## Key resources

- **Lists** — Create, retrieve, update, and delete contact lists
- **Contacts** — Add and retrieve contacts within a specific list
- **Campaigns** — Dispatch email campaigns to a target list
- **Reports** — Retrieve engagement metrics for a sent campaign

## Why Jentic

- **Setup:** Wiring E-goi by hand means setting up its Apikey header auth and coding the separate list, contact, campaign, and report calls yourself. Through Jentic you install once, import E-goi from the API Directory, store the API key once, and your agent calls it.
- **Permission scoping:** E-goi puts the list id in the URL path (/lists/{list_id}/contacts), so a rule can pin your agent to one list: it can read and add contacts for that list and nothing else. You choose the operations it may call, so sending an email campaign is not included unless you add it.
- **Credential handling:** Your E-goi Apikey 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.
- **Discovery method:** Agents search Jentic by intent such as 'send a marketing email campaign' or 'add a contact to a list', and Jentic returns the matching E-goi operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Mailchimp API** — Larger English-speaking marketing automation platform with deeper segmentation
- **SendGrid Marketing Campaigns** — Email-first marketing automation backed by Twilio's deliverability infrastructure
- **Klaviyo API** — E-commerce-focused CRM that enriches segments with purchase data

## FAQ

### What authentication does the E-goi API use?

E-goi requires an API key passed in the Apikey HTTP header on every request. Through Jentic, the key is stored encrypted in the vault and never enters the agent's context - agents receive a scoped token that authorises a specific operation.

### Can I send email campaigns programmatically with the E-goi API?

Yes. POST /campaigns/email accepts the target list_id, subject line, sender details, and HTML body, and returns a campaign identifier. Tracking, opens, and clicks are reported back via /reports/campaigns/{campaign_id}.

### What are the rate limits for the E-goi API?

The OpenAPI spec does not expose a fixed rate limit. E-goi typically applies per-account throttling on campaign dispatch and contact writes - consult your account settings or contact E-goi support for the limits applied to your plan.

### How do I add contacts to an E-goi list through Jentic?

Search Jentic for 'add contact to e-goi list', load the schema for POST /lists/{list_id}/contacts, then execute with the list_id and contact payload. The full flow is: pip install jentic, then await client.search, await client.load, await client.execute.

### Does the E-goi API support SMS or push campaigns?

This OpenAPI spec covers list management, contacts, email campaigns, and campaign reports. SMS, voice, and push channels are part of the broader E-goi platform but are not exposed by this 9-endpoint surface.

### Can I limit what my agent is allowed to do with the E-goi API?

Yes. Because you run Jentic One yourself, your own rules decide which E-goi operations and credentials the agent may use. Since the list id sits in the URL path, such as /lists/{list_id}/contacts, you can pin the agent to a single list so it only reads and adds contacts there and touches nothing else. Sending an email campaign through POST /campaigns/email is excluded until you explicitly grant that operation.