Udostępnij przez

ConvertKit (niezależny wydawca)

ConvertKit to centrum marketingu go-to dla twórców, które ułatwia rozwijanie i zarabianie na odbiorcach. Przekonwertuj swoich obserwujących z mediów społecznościowych, YouTube i nie tylko na listę e-mail z piękną stroną docelową i szablonami opt-in.

Ten łącznik jest dostępny w następujących produktach i regionach:

Usługa Class Regions
Copilot Studio Premium Wszystkie regiony usługi Power Automate z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Logic Apps Standard Wszystkie regiony usługi Logic Apps z wyjątkiem następujących:
     — Regiony platformy Azure Government
     — Regiony platformy Azure (Chiny)
     - Departament Obrony USA (DoD)
Power Apps Premium Wszystkie regiony usługi Power Apps z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Power Automate Premium Wszystkie regiony usługi Power Automate z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Kontakt
Name Troy Taylor
adres URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
Metadane łącznika
Publisher Troy Taylor, Firma Solutions
Witryna internetowa https://convertkit.com/
Zasady ochrony prywatności https://convertkit.com/privacy
Kategorie Marketing

Tworzenie połączenia

Łącznik obsługuje następujące typy uwierzytelniania:
Wartość domyślna Parametry tworzenia połączenia. Wszystkie regiony Nie można udostępniać

Domyślny

Dotyczy: wszystkie regiony

Parametry tworzenia połączenia.

Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.

Name Typ Description Wymagane
Wpis tajny interfejsu API securestring Wpis tajny interfejsu API dla tego interfejsu API Prawda

Limity ograniczania

Nazwa Wywołania Okres odnowienia
Wywołania interfejsu API na połączenie 100 60 sekund

Akcje

Aktualizowanie emisji

Aktualizuje atrybuty określonej emisji. Emisje, które aktualnie wysyłają lub które zostały wysłane, mogą nie zostać zaktualizowane.
Aktualizowanie subskrybenta

Aktualizuje informacje dla pojedynczego subskrybenta.
Anuluj subskrypcję

Anuluj subskrypcję ze wszystkich formularzy i sekwencji.
Dodawanie subskrybenta do formularza

Subskrybuj adres e-mail do jednego z formularzy.
Dodawanie subskrybenta do sekwencji

Subskrybuj adres e-mail do jednej z sekwencji.
Niszczenie emisji

Trwałe usunięcie wersji roboczej lub zaplanowanego rekordu emisji. Emisje, które aktualnie wysyłają lub które zostały wysłane, mogą nie zostać usunięte.
Pobieranie emisji

Pobiera szczegóły konkretnej emisji, w tym wersje robocze, zaplanowane i wcześniej wysłane emisje.
Pobieranie formularzy

Pobierz listę wszystkich formularzy dla konta.
Pobieranie konta

Pobiera bieżące konto.
Pobieranie statystyk emisji

Pobiera statystyki (liczba adresatów, szybkość otwierania, szybkość kliknięć, liczba subskrypcji, łączna liczba kliknięć, stan i postęp wysyłania) dla określonej emisji.
Pobieranie subskrybenta

Pobiera pojedynczy rekord subskrybenta.
Pobieranie zakupu

Pobieranie określonego zakupu według identyfikatora.
Sekwencje listy

Pobiera listę sekwencji dla konta.
Tagowanie subskrybenta

Tagi są obsługiwane jako subskrypcje. Subskrybuj adres e-mail do tagu, aby ten tag był stosowany do subskrybenta przy użyciu tego adresu e-mail.
Tworzenie emisji

Utwórz wersję roboczą lub zaplanowaną emisję. Można utworzyć wersję roboczą emisji bez żadnych atrybutów. Zaplanowane emisje co najmniej powinny zawierać wiersz tematu i zawartość.
Tworzenie tagu

Tworzy nowy tag.
Tworzenie zakupu

Utwórz zakup.
Usuwanie tagu od subskrybenta pocztą e-mail

Usuń tag z subskrybenta na podstawie adresu e-mail.
Usuwanie tagu z subskrybenta

Usuwa tag z subskrybenta.
Wyświetlanie listy emisji

Pobiera listę wszystkich emisji dla twojego konta.
Wyświetlanie listy subskrybentów

