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

# Mindbaz API

Jentic publishes the only available OpenAPI specification for Mindbaz API, keeping it validated and agent-ready. Mindbaz is an email marketing platform whose API gives campaign operators programmatic control over subscribers, imports and exports, custom subscriber fields, advertisements, and subscriptions. The 30 endpoints sit under a per-site path (`/api/{idsite}`/) and authenticate with an API key in the Authorization header, so each call targets a specific Mindbaz site.

## For AI agents

Manage subscribers, custom fields, imports, exports, advertisements, and subscriptions inside a Mindbaz email marketing site via API key authentication.

## Scope

Does not handle SMS, transactional sending, or paid ad campaign management - use for managing subscribers, custom fields, imports/exports, advertisements, and subscriptions on a Mindbaz email marketing site only.

## Capabilities

- Export subscribers to an SFTP repository for downstream warehouse loads
- Import subscribers in bulk to onboard a new list into Mindbaz
- Manage custom subscriber fields and the field quota that bounds the data model
- Create and update advertisements that wrap email content for campaigns
- Manage subscriber subscriptions across the site's mailing lists
- Look up SFTP repositories used for data exchange between Mindbaz and external systems
- Pull export status and last-state metadata for monitoring agents

## Use cases

### Warehouse Sync via Subscriber Export

An agent kicks off a subscribers export to an SFTP repository, monitors the export state, and triggers a downstream warehouse load when the file lands. Mindbaz becomes a first-class source in a marketing data pipeline without manual file handling.

Example prompt: POST `/exports/subscribers` to start an export, then poll GET `/exports/subscribers/{idExport}` until status is complete and notify a downstream loader.

### Bulk Subscriber Onboarding

When a new list arrives from an acquisition or partner, an agent runs a Mindbaz import to load it into the platform. Operators avoid one-by-one subscriber API calls and the new audience is ready for campaigns within minutes.

Example prompt: Run an import job via the imports endpoint with a CSV of new subscribers and verify completion through the export/import status endpoints.

### Field Schema Management

Marketing ops adds or updates custom subscriber fields (e.g. preferred language, plan tier) so segmentation works correctly. The API exposes the field list, the field quota, and an update endpoint so the schema is managed alongside the rest of the marketing stack.

Example prompt: Call GET `/fields/list` and GET `/fields/quota` to inventory current fields, then PUT /Fields to update a field's properties.

### Agent-Driven Email Marketing via Jentic

Through Jentic, an agent triggers Mindbaz exports, imports, and field updates by intent rather than manual API plumbing. The Mindbaz API key is held in your Jentic One instance and the per-site idsite is included in the path, so an agent can run multi-site marketing operations without ever holding a credential.

Example prompt: Use Jentic search 'export subscribers from mindbaz', load the schema for POST `/exports/subscribers`, and execute with the target SFTP repository.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/exports/subscribers` | Export subscribers to SFTP |
| GET | `/exports/subscribers/{idExport}` | Get export job info |
| GET | `/exports/repositories` | List configured SFTP repositories |
| GET | `/fields/list` | List subscriber fields |
| GET | `/fields/quota` | Get the field quota for the site |
| PUT | `/Fields` | Update a custom field |

## Key resources

- **Subscribers** — Manage subscriber records on a Mindbaz site
- **Imports** — Bulk import subscriber data
- **Exports** — Export subscribers and monitor export job state
- **Fields** — Manage custom subscriber fields and quotas
- **Advertisements** — Manage email advertisement entities used in campaigns
- **Subscriptions** — Manage list subscriptions for subscribers

## Why Jentic

- **Setup:** Wiring Mindbaz by hand means handling its API key in the Authorization header, supplying the per-site idsite in the base path (api.mindbaz.com/api/{idsite}), and coding the subscriber, field, and export calls yourself. Through Jentic you install once, import Mindbaz from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** Mindbaz puts the site id in the base path and export ids in the URL (`/exports/subscribers/{idExport}`), so a rule can pin your agent to one site and its exports. You choose the operations it may call, so a write like updating fields is not included unless you add it.
- **Credential handling:** Your Mindbaz API key is stored once, encrypted, by your own Jentic One instance and injected into the Authorization header at execution time, with the per-site idsite supplied as a path parameter. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'export subscribers from Mindbaz' or 'list custom fields', and Jentic returns the matching Mindbaz operation with its input schema so the agent calls POST `/exports/subscribers` without browsing learn.mindbaz.com.

## Related APIs

- **Mailchimp API** — Mainstream email marketing platform with broad audience and automation features.
- **Brevo API** — Email marketing and transactional API formerly known as Sendinblue.
- **SendGrid Mail Send API** — Pairs as a transactional sending layer next to Mindbaz's marketing surface.

## FAQ

### Why is there no official OpenAPI spec for Mindbaz API?

Mindbaz does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Mindbaz 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 Mindbaz API use?

The API uses an API key sent in the Authorization header (the apiKey security scheme). Each request is also scoped to a Mindbaz site via the {idsite} path parameter. Through Jentic, the key sits in the encrypted vault and is injected per request without entering the agent's context.

### Can I export subscribers to an SFTP server through the API?

Yes. POST `/exports/subscribers` triggers an export to a configured SFTP repository, and GET `/exports/subscribers/{idExport}` reports the export's status, which is the supported flow for warehouse sync jobs.

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

Mindbaz documents per-site limits in their developer portal at learn.mindbaz.com. Treat the API as rate-limited per key and per site, and back off on HTTP 429 responses.

### How do I export subscribers to SFTP through Jentic?

Run pip install jentic, search for 'export subscribers from mindbaz', load the schema for POST `/exports/subscribers`, and execute with the target SFTP repository id. Jentic injects your stored Authorization header automatically.

### How is the field quota enforced?

GET `/fields/quota` returns the current number of subscriber fields used and the maximum allowed for the site, which is documented per Mindbaz contract; field creation will be rejected once that maximum is reached.

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

Yes. Because Jentic One is self-hosted, your own rules decide which Mindbaz operations and credentials the agent may use. Mindbaz puts the site id in the base path and export ids in the URL (`/exports/subscribers/{idExport}`), so you can pin the agent to a single site and its exports. You also choose the operations it may call, so a write such as updating custom fields with PUT /Fields is not available to the agent unless you add it.