Kampanie

Utwórz kampanię (szkic)

Tworzy kampanię w statusie szkic z pierwszymi leadami (do 200; kolejne dodasz przez POST /campaigns/{id}/leads): NIC nie jest wysyłane. Uruchomienie to osobne wywołanie POST /campaigns/{id}/status. Te same walidacje co w aplikacji (poprawność skrzynki, pomijanie leadów odrzuconych i wypisanych). Szkic nie liczy się do limitu kampanii planu: limit sprawdza dopiero uruchomienie.

Wymagany zakres klucza: campaigns:write.

post/campaigns

Request

  • Base URL: https://outreachpilot.pl/api/v1
  • URL: https://outreachpilot.pl/api/v1/campaigns
  • Auth: HTTP bearer

Request body

namestring

Nazwa kampanii. Bez niej powstaje nazwa automatyczna (branża, miasto, data).

lead_idsstring[] required

Leady do kampanii (1-200). Resztę dodaj przez POST /campaigns/{id}/leads (do 1000 na żądanie). Odrzuceni, z bounce'em i wypisani są pomijani.

email_account_idstring

Skrzynka nadawcza. Domyślnie pierwsza podłączona.

daily_limitinteger

Maks. wiadomości dziennie z tej kampanii.

sending_window_startstring

Początek okna wysyłki (HH:MM, czas Warszawy).

sending_window_endstring

Koniec okna wysyłki (HH:MM).

track_opensboolean
track_clicksboolean

Śledzenie kliknięć (przepisywanie linków). Domyślnie wyłączone dla nowych kampanii cold: linki przez adres pośredni zwiększają ryzyko spamu.

workspace_idstring

Klient agencji, do którego należy kampania (ID z GET /workspaces). Bez pola kampania dziedziczy klienta po swoich leadach (leady z różnych klientów to błąd 422). Leady i skrzynka muszą być tego klienta.

Response

Utworzono.

Changes

No recorded changes to this operation across all 1 revision of this API.