Zwraca listę subskrybentów. W przypadku anulowania subskrypcji użyj anulowanej wartości dla parametru pola sortowania (obecnie jest to jedyne obsługiwane dodatkowe pole sortowania).
Wyświetlanie listy subskrypcji do sekwencji

Pobiera subskrypcje do sekwencji, w tym dane subskrybentów.
Wyświetlanie listy subskrypcji do tagu

Pobiera listę subskrypcji do tagu, w tym dane subskrybenta.
Wyświetlanie listy subskrypcji w formularzu

Pobiera listę subskrypcji do formularza, w tym dane subskrybenta.
Wyświetlanie listy tagów

Pobiera listę tagów dla konta.
Wyświetlanie listy tagów subskrybenta

Pobiera listę wszystkich tagów dla subskrybenta.
Wyświetlanie listy zakupów

Pobierz listę wszystkich zakupów dla konta.

Aktualizowanie emisji

Identyfikator operacji:
BroadcastUpdate

Aktualizuje atrybuty określonej emisji. Emisje, które aktualnie wysyłają lub które zostały wysłane, mogą nie zostać zaktualizowane.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator emisji
 broadcast_id True string

Unikatowy identyfikator emisji.
Description
 description string

Opis.
Temat
 subject string

Temat.
Content
 content string

Zawartość.
Adres e-mail
 email_address string

Adres e-mail.
Szablon układu wiadomości e-mail
 email_layout_template string

Szablon układu wiadomości e-mail.
Public
 public boolean

Czy jest to publiczne.
Opublikowano w:
 published_at string

Po opublikowaniu w.
Wyślij o
 send_at string

Po wysłaniu.
Alt miniatury
 thumbnail_alt string

Tekst alternatywny miniatury.
Adres URL miniatury
 thumbnail_url string

Adres URL miniatury.

Zwraca

Nazwa Ścieżka Typ Opis
identyfikator
 broadcast.id integer

Unikatowy identyfikator.
Utworzono pod adresem
 broadcast.created_at string

Po utworzeniu na.
Temat
 broadcast.subject string

Temat.
Description
 broadcast.description string

Opis.
Content
 broadcast.content string

Zawartość.
Public
 broadcast.public boolean

Czy jest to publiczne.
Opublikowano w:
 broadcast.published_at string

Po opublikowaniu w.
Wyślij o
 broadcast.send_at string

Po wysłaniu.
Alt miniatury
 broadcast.thumbnail_alt string

Tekst alternatywny miniatury.
Adres URL miniatury
 broadcast.thumbnail_url string

Adres URL miniatury.
Adres e-mail
 broadcast.email_address string

Adres e-mail.
Szablon układu wiadomości e-mail
 broadcast.email_layout_template string

Szablon układu wiadomości e-mail.

Aktualizowanie subskrybenta

Identyfikator operacji:
SubscriberUpdate

Aktualizuje informacje dla pojedynczego subskrybenta.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator subskrybenta
 subscriber_id True string

Unikatowy identyfikator subskrybenta.
Imię
 first_name string

Imię.
Adres e-mail
 email_address string

Adres e-mail.

Zwraca

Nazwa Ścieżka Typ Opis
identyfikator
 subscriber.id integer

Unikatowy identyfikator.
Imię
 subscriber.first_name string

Imię.
Adres e-mail
 subscriber.email_address string

Adres e-mail.
State
 subscriber.state string

Stan.
Utworzono pod adresem
 subscriber.created_at string

Po utworzeniu na.

Anuluj subskrypcję

Identyfikator operacji:
SubscriberUnsub

Anuluj subskrypcję ze wszystkich formularzy i sekwencji.

Parametry

Nazwa Klucz Wymagane Typ Opis
Email
 email True string

Adres e-mail.

Zwraca

Nazwa Ścieżka Typ Opis
identyfikator
 subscriber.id integer

Unikatowy identyfikator.
Imię
 subscriber.first_name string

Imię.
Adres e-mail
 subscriber.email_address string

Adres e-mail.
State
 subscriber.state string

Stan.
Utworzono pod adresem
 subscriber.created_at string

Po utworzeniu na.
Nazwisko
 subscriber.fields.last_name string

