Campaigns
POST /v1/campaigns
Create a campaign from a template and an audience.
Authentifizierung
Senden Sie einen API-Schlüssel als Bearer-Token. Dieser Endpunkt gibt in der Spezifikation keine spezifische Berechtigung an. Versehen Sie Ihren Schlüssel daher mit den minimal erforderlichen Rechten und prüfen Sie die Antwort, anstatt Annahmen zu treffen.
Hier kommt Ihre Organisations-ID hin
Dieser Endpunkt akzeptiert org_id als Feld im JSON-Body.
Die ID Ihrer Organisation finden Sie im Dashboard auf dem Bildschirm für API-Schlüssel direkt neben dem Schlüssel selbst. Sie ist bei jedem Ihrer Aufrufe dieselbe.
Ausprobieren
Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.
curl -X POST https://api.zinndigital.com/v1/campaigns \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string>, "template_id": <string> }'Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole
Details
Create a campaign from a template and an audience segment. It is created as a draft and sends nothing until the send endpoint is called.
Anfragekörper
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
name | string | Ja | — |
template_id | string | Ja | — |
segment_id | string | Nein | — |
channels | string<email, in_app, slack, telegram>[] | Nein | — |
scheduled_for | string | Nein | — |
include_not_in_good_standing | boolean | Nein | ⚖️ Suspended and unpaid organisations are excluded by default (CLAUDE.md §2.46); this is the explicit per-campaign override that makes a win-back campaign possible. The skip is… |
org_id | string | Nein | — |
Antwort
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
id | string | Ja | — |
org_id | string | Ja | — |
name | string | Ja | — |
template_id | string | Ja | — |
segment_id | string | Nein | — |
purpose | string<marketing, transactional> | Ja | — |
channels | string[] | Ja | — |
status | string<draft, scheduled, sending, paused, sent, cancelled, failed> | Ja | — |
scheduled_for | string | Nein | — |
include_not_in_good_standing | boolean | Nein | — |
total_recipients | integer | Ja | — |
skipped | CampaignSkipCounts | Ja | ⛔ Every skip counted separately and never silent, and **every one is present even when it is zero**. "4,127 recipients, 312 skipped — not in good standing" is rendered from thes… |
delivery | CampaignDeliveryCounts | Nein | ⛔ `sent` is NOT `delivered`. `sent` means a provider accepted the hand-off; `delivered` means the receiving server accepted it, which arrives later by webhook. A screen showing… |
last_error | string | Nein | — |
created_at | string | Ja | — |
started_at | string | Nein | — |
finished_at | string | Nein | — |
Fehler, die dieser Endpunkt zurückgeben kann
401 · 403 · 422