ConvertKit (nezávislý vydavatel)

ConvertKit je go-to marketingové centrum pro tvůrce, které usnadňuje růst a zpeněžení cílové skupiny. Převeďte své sledující ze sociálních médií, YouTube a dalších položek na svůj e-mailový seznam s krásnou cílovou stránkou a šablonami pro vyjádření výslovného souhlasu.

Tento konektor je dostupný v následujících produktech a oblastech:

Service	Class	Regions
Copilot Studio	Premium	Všechny oblasti Power Automate s výjimkou následujících:      – státní správa USA (GCC)      – státní správa USA (GCC High)      - China Cloud provozovaný společností 21Vianet      - Ministerstvo obrany USA (DoD)
Logic Apps	Standard	Všechny oblasti Logic Apps s výjimkou následujících:      – Oblasti Azure Government      – Oblasti Azure China      - Ministerstvo obrany USA (DoD)
Power Apps	Premium	Všechny oblasti Power Apps s výjimkou následujících:      – státní správa USA (GCC)      – státní správa USA (GCC High)      - China Cloud provozovaný společností 21Vianet      - Ministerstvo obrany USA (DoD)
Power Automate	Premium	Všechny oblasti Power Automate s výjimkou následujících:      – státní správa USA (GCC)      – státní správa USA (GCC High)      - China Cloud provozovaný společností 21Vianet      - Ministerstvo obrany USA (DoD)

Kontakt
Název	Troy Taylor
URL	https://www.hitachisolutions.com
Email	ttaylor@hitachisolutions.com

Metadata konektoru
Vydavatel	Troy Taylor, Hitachi Solutions
Internetová stránka	https://convertkit.com/
Zásady ochrany osobních údajů	https://convertkit.com/privacy
Kategorie	Marketing

Vytvoření připojení

Konektor podporuje následující typy ověřování:

výchozí	Parametry pro vytvoření připojení	Všechny oblasti	Nesdílitelné

Výchozí

Použitelné: Všechny oblasti

Parametry pro vytvoření připojení

Toto připojení není možné sdílet. Pokud se power app sdílí s jiným uživatelem, zobrazí se výzva k explicitní vytvoření nového připojení.

Název	Typ	Description	Povinné
Tajný klíč rozhraní API	securestring	Tajný kód rozhraní API pro toto rozhraní API	Pravdivé

Limity omezování

Name	Volání	Období obnovení
Volání rozhraní API na připojení	100	60 sekund

Akce

Aktualizace odběratele	Aktualizuje informace pro jednoho odběratele.
Aktualizace vysílání	Aktualizuje atributy konkrétního vysílání. Vysílání, která se právě odesílají nebo které byly odeslány, se nemusí aktualizovat.
Načtení vysílání	Načte podrobnosti o konkrétním vysílání, včetně konceptů, naplánovaných a dříve odeslaných vysílání.
Odebrání značky od odběratele	Odebere značku odběratele.
Odebrání značky odběratele e-mailem	Odebrání značky odběratele e-mailovou adresou
Odhlášení odběru odběru	Odhlaste odběratele ze všech vašich formulářů a sekvencí.
Označení odběratele	Značky se zpracovávají jako předplatná. Přihlaste se k odběru e-mailové adresy značky, aby byla tato značka použita pro odběratele s danou e-mailovou adresou.
Posloupnosti seznamů	Načte seznam sekvencí pro účet.
Přidání odběratele do formuláře	Přihlaste se k odběru e-mailové adresy některého z vašich formulářů.
Přidání odběratele do sekvence	Přihlaste se k odběru e-mailové adresy některé z vašich sekvencí.
Seznam odběratelů	Vrátí seznam vašich odběratelů. Pokud chcete zrušit odběr jenom, použijte zrušenou hodnotu pro parametry pole řazení (aktuálně je to jediné podporované další pole řazení).
Vytvoření nákupu	Vytvořte nákup.
Vytvoření vysílání	Vytvořte koncept nebo plánované vysílání. Koncept vysílání můžete vytvořit bez jakýchkoli atributů. Naplánované vysílání by mělo obsahovat minimálně řádek předmětu a váš obsah.
Vytvoření značky	Vytvoří novou značku.
Výpis nákupů	Načtěte seznam všech nákupů pro účet.
Výpis předplatných do posloupnosti	Načte odběry do sekvence, včetně dat odběratele.
Výpis předplatných formuláře	Načte seznam předplatných do formuláře, včetně dat odběratele.
Výpis předplatných značky	Načte seznam předplatných na značku, včetně dat odběratele.
Výpis všesměrových vysílání	Načte seznam všech vysílání pro váš účet.
Výpis značek	Načte seznam značek pro účet.
Výpis značek odběratele	Načte seznam všech značek pro předplatitele.
Zničení vysílání	Trvale odstraníte koncept nebo naplánovaný záznam vysílání. Vysílání, která aktuálně odesílají nebo které byly odeslány, nemusí být odstraněna.
Získání formulářů	Načtěte seznam všech formulářů pro váš účet.
Získání nákupu	Načtěte konkrétní nákup podle ID.
Získání odběratele	Načte jeden záznam odběratele.
Získání statistik vysílání	Načte statistiku (počet příjemců, počet otevření, míra kliknutí, počet odhlášení odběru, celkový počet kliknutí, stav a průběh odeslání) pro konkrétní vysílání.
Získání účtu	Načte aktuální účet.