Nazwisko.

Dodawanie subskrybenta do formularza

Identyfikator operacji:
FormSubAdd

Subskrybuj adres e-mail do jednego z formularzy.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator formularza
 form_id True string

Unikatowy identyfikator formularza.
Email
 email True string

Adres e-mail.
Imię
 first_name string

Imię.
Etykiety
 tags array of integer

Zwraca

Nazwa Ścieżka Typ Opis
identyfikator
 subscription.id integer

Unikatowy identyfikator.
State
 subscription.state string

Stan.
Utworzono pod adresem
 subscription.created_at string

Po utworzeniu na.
Źródło
 subscription.source string

Źródło.
Odsyłacz
 subscription.referrer string

Odwołanie.
Subskrybowalny identyfikator
 subscription.subscribable_id integer

Subskrybowany unikatowy identyfikator.
Typ subskrybowania
 subscription.subscribable_type string

Typ subskrybowania.
identyfikator
 subscription.subscriber.id integer

Unikatowy identyfikator.
Imię
 subscription.subscriber.first_name string

Imię.
Adres e-mail
 subscription.subscriber.email_address string

Adres e-mail.
State
 subscription.subscriber.state string

Stan.
Utworzono pod adresem
 subscription.subscriber.created_at string

Po utworzeniu na.

Dodawanie subskrybenta do sekwencji

Identyfikator operacji:
SequenceSubAdd

Subskrybuj adres e-mail do jednej z sekwencji.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator sekwencji
 sequence_id True string

Unikatowy identyfikator sekwencji.
Email
 email True string

Adres e-mail.
Imię
 first_name string

Imię.
Etykiety
 tags array of integer

Zwraca

Nazwa Ścieżka Typ Opis
identyfikator
 subscription.id integer

Unikatowy identyfikator.
State
 subscription.state string

Stan.
Utworzono pod adresem
 subscription.created_at string

Po utworzeniu na.
Źródło
 subscription.source string

Źródło.
Odsyłacz
 subscription.referrer string

Odwołanie.
Subskrybowalny identyfikator
 subscription.subscribable_id integer

Subskrybowany unikatowy identyfikator.
Typ subskrybowania
 subscription.subscribable_type string

Typ subskrybowania.
identyfikator
 subscription.subscriber.id integer

Unikatowy identyfikator.

Niszczenie emisji

Identyfikator operacji:
BroadcastDelete

Trwałe usunięcie wersji roboczej lub zaplanowanego rekordu emisji. Emisje, które aktualnie wysyłają lub które zostały wysłane, mogą nie zostać usunięte.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator emisji
 broadcast_id True string

Unikatowy identyfikator emisji.

Zwraca

response
string

Pobieranie emisji

Identyfikator operacji:
BroadcastGet

Pobiera szczegóły konkretnej emisji, w tym wersje robocze, zaplanowane i wcześniej wysłane emisje.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator emisji
 broadcast_id True string

Unikatowy identyfikator emisji.

Zwraca

Nazwa Ścieżka Typ Opis
identyfikator
 broadcast.id integer

Unikatowy identyfikator.
Utworzono pod adresem
 broadcast.created_at string

Po utworzeniu na.
Temat
 broadcast.subject string

Temat.
Description
 broadcast.description string

Opis.
Content
 broadcast.content string

Zawartość.
Public
 broadcast.public boolean

Czy jest to publiczne.
Opublikowano w:
 broadcast.published_at string

Po opublikowaniu w.
Wyślij o
 broadcast.send_at string

Po wysłaniu.
Alt miniatury
 broadcast.thumbnail_alt string

Tekst alternatywny miniatury.
Adres URL miniatury
 broadcast.thumbnail_url string

Adres URL miniatury.
Adres e-mail
 broadcast.email_address string

Adres e-mail.
Szablon układu wiadomości e-mail
 broadcast.email_layout_template string

Szablon układu wiadomości e-mail.

Pobieranie formularzy

Identyfikator operacji:
FormList

Pobierz listę wszystkich formularzy dla konta.

Zwraca

Nazwa Ścieżka Typ Opis
Formularze
 forms array of object
identyfikator
 forms.id integer

Unikatowy identyfikator.
Name
 forms.name string

