Batch (BYOK)

Batch (BYOK) — connector documentation

• MCP endpoint: https://byok-batch.connectorbay.com/mcp
• REST API: POST https://byok-batch.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec at https://byok-batch.connectorbay.com/openapi.json
• Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
• Authentication: your own Batch Batch REST API key, sent in the X-Upstream-Key header and the Batch project key (the X-Batch-Project value from your project settings) in X-Upstream-Key-2 of every request (never stored, logged or cached)
• Health: https://byok-batch.connectorbay.com/health · Tool schemas: https://byok-batch.connectorbay.com/tools.json
• Publisher: Unify Dynamics LLC · connectorbay.com/byok-batch · agent@connectorbay.com

What Batch (BYOK) is for

Batch (BYOK) lets an AI assistant read your own Batch data through the Batch API with a key you supply (Batch REST API key). Read-only: 9 tools (list_orchestrations, get_orchestration, get_orchestration_stats, list_segments, list_audiences, get_audience, list_catalogs, get_catalog, list_export_requests). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to api.batch.com. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Batch. Batch and its logos are trademarks of their owners and are used only to say which service the connector works with.

Ask your assistant things like:

• "Which Batch push campaigns are running right now?"
• "What does Batch push campaign abc123 say and who does it target?"
• "How did Batch campaign abc123 perform last month?"
• "Which segments exist in my Batch project?"
• "Which audiences have I uploaded to Batch?"
• "How many ids are in my Batch audience vip-users?"

What it does

• list_orchestrations: List campaigns, recurring and trigger orchestrations (push, in-app, email, SMS) newest first, with status, channels and platforms; filter by one status, type or channel.
• get_orchestration: Get one push campaign in detail: status, platforms, A/B test settings, targeting and the message versions (title, body, deeplinks).
• get_orchestration_stats: Get delivery statistics of an orchestration for a date range: sent, delivered, opens, clicks, conversions and revenue per day.
• list_segments: List the segments defined in the project with their codes and display names.
• list_audiences: List uploaded audiences (custom ids, emails or install ids) with size and indexing state.
• get_audience: Get one audience by name: type, number of ids, indexing state and dates.
• list_catalogs: List item catalogs with their field definitions, item counts, size and indexing state.
• get_catalog: Get one catalog by name: fields, item count, size, indexing state and dates.
• list_export_requests: List data export requests of the last 3 months with scope, status and request, completion and start dates (file links are not returned).

BYOK key