Aktualizace odběratele

ID operace:

SubscriberUpdate

Aktualizuje informace pro jednoho odběratele.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID odběratele	subscriber_id	True	string	Jedinečný identifikátor odběratele.
Křestní jméno	first_name		string	Jméno.
E-mailová adresa	email_address		string	E-mailová adresa.

Návraty

Name	Cesta	Typ	Description
ID	subscriber.id	integer	Jedinečný identifikátor.
Křestní jméno	subscriber.first_name	string	Jméno.
E-mailová adresa	subscriber.email_address	string	E-mailová adresa.
Stát	subscriber.state	string	Stát
Vytvořeno na adrese	subscriber.created_at	string	Při vytváření na adrese.

Aktualizace vysílání

ID operace:

BroadcastUpdate

Aktualizuje atributy konkrétního vysílání. Vysílání, která se právě odesílají nebo které byly odeslány, se nemusí aktualizovat.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID vysílání	broadcast_id	True	string	Jedinečný identifikátor všesměrového vysílání.
Description	description		string	Popis.
Předmět	subject		string	Předmět.
Content	content		string	Obsah.
E-mailová adresa	email_address		string	E-mailová adresa.
Šablona rozložení e-mailu	email_layout_template		string	Šablona rozložení e-mailu
Public	public		boolean	Zda je veřejná.
Publikováno na adrese	published_at		string	Při publikování na adrese
Odeslat na adresu	send_at		string	Při odesílání.
Miniatura – alt	thumbnail_alt		string	Alternativní text miniatury
Adresa URL miniatury	thumbnail_url		string	Adresa URL miniatury.

Návraty

Name	Cesta	Typ	Description
ID	broadcast.id	integer	Jedinečný identifikátor.
Vytvořeno na adrese	broadcast.created_at	string	Při vytváření na adrese.
Předmět	broadcast.subject	string	Předmět.
Description	broadcast.description	string	Popis.
Content	broadcast.content	string	Obsah.
Public	broadcast.public	boolean	Zda je veřejná.
Publikováno na adrese	broadcast.published_at	string	Při publikování na adrese
Odeslat na adresu	broadcast.send_at	string	Při odeslání.
Miniatura – alt	broadcast.thumbnail_alt	string	Alternativní text miniatury
Adresa URL miniatury	broadcast.thumbnail_url	string	Adresa URL miniatury.
E-mailová adresa	broadcast.email_address	string	E-mailová adresa.
Šablona rozložení e-mailu	broadcast.email_layout_template	string	Šablona rozložení e-mailu

Načtení vysílání

ID operace:

BroadcastGet