Nazwa.
Utworzono pod adresem
 forms.created_at string

Po utworzeniu na.
Typ
 forms.type string

Typ.
Format
 forms.format string

Format.
adres URL
 forms.url string

Adres URL.
Osadzanie struktury JS
 forms.embed_js string

Kod JavaScript do osadzenia.
Adres URL osadzania
 forms.embed_url string

Adres URL do osadzenia.
Title
 forms.title string

Tytuł.
Description
 forms.description string

Opis.
Tekst przycisku rejestracji
 forms.sign_up_button_text string

Tekst przycisku rejestracji.
Komunikat o powodzeniu
 forms.success_message string

Komunikat o powodzeniu.
Archiwizowane
 forms.archived boolean

Czy zarchiwizowane.
UID
 forms.uid string

Unikatowy identyfikator.

Pobieranie konta

Identyfikator operacji:
Account

Pobiera bieżące konto.

Zwraca

Nazwa Ścieżka Typ Opis
Name
 name string

Nazwa.
Typ planu
 plan_type string

Typ planu.
Podstawowy adres e-mail
 primary_email_address string

Podstawowy adres e-mail.

Pobieranie statystyk emisji

Identyfikator operacji:
BroadcastGetStat

Pobiera statystyki (liczba adresatów, szybkość otwierania, szybkość kliknięć, liczba subskrypcji, łączna liczba kliknięć, stan i postęp wysyłania) dla określonej emisji.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator emisji
 broadcast_id True string

Unikatowy identyfikator emisji.

Zwraca

Nazwa Ścieżka Typ Opis
Nadawać
 broadcast array of object
identyfikator
 broadcast.id integer

Unikatowy identyfikator.
Adresatów
 broadcast.stats.recipients integer

Adresaci.
Stawka otwarcia
 broadcast.stats.open_rate float

Szybkość otwierania.
Szybkość kliknięć
 broadcast.stats.click_rate float

Szybkość kliknięć.
Anulowania subskrypcji
 broadcast.stats.unsubscribes integer

Subskrypcje.
Łączna liczba kliknięć
 broadcast.stats.total_clicks integer

Łączna liczba kliknięć.
Pokaż łączne kliknięcia
 broadcast.stats.show_total_clicks boolean

Czy pokazać łączną liczbę kliknięć.
Status
 broadcast.stats.status string

Stan.
Progress
 broadcast.stats.progress integer

Postęp.

Pobieranie subskrybenta

Identyfikator operacji:
SubscriberGet

Pobiera pojedynczy rekord subskrybenta.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator subskrybenta
 subscriber_id True string

Unikatowy identyfikator subskrybenta.

Zwraca

Nazwa Ścieżka Typ Opis
identyfikator
 subscriber.id integer

Unikatowy identyfikator.
Imię
 subscriber.first_name string

Imię.
Adres e-mail
 subscriber.email_address string

Adres e-mail.
State
 subscriber.state string

Stan.
Utworzono pod adresem
 subscriber.created_at string

Po utworzeniu na.
Nazwisko
 subscriber.fields.last_name string

Nazwisko.

Pobieranie zakupu

Identyfikator operacji:
PurchaseGet

Pobieranie określonego zakupu według identyfikatora.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator zakupu
 purchase_id True string

Identyfikator zakupu.

Zwraca

Nazwa Ścieżka Typ Opis
identyfikator
 id integer

Unikatowy identyfikator.
Identyfikator transakcji
 transaction_id string

Unikatowy identyfikator transakcji.
Status
 status string

Stan.
Adres e-mail
 email_address string

Adres e-mail.
Waluta
 currency string

Waluta.
Czas transakcji
 transaction_time string

Czas transakcji.
Podsumowanie częściowe
 subtotal integer

Suma częściowa.
Żegluga
 shipping integer

Wysyłka.
Rabat
 discount integer

Rabat.
Podatek
 tax integer

Podatek.
Total
 total integer

Suma.
Products
 products array of object
Cena jednostkowa
 products.unit_price integer

Cena jednostkowa.
Ilość
 products.quantity integer

Ilość.
SKU
 products.sku string

Jednostka SKU.
Name
 products.name string

Nazwa.

