canonical: https://jentic.com/apis/cyberimpact.com/cyberimpact

# Cyberimpact API

Cyberimpact is a Canadian email marketing platform built around CASL-compliant permission management. The API exposes nine endpoints across groups, contacts, mailings, and templates so agents can sync contact lists, fetch sent mailing history, and read template metadata without using the dashboard. It targets small businesses sending opt-in newsletters, with bilingual French/English support and resident Canadian data hosting.

## For AI agents

Sync contacts into Cyberimpact groups, retrieve mailing history, and list email templates for CASL-compliant Canadian email marketing.

## Scope

Does not handle SMS, push notifications, or campaign send dispatch - use for Cyberimpact contact, group, and mailing-history management only.

## Capabilities

- Create or update a Cyberimpact contact and assign it to one or more permission-based groups
- List every group in the account and read membership counts before targeting a send
- Fetch a single contact record by contactId to confirm subscription status before resending
- Retrieve historical mailings sent from the account for reporting or audit logs
- List available email templates so an agent can pick a brand-approved layout for a campaign
- Delete a contact by contactId to honour an unsubscribe or right-to-erasure request

## Use cases

### CASL-Compliant Lead Sync

Push newly captured leads from a website form or CRM into Cyberimpact while preserving consent metadata. The API's POST /contacts endpoint creates or updates a contact in a single call and assigns group membership, so agents can keep the marketing list in sync with the source of truth without touching the dashboard. Ideal for Quebec-based businesses that need permission audit trails.

Example prompt: POST a new contact with email, firstName, lastName, and a permission timestamp to /contacts and assign it to group ID 12345.

### Mailing Performance Audit

Pull the list of mailings sent from a Cyberimpact account into a reporting tool or BI dashboard. The GET /mailings endpoint returns send history that an agent can join with internal CRM data to attribute pipeline back to specific campaigns, supporting quarterly marketing reviews.

Example prompt: Call GET /mailings and filter the response to mailings sent in the last 90 days, then summarise by month.

### Unsubscribe Cleanup Workflow

Process an inbound unsubscribe request received via support channels. The agent looks up the contact via GET /contacts, confirms identity with GET `/contacts/{contactId}`, and then calls DELETE `/contacts/{contactId}` to remove them, all without a marketer needing to log into the Cyberimpact UI.

Example prompt: Search /contacts for email 'jane@example.com', then DELETE `/contacts/{contactId}` once a single match is confirmed.

### Agent-Driven Template Selection

An AI agent composing a newsletter via Jentic queries the Cyberimpact template list, picks the brand-approved layout that matches the campaign theme, and reports the template ID back to a human reviewer. Removes the need for a marketer to manually copy template IDs from the UI into a brief.

Example prompt: Call GET /templates, filter for templates whose name contains 'Newsletter', and return the most recently modified template ID.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/contacts` | Create or update a contact |
| GET | `/contacts` | List all contacts |
| DELETE | `/contacts/{contactId}` | Delete a contact |
| GET | `/groups` | List all groups |
| GET | `/mailings` | List mailings |
| GET | `/templates` | List email templates |

## Key resources

- **Groups** — Permission-based contact lists used for sending
- **Contacts** — Subscriber records with consent metadata
- **Mailings** — Sent campaign history
- **Templates** — Reusable email layouts

## Why Jentic

- **Setup:** Wiring the Cyberimpact API by hand means provisioning a bearer token, attaching it to every request, and mapping its contact, group, and mailing routes yourself. Through Jentic you install once, import the Cyberimpact API from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** Cyberimpact puts the contact id in the URL path (`/contacts/{contactId}`), so a rule can pin your agent to reading and adding contacts. You choose the operations it may call, so deleting a contact is not included unless you add it.
- **Credential handling:** Your Cyberimpact bearer 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.
- **Discovery method:** Agents search Jentic by intent such as 'add a contact to a Cyberimpact group' or 'list mailings', and Jentic returns the matching Cyberimpact operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Mailchimp Marketing API** — Larger global email marketing platform with broader campaign automation surface than Cyberimpact.
- **Constant Contact API** — North American email marketing platform with a similar SMB target market and richer event marketing features.
- **HubSpot Marketing Events API** — Pairs CRM-driven marketing event tracking with Cyberimpact's email send list.

## FAQ

### What authentication does the Cyberimpact API use?

The Cyberimpact API uses HTTP Bearer authentication. You generate a personal API token in the Cyberimpact account settings and pass it as Authorization: Bearer <token> on every request to api.cyberimpact.com/v3. Through Jentic, the bearer token is held in the encrypted vault and the agent receives a scoped runtime credential, so the raw token never enters the model context.

### Can I create CASL-compliant contacts with the Cyberimpact API?

Yes. POST /contacts accepts the contact email, name fields, and the group IDs the contact should be added to. Cyberimpact treats group membership as the consent record, so the contact you create through the API is treated the same as a contact opted in via a Cyberimpact form for CASL purposes.

### What are the rate limits for the Cyberimpact API?

Cyberimpact does not publish hard rate limits in the OpenAPI spec, but the developer documentation recommends keeping bulk imports below a few requests per second and processing large contact loads in batches. Treat sustained traffic above 10 requests per second as a risk for throttling.

### How do I add a new subscriber through Jentic?

Install the SDK with pip install jentic, then run an agent with the search query 'add a contact to a Cyberimpact group'. Jentic returns the POST /contacts operation with its input schema, so the agent can call it directly with the email, name, and group ID without browsing API docs.

### Does the Cyberimpact API support sending a new mailing?

No. The available endpoints expose mailings for read-only listing only. To trigger a new send you still need to compose and dispatch the campaign in the Cyberimpact UI; the API is scoped to contact, group, and reporting workflows.

### Is the Cyberimpact API free?

API access is included with any paid Cyberimpact plan. Cyberimpact also offers a free tier capped at 250 contacts which includes API access, so small lists can be managed via the API at no cost.

### Can I limit what my agent is allowed to do with the Cyberimpact API?

Yes. Jentic One runs self-hosted, so your own rules decide which Cyberimpact operations and credentials the agent may use. Because the contact id sits in the URL path (`/contacts/{contactId}`), you can pin the agent to reading and adding contacts through GET /contacts and POST /contacts while leaving the rest untouched. Destructive calls such as DELETE `/contacts/{contactId}` are only available if you explicitly include them, and the bearer token is injected at execution time rather than exposed to the agent.