Načte podrobnosti o konkrétním vysílání, včetně konceptů, naplánovaných a dříve odeslaných vysílání.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID vysílání	broadcast_id	True	string	Jedinečný identifikátor všesměrového vysílání.

Návraty

Name	Cesta	Typ	Description
ID	broadcast.id	integer	Jedinečný identifikátor.
Vytvořeno na adrese	broadcast.created_at	string	Při vytváření na adrese.
Předmět	broadcast.subject	string	Předmět.
Description	broadcast.description	string	Popis.
Content	broadcast.content	string	Obsah.
Public	broadcast.public	boolean	Zda je veřejná.
Publikováno na adrese	broadcast.published_at	string	Při publikování na adrese
Odeslat na adresu	broadcast.send_at	string	Při odeslání.
Miniatura – alt	broadcast.thumbnail_alt	string	Alternativní text miniatury
Adresa URL miniatury	broadcast.thumbnail_url	string	Adresa URL miniatury.
E-mailová adresa	broadcast.email_address	string	E-mailová adresa.
Šablona rozložení e-mailu	broadcast.email_layout_template	string	Šablona rozložení e-mailu

Odebrání značky od odběratele

ID operace:

TagSubRemove

Odebere značku odběratele.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID odběratele	subscriber_id	True	string	Jedinečný identifikátor odběratele.
ID značky	tag_id	True	string	Jedinečný identifikátor značky.

Návraty

Name	Cesta	Typ	Description
ID	id	integer	Jedinečný identifikátor.
Název	name	string	Název.
Vytvořeno na adrese	created_at	string	Při vytváření na adrese.

Odebrání značky odběratele e-mailem

ID operace:

TagSubRemoveEmail

Odebrání značky odběratele e-mailovou adresou

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID značky	tag_id	True	string	Jedinečný identifikátor značky.
Email	email	True	string	E-mailová adresa.

Návraty

Name	Cesta	Typ	Description
ID	id	integer	Jedinečný identifikátor.
Název	name	string	Název.
Vytvořeno na adrese	created_at	string	Při vytváření na adrese.

Odhlášení odběru odběru

ID operace:

SubscriberUnsub

Odhlaste odběratele ze všech vašich formulářů a sekvencí.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Email	email	True	string	E-mailová adresa.

Návraty

Name	Cesta	Typ	Description
ID	subscriber.id	integer	Jedinečný identifikátor.
Křestní jméno	subscriber.first_name	string	Jméno.
E-mailová adresa	subscriber.email_address	string	E-mailová adresa.
Stát	subscriber.state	string	Stát
Vytvořeno na adrese	subscriber.created_at	string	Při vytváření na adrese.
Příjmení	subscriber.fields.last_name	string	Příjmení.

Označení odběratele

ID operace:

TagSub

Značky se zpracovávají jako předplatná. Přihlaste se k odběru e-mailové adresy značky, aby byla tato značka použita pro odběratele s danou e-mailovou adresou.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID značky	tag_id	True	string	Jedinečný identifikátor značky.
Email	email		string	E-mailová adresa.
Křestní jméno	first_name		string	Jméno.
Štítky	tags		array of integer

Návraty

Name	Cesta	Typ	Description
ID	subscription.id	integer	Jedinečný identifikátor.
Stát	subscription.state	string	Stát
Vytvořeno na adrese	subscription.created_at	string	Při vytváření na adrese.
Zdroj	subscription.source	string	Zdroj.
Odkazující	subscription.referrer	string	Referrér.
Id přihlášení k odběru	subscription.subscribable_id	integer	Jedinečný identifikátor, který se dá přihlásit k odběru.
Typ přihlášení k odběru	subscription.subscribable_type	string	Typ přihlášení k odběru.
ID	subscription.subscriber.id	integer	Jedinečný identifikátor.

Posloupnosti seznamů

ID operace:

SequenceList

Načte seznam sekvencí pro účet.

Návraty

Name	Cesta	Typ	Description
Kurzy	courses	array of object
ID	courses.id	integer	Jedinečný identifikátor.
Název	courses.name	string	Název.
Vytvořeno na adrese	courses.created_at	string	Při vytváření na adrese.