Sekwencje listy

Identyfikator operacji:
SequenceList

Pobiera listę sekwencji dla konta.

Zwraca

Nazwa Ścieżka Typ Opis
Kursy
 courses array of object
identyfikator
 courses.id integer

Unikatowy identyfikator.
Name
 courses.name string

Nazwa.
Utworzono pod adresem
 courses.created_at string

Po utworzeniu na.

Tagowanie subskrybenta

Identyfikator operacji:
TagSub

Tagi są obsługiwane jako subskrypcje. Subskrybuj adres e-mail do tagu, aby ten tag był stosowany do subskrybenta przy użyciu tego adresu e-mail.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator tagu
 tag_id True string

Unikatowy identyfikator tagu.
Email
 email string

Adres e-mail.
Imię
 first_name string

Imię.
Etykiety
 tags array of integer

Zwraca

Nazwa Ścieżka Typ Opis
identyfikator
 subscription.id integer

Unikatowy identyfikator.
State
 subscription.state string

Stan.
Utworzono pod adresem
 subscription.created_at string

Po utworzeniu na.
Źródło
 subscription.source string

Źródło.
Odsyłacz
 subscription.referrer string

Odwołanie.
Subskrybowalny identyfikator
 subscription.subscribable_id integer

Subskrybowany unikatowy identyfikator.
Typ subskrybowania
 subscription.subscribable_type string

Typ subskrybowania.
identyfikator
 subscription.subscriber.id integer

Unikatowy identyfikator.

Tworzenie emisji

Identyfikator operacji:
BroadcastAdd

Utwórz wersję roboczą lub zaplanowaną emisję. Można utworzyć wersję roboczą emisji bez żadnych atrybutów. Zaplanowane emisje co najmniej powinny zawierać wiersz tematu i zawartość.

Parametry

Nazwa Klucz Wymagane Typ Opis
Description
 description string

Opis.
Temat
 subject string

Temat.
Content
 content string

Zawartość.
Adres e-mail
 email_address string

Adres e-mail.
Szablon układu wiadomości e-mail
 email_layout_template string

Szablon układu wiadomości e-mail.
Public
 public boolean

Czy jest to publiczne.
Opublikowano w:
 published_at string

Po opublikowaniu w.
Wyślij o
 send_at string

Po wysłaniu.
Alt miniatury
 thumbnail_alt string

Tekst alternatywny miniatury.
Adres URL miniatury
 thumbnail_url string

Adres URL miniatury.

Zwraca

Nazwa Ścieżka Typ Opis
identyfikator
 broadcast.id integer

Unikatowy identyfikator.
Utworzono pod adresem
 broadcast.created_at string

Po utworzeniu na.
Temat
 broadcast.subject string

Temat.
Description
 broadcast.description string

Opis.
Content
 broadcast.content string

Zawartość.
Public
 broadcast.public boolean

Czy jest to publiczne.
Opublikowano w:
 broadcast.published_at string

Po opublikowaniu w.
Wyślij o
 broadcast.send_at string

Po wysłaniu.
Alt miniatury
 broadcast.thumbnail_alt string

Tekst alternatywny miniatury.
Adres URL miniatury
 broadcast.thumbnail_url string

Adres URL miniatury.
Adres e-mail
 broadcast.email_address string

Adres e-mail.
Szablon układu wiadomości e-mail
 broadcast.email_layout_template string

Szablon układu wiadomości e-mail.

Tworzenie tagu

Identyfikator operacji:
TagAdd

Tworzy nowy tag.

Parametry

Nazwa Klucz Wymagane Typ Opis
Name
 name True string

Nazwa.

Zwraca

Nazwa Ścieżka Typ Opis
Identyfikator konta
 account_id integer

Unikatowy identyfikator konta.
Utworzono pod adresem
 created_at string

Po utworzeniu na.
Usunięto o
 deleted_at string

Po usunięciu.
identyfikator
 id integer

Unikatowy identyfikator.
Name
 name string

Nazwa.
State
 state string

Stan.
Zaktualizowano o
 updated_at string

Po zaktualizowaniu o.

Tworzenie zakupu

Identyfikator operacji:
PurchaseAdd

Utwórz zakup.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator transakcji
 transaction_id True string

