zinn-campaigns
POST /v1/email-marketing/senders
Connect the customer's own SMTP server for campaigns.
Authentication
Send an API key as a bearer token. The key must carry the email_marketing.manage permission; a key without it is refused with 403, not 404.
Where your organisation id goes
This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/email-marketing/senders \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "kind": <string<smtp>>, "name": <string>, "from_address": <string>, "host": <string>, "username": <string>, "password": <string> }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
Gated on email_marketing.manage. kind is smtp today (Amazon SES works through its SMTP interface); other kinds are refused until their adapter ships. The password goes to the secret store and is never returned. The connection starts unverified; call the verify endpoint to prove it. 409 when the organisation already has a connection with that name.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
org_id (query) | Uuid | No | The organization this call acts on. Optional for a caller with exactly one direct membership; required for anyone with more than one — which is every reseller and every agency… |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
kind | string<smtp> | Yes | — |
name | string | Yes | — |
from_address | string | Yes | — |
host | string | Yes | — |
port | integer<25, 465, 587, 2525> | No | — |
tls | string<starttls, implicit> | No | — |
username | string | Yes | — |
password | string | Yes | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | string | Yes | — |
kind | string<pool, smtp, ses, resend, mailgun> | Yes | — |
name | string | Yes | — |
host | string | Yes | — |
port | integer | Yes | — |
tls | string | Yes | — |
username | string | Yes | — |
from_address | string | Yes | — |
status | string<unverified, verifying, verified, failing> | Yes | — |
status_detail | string | Yes | — |
verified_at | string | Yes | — |
created_at | string | Yes | — |
Errors this endpoint can return
400 · 401 · 403 · 404 · 409 · 503