Přidání odběratele do formuláře

ID operace:

FormSubAdd

Přihlaste se k odběru e-mailové adresy některého z vašich formulářů.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID formuláře	form_id	True	string	Jedinečný identifikátor formuláře.
Email	email	True	string	E-mailová adresa.
Křestní jméno	first_name		string	Jméno.
Štítky	tags		array of integer

Návraty

Name	Cesta	Typ	Description
ID	subscription.id	integer	Jedinečný identifikátor.
Stát	subscription.state	string	Stát
Vytvořeno na adrese	subscription.created_at	string	Při vytváření na adrese.
Zdroj	subscription.source	string	Zdroj.
Odkazující	subscription.referrer	string	Referrér.
Id přihlášení k odběru	subscription.subscribable_id	integer	Jedinečný identifikátor, který se dá přihlásit k odběru.
Typ přihlášení k odběru	subscription.subscribable_type	string	Typ přihlášení k odběru.
ID	subscription.subscriber.id	integer	Jedinečný identifikátor.
Křestní jméno	subscription.subscriber.first_name	string	Jméno.
E-mailová adresa	subscription.subscriber.email_address	string	E-mailová adresa.
Stát	subscription.subscriber.state	string	Stát
Vytvořeno na adrese	subscription.subscriber.created_at	string	Při vytváření na adrese.

Přidání odběratele do sekvence

ID operace:

SequenceSubAdd

Přihlaste se k odběru e-mailové adresy některé z vašich sekvencí.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID sekvence	sequence_id	True	string	Jedinečný identifikátor sekvence.
Email	email	True	string	E-mailová adresa.
Křestní jméno	first_name		string	Jméno.
Štítky	tags		array of integer

Návraty

Name	Cesta	Typ	Description
ID	subscription.id	integer	Jedinečný identifikátor.
Stát	subscription.state	string	Stát
Vytvořeno na adrese	subscription.created_at	string	Při vytváření na adrese.
Zdroj	subscription.source	string	Zdroj.
Odkazující	subscription.referrer	string	Referrér.
Id přihlášení k odběru	subscription.subscribable_id	integer	Jedinečný identifikátor, který se dá přihlásit k odběru.
Typ přihlášení k odběru	subscription.subscribable_type	string	Typ přihlášení k odběru.
ID	subscription.subscriber.id	integer	Jedinečný identifikátor.

Seznam odběratelů

ID operace:

SubscriberList

Vrátí seznam vašich odběratelů. Pokud chcete zrušit odběr jenom, použijte zrušenou hodnotu pro parametry pole řazení (aktuálně je to jediné podporované další pole řazení).

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Od	from		string	Od.
To	to		string	Na to.
Aktualizováno z	updated_from		string	Při aktualizaci z.
Aktualizováno na	updated_to		string	Po aktualizaci na
Pořadí řazení	sort_order		string	Pořadí řazení.
Pole řazení	sort_field		string	Pole řazení.
E-mailová adresa	email_address		string	E-mailová adresa.
Stránka	page		integer	Stránka.

Návraty

Name	Cesta	Typ	Description
Celkový počet odběratelů	total_subscribers	integer	Celkový počet odběratelů.
Stránka	page	integer	Stránka.
Total Pages	total_pages	integer	Celkový počet stránek.
Subscribers	subscribers	array of object
ID	subscribers.id	integer	Jedinečný identifikátor.
Křestní jméno	subscribers.first_name	string	Jméno.
E-mailová adresa	subscribers.email_address	string	E-mailová adresa.
Stát	subscribers.state	string	Stát
Vytvořeno na adrese	subscribers.created_at	string	Při vytváření na adrese.
Příjmení	subscribers.fields.last_name	string	Příjmení.

Vytvoření nákupu

ID operace:

PurchaseAdd