Unikatowy identyfikator transakcji.
Adres e-mail
 email_address True string

Adres e-mail.
Imię
 first_name string

Imię.
Waluta
 currency True string

Waluta.
Czas transakcji
 transaction_time string

Czas transakcji.
Podsumowanie częściowe
 subtotal integer

Suma częściowa.
Podatek
 tax integer

Podatek.
Żegluga
 shipping integer

Wysyłka.
Rabat
 discount integer

Rabat.
Total
 total integer

Suma.
Status
 status string

Stan.
identyfikator PID
 pid True integer

Identyfikator osobisty.
WIEKO
 lid True integer

Pokrywka.
Name
 name True string

Nazwa.
SKU
 sku string

Jednostka SKU.
Cena jednostkowa
 unit_price True integer

Cena jednostkowa.
Ilość
 quantity True integer

Ilość.

Zwraca

Nazwa Ścieżka Typ Opis
identyfikator
 id integer

Unikatowy identyfikator.
Identyfikator transakcji
 transaction_id string

Unikatowy identyfikator transakcji.
Status
 status string

Stan.
Adres e-mail
 email_address string

Adres e-mail.
Waluta
 currency string

Waluta.
Czas transakcji
 transaction_time string

Czas transakcji.
Podsumowanie częściowe
 subtotal integer

Suma częściowa.
Rabat
 discount integer

Rabat.
Podatek
 tax integer

Podatek.
Żegluga
 shipping integer

Wysyłka.
Total
 total integer

Suma.
Products
 products array of object
Cena jednostkowa
 products.unit_price integer

Cena jednostkowa.
Ilość
 products.quantity integer

Ilość.
SKU
 products.sku string

Jednostka SKU.
Name
 products.name string

Nazwa.

Usuwanie tagu od subskrybenta pocztą e-mail

Identyfikator operacji:
TagSubRemoveEmail

Usuń tag z subskrybenta na podstawie adresu e-mail.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator tagu
 tag_id True string

Unikatowy identyfikator tagu.
Email
 email True string

Adres e-mail.

Zwraca

Nazwa Ścieżka Typ Opis
identyfikator
 id integer

Unikatowy identyfikator.
Name
 name string

Nazwa.
Utworzono pod adresem
 created_at string

Po utworzeniu na.

Usuwanie tagu z subskrybenta

Identyfikator operacji:
TagSubRemove

Usuwa tag z subskrybenta.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator subskrybenta
 subscriber_id True string

Unikatowy identyfikator subskrybenta.
Identyfikator tagu
 tag_id True string

Unikatowy identyfikator tagu.

Zwraca

Nazwa Ścieżka Typ Opis
identyfikator
 id integer

Unikatowy identyfikator.
Name
 name string

Nazwa.
Utworzono pod adresem
 created_at string

Po utworzeniu na.

Wyświetlanie listy emisji

Identyfikator operacji:
BroadcastList

Pobiera listę wszystkich emisji dla twojego konta.

Zwraca

Nazwa Ścieżka Typ Opis
Transmisje
 broadcasts array of object
identyfikator
 broadcasts.id integer

Unikatowy identyfikator.
Utworzono pod adresem
 broadcasts.created_at string

Po utworzeniu na.
Temat
 broadcasts.subject string

Temat.

Wyświetlanie listy subskrybentów

Identyfikator operacji:
SubscriberList

Zwraca listę subskrybentów. W przypadku anulowania subskrypcji użyj anulowanej wartości dla parametru pola sortowania (obecnie jest to jedyne obsługiwane dodatkowe pole sortowania).

Parametry

Nazwa Klucz Wymagane Typ Opis
Źródło
 from string

Od.
Do
 to string

Do.
Zaktualizowano z
 updated_from string

Po zaktualizowaniu z.
Zaktualizowano do
 updated_to string

Po zaktualizowaniu do.
Kolejność sortowania
 sort_order string

Kolejność sortowania.
Sortuj pole
 sort_field string

Pole sortowania.
Adres e-mail
 email_address string

Adres e-mail.
Strona
 page integer

Strona.

Zwraca

Nazwa Ścieżka Typ Opis
Łączna liczba subskrybentów
 total_subscribers integer