You bring your own Batch Batch REST API key (https://doc.batch.com/getting-started/features/customer-engagement-platform/settings/general#rest-api-key). Your assistant sends it in the X-Upstream-Key header with each request. ConnectorBay uses it for that one call only: it is never stored, logged or cached, never shown in an answer, and it is only sent to api.batch.com over https, with no redirects followed. Create a key with the fewest permissions the tools need (read-only if the provider offers it), and revoke it at the provider whenever you like.

Data sources

• https://doc.batch.com/developer/api/cep.md (the API this connector calls, with a BYOK key)

Live from the Batch API (api.batch.com) with a BYOK key; documentation: https://doc.batch.com/developer/api/cep.md. Endpoints checked against that documentation on 2026-10-16.

What it is not

Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Batch. Batch and its logos are trademarks of their owners and are used only to say which service the connector works with. It is read-only: it never creates, changes, sends or deletes anything in your Batch account.

Built for: Worldwide. Languages: English.

Batch (BYOK) — Privacy Policy

Effective 24 October 2026. Unify Dynamics LLC ("we", "us"), Menlo Park, California.

What Batch (BYOK) is. Batch (BYOK) is a connector (an MCP server and REST API) that an AI assistant calls on your behalf to read your own Batch data: Read your Batch push, in-app, email and SMS orchestrations, their statistics, segments, audiences and catalogs with your own REST API key. You bring your own Batch Batch REST API key; the assistant sends it to us with each request.

BYOK key. The key you supply is used to make the one Batch call you asked for. Our application does not store it, write it to a log, put it in a cache, or share it. It is sent only to api.batch.com, over https, and is removed from any text we return to you or your assistant. We do not follow redirects with your key. If Batch rejects it, we say so without repeating it.

What we receive. The arguments of each tool call, the BYOK key (for that call only), the technical headers needed to serve the request (an IP address or a client identifier supplied by the assistant) and standard server logs. What Batch receives. The request we make on your behalf, including the key and the arguments, under Batch's own terms and privacy policy. Batch acts at your direction and is the only recipient of the data of your request besides our hosting provider.

What we return. The answer Batch gives for your request, trimmed to the fields the tool documents. We do not keep it: it is returned to your assistant and not stored, cached or used to train anything.

What we do not do. We do not build a profile, sell or share personal information, or keep your Batch data. Rate-limit counters (a client identifier and timestamps) are held in memory for at most 24 hours. Hosting access logs (IP addresses, request paths and status codes) are kept for up to 30 days for security and abuse prevention; our application adds no request headers or bodies to them.

Sub-processors. Batch (the API you call with a BYOK key, at your direction). Hosting: Vercel (United States regions).

Your rights. Because we store no personal data beyond short-lived logs, requests to access, correct or delete data are usually satisfied automatically; you can still contact agent@connectorbay.com and we will respond within 30 days. Revoke your key at Batch at any time to end all access.

Children. Batch (BYOK) is a general-audience service operated by the adult using the assistant, under Batch's own age rules.

Changes. We will post changes here with a new effective date.

Batch (BYOK) — Terms of Service

Effective 24 October 2026. These terms govern use of the Batch (BYOK) connector ("the Service") operated by Unify Dynamics LLC ("we", "us").

1. The Service. Batch (BYOK) provides: Read your Batch push, in-app, email and SMS orchestrations, their statistics, segments, audiences and catalogs with your own REST API key. It is accessed through an AI assistant or directly over MCP or HTTP, and is read-only.
2. Your own key, your own account. You must use your own Batch credentials and only access data you are allowed to access. Batch's terms apply to your use of Batch; you are responsible for complying with them, including any rate limits and permitted uses. Do not share a key you do not own.
3. Independent. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Batch. Batch and its logos are trademarks of their owners and are used only to say which service the connector works with.
4. No advice, no guarantees. Output is the data Batch returns, lightly trimmed; it may be incomplete, delayed or changed by Batch. Check important facts at the source.
5. Read-only. The Service does not create, change, send or delete anything in your Batch account.
6. Acceptable use. Automated use within the published rate limits is welcome. Do not use the Service to access data you are not entitled to, to circumvent Batch's controls, or to attack any system.
7. Availability. The Service is provided "as is" without warranty. We may change, limit or discontinue it at any time; Batch may change or end its API at any time.
8. Data. Our Privacy Policy describes what we process. In short: the BYOK key is used for the one call and not stored or logged.
9. Pro keys. Optional ConnectorBay Pro API keys are issued at our discretion and are separate from your Batch key.
10. Liability. To the fullest extent permitted by law, Unify Dynamics LLC is not liable for any loss arising from use of or reliance on the Service, including any action Batch takes on your account. Our total liability is limited to US $100.
11. Governing law. California law; venue in San Mateo County, California.
12. Contact. Unify Dynamics LLC · agent@connectorbay.com · https://connectorbay.com/byok-batch

Batch (BYOK) support

Email agent@connectorbay.com. We answer within two business days.

• MCP endpoint: https://byok-batch.connectorbay.com/mcp
• REST API: https://byok-batch.connectorbay.com/openapi.json
• Live status: https://byok-batch.connectorbay.com/health

When you report a problem, include the question you asked your agent, roughly when, and which agent you used (for example Claude, ChatGPT or Gemini). Never send us passwords, account numbers or ID numbers. Batch (BYOK) never asks for them.