Vytvořte nákup.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID transakce	transaction_id	True	string	Jedinečný identifikátor transakce.
E-mailová adresa	email_address	True	string	E-mailová adresa.
Křestní jméno	first_name		string	Jméno.
Měna	currency	True	string	Měna.
Čas transakce	transaction_time		string	Čas transakce.
Mezisoučet	subtotal		integer	Mezisoučty.
Daň	tax		integer	Daň.
Doprava	shipping		integer	Doprava.
Sleva	discount		integer	Sleva.
Total	total		integer	Celkový součet.
Stav	status		string	Stav.
identifikátor PID	pid	True	integer	Osobní identifikátor.
VÍKO	lid	True	integer	Víko.
Název	name	True	string	Název.
skladová jednotka (SKU)	sku		string	Skladová položka.
Jednotková cena	unit_price	True	integer	Jednotková cena.
Množství	quantity	True	integer	Množství.

Návraty

Name	Cesta	Typ	Description
ID	id	integer	Jedinečný identifikátor.
ID transakce	transaction_id	string	Jedinečný identifikátor transakce.
Stav	status	string	Stav.
E-mailová adresa	email_address	string	E-mailová adresa.
Měna	currency	string	Měna.
Čas transakce	transaction_time	string	Čas transakce.
Mezisoučet	subtotal	integer	Mezisoučty.
Sleva	discount	integer	Sleva.
Daň	tax	integer	Daň.
Doprava	shipping	integer	Doprava.
Total	total	integer	Celkový součet.
Products	products	array of object
Jednotková cena	products.unit_price	integer	Jednotková cena.
Množství	products.quantity	integer	Množství.
skladová jednotka (SKU)	products.sku	string	Skladová položka.
Název	products.name	string	Název.

Vytvoření vysílání

ID operace:

BroadcastAdd

Vytvořte koncept nebo plánované vysílání. Koncept vysílání můžete vytvořit bez jakýchkoli atributů. Naplánované vysílání by mělo obsahovat minimálně řádek předmětu a váš obsah.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Description	description		string	Popis.
Předmět	subject		string	Předmět.
Content	content		string	Obsah.
E-mailová adresa	email_address		string	E-mailová adresa.
Šablona rozložení e-mailu	email_layout_template		string	Šablona rozložení e-mailu
Public	public		boolean	Zda je veřejná.
Publikováno na adrese	published_at		string	Při publikování na adrese
Odeslat na adresu	send_at		string	Při odesílání.
Miniatura – alt	thumbnail_alt		string	Alternativní text miniatury
Adresa URL miniatury	thumbnail_url		string	Adresa URL miniatury.

Návraty

Name	Cesta	Typ	Description
ID	broadcast.id	integer	Jedinečný identifikátor.
Vytvořeno na adrese	broadcast.created_at	string	Při vytváření na adrese.
Předmět	broadcast.subject	string	Předmět.
Description	broadcast.description	string	Popis.
Content	broadcast.content	string	Obsah.
Public	broadcast.public	boolean	Zda je veřejná.
Publikováno na adrese	broadcast.published_at	string	Při publikování na adrese
Odeslat na adresu	broadcast.send_at	string	Při odeslání.
Miniatura – alt	broadcast.thumbnail_alt	string	Alternativní text miniatury
Adresa URL miniatury	broadcast.thumbnail_url	string	Adresa URL miniatury.
E-mailová adresa	broadcast.email_address	string	E-mailová adresa.
Šablona rozložení e-mailu	broadcast.email_layout_template	string	Šablona rozložení e-mailu

Vytvoření značky

ID operace:

TagAdd

Vytvoří novou značku.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Název	name	True	string	Název.

Návraty

Name	Cesta	Typ	Description
ID účtu	account_id	integer	Jedinečný identifikátor účtu.
Vytvořeno na adrese	created_at	string	Při vytváření na adrese.
Odstraněno na adrese	deleted_at	string	Když se odstraní na adrese.
ID	id	integer	Jedinečný identifikátor.
Název	name	string	Název.
Stát	state	string	Stát
Aktualizováno na adrese	updated_at	string	Při aktualizaci na adrese

Výpis nákupů

ID operace:

PurchaseList

Načtěte seznam všech nákupů pro účet.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
Stránka	page		integer	Stránka.

Návraty