Łączna liczba subskrybentów.
Strona
 page integer

Strona.
Łączna liczba stron
 total_pages integer

Łączna liczba stron.
Subskrybenci
 subscribers array of object
identyfikator
 subscribers.id integer

Unikatowy identyfikator.
Imię
 subscribers.first_name string

Imię.
Adres e-mail
 subscribers.email_address string

Adres e-mail.
State
 subscribers.state string

Stan.
Utworzono pod adresem
 subscribers.created_at string

Po utworzeniu na.
Nazwisko
 subscribers.fields.last_name string

Nazwisko.

Wyświetlanie listy subskrypcji do sekwencji

Identyfikator operacji:
SequenceSubList

Pobiera subskrypcje do sekwencji, w tym dane subskrybentów.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator sekwencji
 sequence_id True string

Unikatowy identyfikator sekwencji.
Kolejność sortowania
 sort_order string

Kolejność sortowania.
Stan subskrybenta
 subscriber_state string

Stan subskrybenta.
Strona
 page integer

Strona.

Zwraca

Nazwa Ścieżka Typ Opis
Łączna liczba subskrypcji
 total_subscriptions integer

Łączna liczba subskrypcji.
Strona
 page integer

Strona.
Łączna liczba stron
 total_pages integer

Łączna liczba stron.
Subskrypcje
 subscriptions array of object
identyfikator
 subscriptions.id integer

Unikatowy identyfikator.
State
 subscriptions.state string

Stan.
Utworzono pod adresem
 subscriptions.created_at string

Po utworzeniu na.
Źródło
 subscriptions.source string

Źródło.
Odsyłacz
 subscriptions.referrer string

Odwołanie.
Subskrybowalny identyfikator
 subscriptions.subscribable_id integer

Subskrybowany unikatowy identyfikator.
Typ subskrybowania
 subscriptions.subscribable_type string

Typ subskrybowania.
identyfikator
 subscriptions.subscriber.id integer

Unikatowy identyfikator.
Imię
 subscriptions.subscriber.first_name string

Imię.
Adres e-mail
 subscriptions.subscriber.email_address string

Adres e-mail.
State
 subscriptions.subscriber.state string

Stan.
Utworzono pod adresem
 subscriptions.subscriber.created_at string

Po utworzeniu na.
Nazwisko
 subscriptions.subscriber.fields.last_name string

Nazwisko.

Wyświetlanie listy subskrypcji do tagu

Identyfikator operacji:
TagSubList

Pobiera listę subskrypcji do tagu, w tym dane subskrybenta.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator tagu
 tag_id True string

Unikatowy identyfikator tagu.
Kolejność sortowania
 sort_order string

Kolejność sortowania.
Stan subskrybenta
 subscriber_state string

Stan subskrybenta.
Strona
 page integer

Strona.

Zwraca

Nazwa Ścieżka Typ Opis
Łączna liczba subskrypcji
 total_subscriptions integer

Łączna liczba subskrypcji.
Strona
 page integer

Strona.
Łączna liczba stron
 total_pages integer

Łączna liczba stron.
Subskrypcje
 subscriptions array of object
identyfikator
 subscriptions.id integer

Unikatowy identyfikator.
State
 subscriptions.state string

Stan.
Utworzono pod adresem
 subscriptions.created_at string

Po utworzeniu na.
Źródło
 subscriptions.source string

Źródło.
Odsyłacz
 subscriptions.referrer string

Odwołanie.
Subskrybowalny identyfikator
 subscriptions.subscribable_id integer

Subskrybowany unikatowy identyfikator.
Typ subskrybowania
 subscriptions.subscribable_type string

Typ subskrybowania.
identyfikator
 subscriptions.subscriber.id integer

Unikatowy identyfikator.
Imię
 subscriptions.subscriber.first_name string

Imię.
Adres e-mail
 subscriptions.subscriber.email_address string

Adres e-mail.
State
 subscriptions.subscriber.state string

Stan.
Utworzono pod adresem
 subscriptions.subscriber.created_at string

Po utworzeniu na.
Nazwisko
 subscriptions.subscriber.fields.last_name string

Nazwisko.

Wyświetlanie listy subskrypcji w formularzu

Identyfikator operacji:
FormSubList

