Campaigns
POST /v1/campaigns/esp
Connect an e-mail provider account.
Uwierzytelnianie
Wyślij klucz API jako token bearer. Ten punkt końcowy nie określa konkretnego uprawnienia w specyfikacji, więc nadaj swojemu kluczowi minimum potrzebnych uprawnień i sprawdź odpowiedź zamiast zakładać.
Miejsce na identyfikator organizacji
Ten punkt końcowy przyjmuje org_id jako pole w treści JSON.
Identyfikator Twojej organizacji znajduje się na ekranie kluczy API w Twoim panelu, obok samego klucza. Jest to ten sam identyfikator w każdym wywołaniu, które wykonujesz.
Wypróbuj
Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.
curl -X POST https://api.zinndigital.com/v1/campaigns/esp \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "api_key": <string> }'Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API
Szczegóły
The key is written to Vault and never to the database. Connecting resets the connection to unverified — a new key behind an old "verified" badge is a connection claiming a proof it does not have.
Treść żądania
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
api_key | string | Tak | — |
from_local_part | string | Nie | — |
from_display_name | string | Nie | — |
sending_domain | string | Nie | — |
reply_to | string | Nie | — |
org_id | string | Nie | — |
Odpowiedź
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
connected | boolean | Tak | — |
id | string | Nie | — |
provider | string | Tak | — |
status | string<not_connected, unverified, verified, rejected> | Tak | — |
from_address | string | Nie | — |
from_local_part | string | Nie | — |
from_display_name | string | Nie | — |
sending_domain | string | Nie | — |
reply_to | string | Nie | — |
verified_domains | EspVerifiedDomain[] | Nie | — |
last_verified_at | string | Nie | — |
last_error | string | Nie | — |
stats | CampaignDeliveryCounts | Nie | ⛔ `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… |
Błędy, które ten punkt końcowy może zwrócić
401 · 403 · 422 · 503