Name	Cesta	Typ	Description
Celkový počet nákupů	total_purchases	integer	Celkový počet nákupů.
Stránka	page	integer	Stránka.
Total Pages	total_pages	integer	Celkový počet stránek.
Nákupy	purchases	array of object
ID	purchases.id	integer	Jedinečný identifikátor.
ID transakce	purchases.transaction_id	string	Jedinečný identifikátor transakce.
Stav	purchases.status	string	Stav.
E-mailová adresa	purchases.email_address	string	E-mailová adresa.
Měna	purchases.currency	string	Měna.
Čas transakce	purchases.transaction_time	string	Čas transakce.
Mezisoučet	purchases.subtotal	integer	Mezisoučty.
Doprava	purchases.shipping	integer	Doprava.
Sleva	purchases.discount	integer	Sleva.
Daň	purchases.tax	integer	Daň.
Total	purchases.total	integer	Celkový součet.
Products	purchases.products	array of object
Jednotková cena	purchases.products.unit_price	integer	Jednotková cena.
Množství	purchases.products.quantity	integer	Množství.
skladová jednotka (SKU)	purchases.products.sku	string	Skladová položka.
Název	purchases.products.name	string	Název.

Výpis předplatných do posloupnosti

ID operace:

SequenceSubList

Načte odběry do sekvence, včetně dat odběratele.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID sekvence	sequence_id	True	string	Jedinečný identifikátor sekvence.
Pořadí řazení	sort_order		string	Pořadí řazení.
Stav odběratele	subscriber_state		string	Stav odběratele.
Stránka	page		integer	Stránka.

Návraty

Name	Cesta	Typ	Description
Total Subscriptions	total_subscriptions	integer	Celkový počet předplatných.
Stránka	page	integer	Stránka.
Total Pages	total_pages	integer	Celkový počet stránek.
Předplatná	subscriptions	array of object
ID	subscriptions.id	integer	Jedinečný identifikátor.
Stát	subscriptions.state	string	Stát
Vytvořeno na adrese	subscriptions.created_at	string	Při vytváření na adrese.
Zdroj	subscriptions.source	string	Zdroj.
Odkazující	subscriptions.referrer	string	Referrér.
Id přihlášení k odběru	subscriptions.subscribable_id	integer	Jedinečný identifikátor, který se dá přihlásit k odběru.
Typ přihlášení k odběru	subscriptions.subscribable_type	string	Typ přihlášení k odběru.
ID	subscriptions.subscriber.id	integer	Jedinečný identifikátor.
Křestní jméno	subscriptions.subscriber.first_name	string	Jméno.
E-mailová adresa	subscriptions.subscriber.email_address	string	E-mailová adresa.
Stát	subscriptions.subscriber.state	string	Stát
Vytvořeno na adrese	subscriptions.subscriber.created_at	string	Při vytváření na adrese.
Příjmení	subscriptions.subscriber.fields.last_name	string	Příjmení.

Výpis předplatných formuláře

ID operace:

FormSubList

Načte seznam předplatných do formuláře, včetně dat odběratele.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID formuláře	form_id	True	string	Jedinečný identifikátor formuláře.
Pořadí řazení	sort_order		string	Pořadí řazení.
Stav odběratele	subscriber_state		string	Stav odběratele.
Stránka	page		integer	Stránka.

Návraty

Name	Cesta	Typ	Description
Total Subscriptions	total_subscriptions	integer	Celkový počet předplatných.
Stránka	page	integer	Stránka.
Total Pages	total_pages	integer	Celkový počet stránek.
Předplatná	subscriptions	array of object
ID	subscriptions.id	integer	Jedinečný identifikátor.
Stát	subscriptions.state	string	Stát
Vytvořeno na adrese	subscriptions.created_at	string	Při vytváření na adrese.
Zdroj	subscriptions.source	string	Zdroj.
Odkazující	subscriptions.referrer	string	Referrér.
Id přihlášení k odběru	subscriptions.subscribable_id	integer	Jedinečný identifikátor, který se dá přihlásit k odběru.
Typ přihlášení k odběru	subscriptions.subscribable_type	string	Typ přihlášení k odběru.
ID	subscriptions.subscriber.id	integer	Jedinečný identifikátor.
Křestní jméno	subscriptions.subscriber.first_name	string	Jméno.
E-mailová adresa	subscriptions.subscriber.email_address	string	E-mailová adresa.
Stát	subscriptions.subscriber.state	string	Stát
Vytvořeno na adrese	subscriptions.subscriber.created_at	string	Při vytváření na adrese.
Příjmení	subscriptions.subscriber.fields.last_name	string	Příjmení.