Pobiera listę subskrypcji do formularza, w tym dane subskrybenta.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator formularza
 form_id True string

Unikatowy identyfikator formularza.
Kolejność sortowania
 sort_order string

Kolejność sortowania.
Stan subskrybenta
 subscriber_state string

Stan subskrybenta.
Strona
 page integer

Strona.

Zwraca

Nazwa Ścieżka Typ Opis
Łączna liczba subskrypcji
 total_subscriptions integer

Łączna liczba subskrypcji.
Strona
 page integer

Strona.
Łączna liczba stron
 total_pages integer

Łączna liczba stron.
Subskrypcje
 subscriptions array of object
identyfikator
 subscriptions.id integer

Unikatowy identyfikator.
State
 subscriptions.state string

Stan.
Utworzono pod adresem
 subscriptions.created_at string

Po utworzeniu na.
Źródło
 subscriptions.source string

Źródło.
Odsyłacz
 subscriptions.referrer string

Odwołanie.
Subskrybowalny identyfikator
 subscriptions.subscribable_id integer

Subskrybowany unikatowy identyfikator.
Typ subskrybowania
 subscriptions.subscribable_type string

Typ subskrybowania.
identyfikator
 subscriptions.subscriber.id integer

Unikatowy identyfikator.
Imię
 subscriptions.subscriber.first_name string

Imię.
Adres e-mail
 subscriptions.subscriber.email_address string

Adres e-mail.
State
 subscriptions.subscriber.state string

Stan.
Utworzono pod adresem
 subscriptions.subscriber.created_at string

Po utworzeniu na.
Nazwisko
 subscriptions.subscriber.fields.last_name string

Nazwisko.

Wyświetlanie listy tagów

Identyfikator operacji:
TagList

Pobiera listę tagów dla konta.

Zwraca

Nazwa Ścieżka Typ Opis
Etykiety
 tags array of object
identyfikator
 tags.id integer

Unikatowy identyfikator.
Name
 tags.name string

Nazwa.
Utworzono pod adresem
 tags.created_at string

Po utworzeniu na.

Wyświetlanie listy tagów subskrybenta

Identyfikator operacji:
SubscriberTags

Pobiera listę wszystkich tagów dla subskrybenta.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator subskrybenta
 subscriber_id True string

Unikatowy identyfikator subskrybenta.

Zwraca

Nazwa Ścieżka Typ Opis
Etykiety
 tags array of object
identyfikator
 tags.id integer

Unikatowy identyfikator.
Name
 tags.name string

Nazwa.
Utworzono pod adresem
 tags.created_at string

Po utworzeniu na.

Wyświetlanie listy zakupów

Identyfikator operacji:
PurchaseList

Pobierz listę wszystkich zakupów dla konta.

Parametry

Nazwa Klucz Wymagane Typ Opis
Strona
 page integer

Strona.

Zwraca

Nazwa Ścieżka Typ Opis
Łączna liczba zakupów
 total_purchases integer

Łączna liczba zakupów.
Strona
 page integer

Strona.
Łączna liczba stron
 total_pages integer

Łączna liczba stron.
Zakupy
 purchases array of object
identyfikator
 purchases.id integer

Unikatowy identyfikator.
Identyfikator transakcji
 purchases.transaction_id string

Unikatowy identyfikator transakcji.
Status
 purchases.status string

Stan.
Adres e-mail
 purchases.email_address string

Adres e-mail.
Waluta
 purchases.currency string

Waluta.
Czas transakcji
 purchases.transaction_time string

Czas transakcji.
Podsumowanie częściowe
 purchases.subtotal integer

Suma częściowa.
Żegluga
 purchases.shipping integer

Wysyłka.
Rabat
 purchases.discount integer

Rabat.
Podatek
 purchases.tax integer

Podatek.
Total
 purchases.total integer

Suma.
Products
 purchases.products array of object
Cena jednostkowa
 purchases.products.unit_price integer

Cena jednostkowa.
Ilość
 purchases.products.quantity integer

Ilość.
SKU
 purchases.products.sku string

Jednostka SKU.
Name
 purchases.products.name string

Nazwa.

Definicje

ciąg

Jest to podstawowy typ danych "string".