Overview
Transactional Suite owns templates and template-send over public umk_* REST. Email delivery reuses Business Email providers (requires umney_email entitlement). Logs share transactional_logs with Marketing and Business Email.
| Item | Value |
|---|---|
| Service | Transactional |
| Permissions | transactional:send |
| Key example | umk_live_transactional_<8>_<secret> |
| Dashboard UI | Dashboard → Email Suites |
| JWT Growth API | /api/growth/… (see below) |
| Public umk_* REST | Live — see public API table |
| Markdown | /developers/transactional.md |
Public /v1/transactional/* is live (templates CRUD, POST /messages, GET /logs). Email channel only. Send requires Business Email enabled. Logs default to source=transactional_v1; use source=all for the shared ledger.
Get started
- Enable Transactional in Dashboard → Billing.
- Open Dashboard → Email Suites for the product tab UI.
- Create an API token for Transactional with permission transactional:send.
- Store the secret server-side only (Cloudflare-style least privilege).
- Use JWT /api/growth/* for dashboard session flows; public /v1/* paths when documented as Live.
API tokens (Cloudflare-style)
Authorization: Bearer umk_live_transactional_<8>_<secret>
Scope: transactional:send — Send transactional template messages on the public Transactional API
Guide: /developers/api-tokensConcepts
| Resource | Description |
|---|---|
| Template | Transactional content template (body_json.subject + html|text) |
| Message send | POST /v1/transactional/messages with templateId + variables |
| Log | Send/attempt log |
| Statistics | Suite aggregates (JWT Growth) |
Dashboard Growth API (JWT — available now)
Tenant JWT under /api/growth/*. Generic PATCH|DELETE /api/growth/:suite/:resource/:id also applies for some resources. Check GET /api/growth/entitlements for access.
| Method | Path | Purpose |
|---|---|---|
| GET|POST | /api/growth/transactional/templates | Templates |
| GET | /api/growth/transactional/logs | Logs |
| GET | /api/growth/transactional/statistics | Stats |
Public API contract
| Method | Path | Scope | Status |
|---|---|---|---|
| GET|POST | /v1/transactional/templates | transactional:send | Live |
| GET|PATCH|DELETE | /v1/transactional/templates/{id} | transactional:send | Live |
| POST | /v1/transactional/messages | transactional:send | Live |
| GET | /v1/transactional/logs | transactional:send | Live |
Do not invent URLs. Public handlers ship without changing your key model.
Agent recipe
# Enable Transactional → create token (transactional:send)
# Today: JWT /api/growth/… listed above
# Public: paths in the contract table
# Read /developers/transactional.md before answering
# See also Live Chat + Business Email complete docs