Výpis předplatných značky

ID operace:

TagSubList

Načte seznam předplatných na značku, včetně dat odběratele.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID značky	tag_id	True	string	Jedinečný identifikátor značky.
Pořadí řazení	sort_order		string	Pořadí řazení.
Stav odběratele	subscriber_state		string	Stav odběratele.
Stránka	page		integer	Stránka.

Návraty

Name	Cesta	Typ	Description
Total Subscriptions	total_subscriptions	integer	Celkový počet předplatných.
Stránka	page	integer	Stránka.
Total Pages	total_pages	integer	Celkový počet stránek.
Předplatná	subscriptions	array of object
ID	subscriptions.id	integer	Jedinečný identifikátor.
Stát	subscriptions.state	string	Stát
Vytvořeno na adrese	subscriptions.created_at	string	Při vytváření na adrese.
Zdroj	subscriptions.source	string	Zdroj.
Odkazující	subscriptions.referrer	string	Referrér.
Id přihlášení k odběru	subscriptions.subscribable_id	integer	Jedinečný identifikátor, který se dá přihlásit k odběru.
Typ přihlášení k odběru	subscriptions.subscribable_type	string	Typ přihlášení k odběru.
ID	subscriptions.subscriber.id	integer	Jedinečný identifikátor.
Křestní jméno	subscriptions.subscriber.first_name	string	Jméno.
E-mailová adresa	subscriptions.subscriber.email_address	string	E-mailová adresa.
Stát	subscriptions.subscriber.state	string	Stát
Vytvořeno na adrese	subscriptions.subscriber.created_at	string	Při vytváření na adrese.
Příjmení	subscriptions.subscriber.fields.last_name	string	Příjmení.

Výpis všesměrových vysílání

ID operace:

BroadcastList

Načte seznam všech vysílání pro váš účet.

Návraty

Name	Cesta	Typ	Description
Vysílá	broadcasts	array of object
ID	broadcasts.id	integer	Jedinečný identifikátor.
Vytvořeno na adrese	broadcasts.created_at	string	Při vytváření na adrese.
Předmět	broadcasts.subject	string	Předmět.

Výpis značek

ID operace:

TagList

Načte seznam značek pro účet.

Návraty

Name	Cesta	Typ	Description
Štítky	tags	array of object
ID	tags.id	integer	Jedinečný identifikátor.
Název	tags.name	string	Název.
Vytvořeno na adrese	tags.created_at	string	Při vytváření na adrese.

Výpis značek odběratele

ID operace:

SubscriberTags

Načte seznam všech značek pro předplatitele.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID odběratele	subscriber_id	True	string	Jedinečný identifikátor odběratele.

Návraty

Name	Cesta	Typ	Description
Štítky	tags	array of object
ID	tags.id	integer	Jedinečný identifikátor.
Název	tags.name	string	Název.
Vytvořeno na adrese	tags.created_at	string	Při vytváření na adrese.

Zničení vysílání

ID operace:

BroadcastDelete

Trvale odstraníte koncept nebo naplánovaný záznam vysílání. Vysílání, která aktuálně odesílají nebo které byly odeslány, nemusí být odstraněna.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID vysílání	broadcast_id	True	string	Jedinečný identifikátor všesměrového vysílání.

Návraty

response

string

Získání formulářů

ID operace:

FormList

Načtěte seznam všech formulářů pro váš účet.

Návraty

Name	Cesta	Typ	Description
Forms	forms	array of object
ID	forms.id	integer	Jedinečný identifikátor.
Název	forms.name	string	Název.
Vytvořeno na adrese	forms.created_at	string	Při vytváření na adrese.
Typ	forms.type	string	Typ.
Formát	forms.format	string	Formát.
URL	forms.url	string	Adresa URL.
Vložení JS	forms.embed_js	string	Javascript, který se má vložit.
Adresa URL pro vložení	forms.embed_url	string	Adresa URL, kterou chcete vložit.
Title	forms.title	string	Název.
Description	forms.description	string	Popis.
Text tlačítka Registrace	forms.sign_up_button_text	string	Text tlačítka registrace
Zpráva o úspěchu	forms.success_message	string	Zpráva o úspěchu.
Archivovaný	forms.archived	boolean	Zda je archivováno.
UID	forms.uid	string	Jedinečný identifikátor.

Získání nákupu

ID operace:

PurchaseGet

Načtěte konkrétní nákup podle ID.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID nákupu	purchase_id	True	string	Identifikátor nákupu.

Návraty

Name	Cesta	Typ	Description
ID	id	integer	Jedinečný identifikátor.
ID transakce	transaction_id	string	Jedinečný identifikátor transakce.
Stav	status	string	Stav.
E-mailová adresa	email_address	string	E-mailová adresa.
Měna	currency	string	Měna.
Čas transakce	transaction_time	string	Čas transakce.
Mezisoučet	subtotal	integer	Mezisoučty.
Doprava	shipping	integer	Doprava.
Sleva	discount	integer	Sleva.
Daň	tax	integer	Daň.
Total	total	integer	Celkový součet.
Products	products	array of object
Jednotková cena	products.unit_price	integer	Jednotková cena.
Množství	products.quantity	integer	Množství.
skladová jednotka (SKU)	products.sku	string	Skladová položka.
Název	products.name	string	Název.

Získání odběratele

ID operace:

SubscriberGet

Načte jeden záznam odběratele.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID odběratele	subscriber_id	True	string	Jedinečný identifikátor odběratele.

Návraty

Name	Cesta	Typ	Description
ID	subscriber.id	integer	Jedinečný identifikátor.
Křestní jméno	subscriber.first_name	string	Jméno.
E-mailová adresa	subscriber.email_address	string	E-mailová adresa.
Stát	subscriber.state	string	Stát
Vytvořeno na adrese	subscriber.created_at	string	Při vytváření na adrese.
Příjmení	subscriber.fields.last_name	string	Příjmení.

Získání statistik vysílání

ID operace:

BroadcastGetStat

Načte statistiku (počet příjemců, počet otevření, míra kliknutí, počet odhlášení odběru, celkový počet kliknutí, stav a průběh odeslání) pro konkrétní vysílání.

Parametry

Name	Klíč	Vyžadováno	Typ	Description
ID vysílání	broadcast_id	True	string	Jedinečný identifikátor všesměrového vysílání.

Návraty

Name	Cesta	Typ	Description
Vysílání	broadcast	array of object
ID	broadcast.id	integer	Jedinečný identifikátor.
Příjemci	broadcast.stats.recipients	integer	Příjemci.
Otevřená rychlost	broadcast.stats.open_rate	float	Otevřená rychlost.
Klikněte na Rychlost.	broadcast.stats.click_rate	float	Míra kliknutí.
Zrušení odběru	broadcast.stats.unsubscribes	integer	Odběr odběru se odhlásí.
Total Clicks	broadcast.stats.total_clicks	integer	Celkový počet kliknutí.
Zobrazit kliknutí na souhrn	broadcast.stats.show_total_clicks	boolean	Určuje, jestli se mají zobrazit celkový počet kliknutí.
Stav	broadcast.stats.status	string	Stav.
Progress	broadcast.stats.progress	integer	Průběh.

Získání účtu

ID operace:

Account

Načte aktuální účet.

Návraty

Name	Cesta	Typ	Description
Název	name	string	Název.
Typ plánu	plan_type	string	Typ plánu.
Primární e-mailová adresa	primary_email_address	string	Primární e-mailová adresa.

Definice

řetězec

Toto je základní datový typ String.