ConvertKit (független közzétevő)
A ConvertKit az alkotók go-to marketingközpontja, amely megkönnyíti a célközönség növelését és bevételszerzését. Alakítsa át követőit a közösségi médiából, a YouTube-ról és sok másról az e-mail-listájára egy gyönyörű kezdőlaptal és bejelentkezési sablonokkal.
Ez az összekötő a következő termékekben és régiókban érhető el:
| Service | Class | Régiók |
|---|---|---|
| Copilot Studio | prémium | Az összes Power Automate-régió, kivéve a következőket: - USA kormánya (GCC) - Amerikai kormány (GCC High) - A 21Vianet által üzemeltetett China Cloud - Amerikai Védelmi Minisztérium (DoD) |
| Logikai alkalmazások | Standard | Az összes Logic Apps-régió , kivéve a következőket: - Azure Government-régiók - Azure China-régiók - Amerikai Védelmi Minisztérium (DoD) |
| Power Alkalmazások | prémium | Az összes Power Apps-régió , kivéve a következőket: - USA kormánya (GCC) - Amerikai kormány (GCC High) - A 21Vianet által üzemeltetett China Cloud - Amerikai Védelmi Minisztérium (DoD) |
| Power Automate | prémium | Az összes Power Automate-régió, kivéve a következőket: - USA kormánya (GCC) - Amerikai kormány (GCC High) - A 21Vianet által üzemeltetett China Cloud - Amerikai Védelmi Minisztérium (DoD) |
| Érintkezés | |
|---|---|
| Név | Troy Taylor |
| URL | https://www.hitachisolutions.com |
| ttaylor@hitachisolutions.com |
| Összekötő metaadatai | |
|---|---|
| Kiadó | Troy Taylor, Hitachi Solutions |
| Webhely | https://convertkit.com/ |
| Adatvédelmi irányelvek | https://convertkit.com/privacy |
| Kategóriák | Marketing |
Kapcsolat létrehozása
Az összekötő a következő hitelesítési típusokat támogatja:
| Alapértelmezett | A kapcsolat létrehozásának paraméterei. | Minden régió | Nem osztható meg |
Alapértelmezett
Alkalmazható: Minden régió
A kapcsolat létrehozásának paraméterei.
Ez nem megosztható kapcsolat. Ha a power app meg van osztva egy másik felhasználóval, a rendszer kérni fogja, hogy hozzon létre új kapcsolatot.
| Név | Típus | Description | Kötelező |
|---|---|---|---|
| API-titkos kód | securestring | Az API titkos kódja ehhez az api-hoz | True |
Szabályozási korlátok
| Name | Hívások | Megújítási időszak |
|---|---|---|
| API-hívások kapcsolatonként | 100 | 60 másodperc |
Műveletek
| Címke eltávolítása az előfizetőről e-mailben |
Címke eltávolítása egy előfizetőről e-mail-cím alapján. |
| Címke eltávolítása az előfizetőtől |
Eltávolít egy címkét egy előfizetőtől. |
| Címke létrehozása |
Új címkét hoz létre. |
| Címkék listázása |
Lekéri a fiók címkéinek listáját. |
| Előfizetések listázása címkére |
Lekéri az előfizetések listáját egy címkére, beleértve az előfizetői adatokat is. |
| Előfizetések listázása sorozatba |
Lekéri az előfizetéseket egy sorozatba, beleértve az előfizetői adatokat is. |
| Előfizetések listázása űrlapra |
Lekéri az előfizetések listáját egy űrlapra, beleértve az előfizetői adatokat is. |
| Előfizető címkézése |
A címkéket előfizetésként kezeli a rendszer. Iratkozzon fel egy e-mail-címet egy címkére, hogy a címke az adott e-mail-címmel rendelkező előfizetőre vonatkozzon. |
| Előfizető frissítése |
Frissíti az egyetlen előfizető adatait. |
| Előfizető hozzáadása egy sorozathoz |
Iratkozzon fel egy e-mail-címet valamelyik sorozatára. |
| Előfizető hozzáadása űrlaphoz |
Iratkozzon fel egy e-mail-címet valamelyik űrlapjára. |
| Előfizető leiratkozás |
Leiratkozhat egy előfizetőről az összes űrlapról és sorozatról. |
| Előfizető lekérése |
Egyetlen előfizetői rekordot kér le. |
| Előfizetői címkék listázása |
Lekéri az előfizető összes címkéjének listáját. |
| Előfizetők listázása |
Az előfizetők listáját adja vissza. Csak leiratkozás esetén használja a megszakított értéket a rendezési mező param eleméhez (jelenleg ez az egyetlen támogatott extra rendezési mező). |
| Fiók lekérése |
Lekéri az aktuális fiókot. |
| Közvetítés frissítése |
Frissíti egy adott közvetítés attribútumait. Előfordulhat, hogy az éppen küldött vagy elküldött közvetítések nem frissülnek. |
| Közvetítés lekérése |
Lekéri egy adott közvetítés részleteit, beleértve a piszkozatokat, az ütemezett és a korábban elküldött közvetítéseket. |
| Közvetítés létrehozása |
Piszkozat vagy ütemezett adás létrehozása. A piszkozatközvetítést attribútumok nélkül is létrehozhatja. Az ütemezett közvetítéseknek legalább tartalmazniuk kell egy tárgysort és a tartalmat. |
| Közvetítés megsemmisítése |
Piszkozat vagy ütemezett szórási rekord végleges törlése. Előfordulhat, hogy az éppen küldött vagy elküldött közvetítések nem törölhetők. |
| Közvetítések listázása |
Lekéri a fiók összes közvetítésének listáját. |
| Listasorozatok |
Lekéri a fiók sorozatainak listáját. |
| Szórási statisztikák lekérése |
Lekéri egy adott közvetítés statisztikáit (címzettek száma, nyitott ráta, kattintási arány, leiratkozás száma, összes kattintás, állapot és küldési folyamat). |
| Vásárlás lekérése |
Egy adott vásárlás lekérése azonosító alapján. |
| Vásárlás létrehozása |
Hozzon létre egy vásárlást. |
| Vásárlások listázása |
Lekérheti egy fiók összes vásárlásának listáját. |
| Űrlapok lekérése |
Kérje le a fiók összes űrlapjának listáját. |
Címke eltávolítása az előfizetőről e-mailben
Címke eltávolítása egy előfizetőről e-mail-cím alapján.
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Címkeazonosító
|
tag_id | True | string |
A címke egyedi azonosítója. |
|
Email
|
True | string |
Az e-mail-cím. |
Válaszok
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
azonosító
|
id | integer |
Az egyedi azonosító. |
|
Név
|
name | string |
A név. |
|
Létrehozás dátuma:
|
created_at | string |
Amikor létrehozva van. |
Címke eltávolítása az előfizetőtől
Eltávolít egy címkét egy előfizetőtől.
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Előfizető azonosítója
|
subscriber_id | True | string |
Az előfizető egyedi azonosítója. |
|
Címkeazonosító
|
tag_id | True | string |
A címke egyedi azonosítója. |
Válaszok
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
azonosító
|
id | integer |
Az egyedi azonosító. |
|
Név
|
name | string |
A név. |
|
Létrehozás dátuma:
|
created_at | string |
Amikor létrehozva van. |
Címke létrehozása
Új címkét hoz létre.
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Név
|
name | True | string |
A név. |
Válaszok
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Fiókazonosító
|
account_id | integer |
A fiók egyedi azonosítója. |
|
Létrehozás dátuma:
|
created_at | string |
Amikor létrehozva van. |
|
Törlés dátuma:
|
deleted_at | string |
Amikor törölve van. |
|
azonosító
|
id | integer |
Az egyedi azonosító. |
|
Név
|
name | string |
A név. |
|
Állam
|
state | string |
Az állam. |
|
Frissítve:
|
updated_at | string |
Ha a frissítés időpontja: |
Címkék listázása
Lekéri a fiók címkéinek listáját.
Válaszok
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Címkék
|
tags | array of object | |
|
azonosító
|
tags.id | integer |
Az egyedi azonosító. |
|
Név
|
tags.name | string |
A név. |
|
Létrehozás dátuma:
|
tags.created_at | string |
Amikor létrehozva van. |
Előfizetések listázása címkére
Lekéri az előfizetések listáját egy címkére, beleértve az előfizetői adatokat is.
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Címkeazonosító
|
tag_id | True | string |
A címke egyedi azonosítója. |
|
Rendezési sorrend
|
sort_order | string |
A rendezési sorrend. |
|
|
Előfizető állapota
|
subscriber_state | string |
Az előfizető állapota. |
|
|
Oldal
|
page | integer |
Az oldal. |
Válaszok
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Összes előfizetés
|
total_subscriptions | integer |
Az összes előfizetés. |
|
Oldal
|
page | integer |
Az oldal. |
|
Összes oldal
|
total_pages | integer |
Az összes oldal. |
|
Előfizetések
|
subscriptions | array of object | |
|
azonosító
|
subscriptions.id | integer |
Az egyedi azonosító. |
|
Állam
|
subscriptions.state | string |
Az állam. |
|
Létrehozás dátuma:
|
subscriptions.created_at | string |
Amikor létrehozva van. |
|
Forrás
|
subscriptions.source | string |
A forrás. |
|
Hivatkozói
|
subscriptions.referrer | string |
A hivatkozó. |
|
Leírható azonosító
|
subscriptions.subscribable_id | integer |
A leírható egyedi azonosító. |
|
Leírható típus
|
subscriptions.subscribable_type | string |
Az előfizetés típusa. |
|
azonosító
|
subscriptions.subscriber.id | integer |
Az egyedi azonosító. |
|
Keresztnév
|
subscriptions.subscriber.first_name | string |
Az utónév. |
|
E-mail cím
|
subscriptions.subscriber.email_address | string |
Az e-mail-cím. |
|
Állam
|
subscriptions.subscriber.state | string |
Az állam. |
|
Létrehozás dátuma:
|
subscriptions.subscriber.created_at | string |
Amikor létrehozva van. |
|
Vezetéknév
|
subscriptions.subscriber.fields.last_name | string |
A vezetéknév. |
Előfizetések listázása sorozatba
Lekéri az előfizetéseket egy sorozatba, beleértve az előfizetői adatokat is.
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Sorozatazonosító
|
sequence_id | True | string |
A sorozat egyedi azonosítója. |
|
Rendezési sorrend
|
sort_order | string |
A rendezési sorrend. |
|
|
Előfizető állapota
|
subscriber_state | string |
Az előfizető állapota. |
|
|
Oldal
|
page | integer |
Az oldal. |
Válaszok
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Összes előfizetés
|
total_subscriptions | integer |
Az összes előfizetés. |
|
Oldal
|
page | integer |
Az oldal. |
|
Összes oldal
|
total_pages | integer |
Az összes oldal. |
|
Előfizetések
|
subscriptions | array of object | |
|
azonosító
|
subscriptions.id | integer |
Az egyedi azonosító. |
|
Állam
|
subscriptions.state | string |
Az állam. |
|
Létrehozás dátuma:
|
subscriptions.created_at | string |
Amikor létrehozva van. |
|
Forrás
|
subscriptions.source | string |
A forrás. |
|
Hivatkozói
|
subscriptions.referrer | string |
A hivatkozó. |
|
Leírható azonosító
|
subscriptions.subscribable_id | integer |
A leírható egyedi azonosító. |
|
Leírható típus
|
subscriptions.subscribable_type | string |
Az előfizetés típusa. |
|
azonosító
|
subscriptions.subscriber.id | integer |
Az egyedi azonosító. |
|
Keresztnév
|
subscriptions.subscriber.first_name | string |
Az utónév. |
|
E-mail cím
|
subscriptions.subscriber.email_address | string |
Az e-mail-cím. |
|
Állam
|
subscriptions.subscriber.state | string |
Az állam. |
|
Létrehozás dátuma:
|
subscriptions.subscriber.created_at | string |
Amikor létrehozva van. |
|
Vezetéknév
|
subscriptions.subscriber.fields.last_name | string |
A vezetéknév. |
Előfizetések listázása űrlapra
Lekéri az előfizetések listáját egy űrlapra, beleértve az előfizetői adatokat is.
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Űrlapazonosító
|
form_id | True | string |
Az űrlap egyedi azonosítója. |
|
Rendezési sorrend
|
sort_order | string |
A rendezési sorrend. |
|
|
Előfizető állapota
|
subscriber_state | string |
Az előfizető állapota. |
|
|
Oldal
|
page | integer |
Az oldal. |
Válaszok
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Összes előfizetés
|
total_subscriptions | integer |
Az összes előfizetés. |
|
Oldal
|
page | integer |
Az oldal. |
|
Összes oldal
|
total_pages | integer |
Az összes oldal. |
|
Előfizetések
|
subscriptions | array of object | |
|
azonosító
|
subscriptions.id | integer |
Az egyedi azonosító. |
|
Állam
|
subscriptions.state | string |
Az állam. |
|
Létrehozás dátuma:
|
subscriptions.created_at | string |
Amikor létrehozva van. |
|
Forrás
|
subscriptions.source | string |
A forrás. |
|
Hivatkozói
|
subscriptions.referrer | string |
A hivatkozó. |
|
Leírható azonosító
|
subscriptions.subscribable_id | integer |
A leírható egyedi azonosító. |
|
Leírható típus
|
subscriptions.subscribable_type | string |
Az előfizetés típusa. |
|
azonosító
|
subscriptions.subscriber.id | integer |
Az egyedi azonosító. |
|
Keresztnév
|
subscriptions.subscriber.first_name | string |
Az utónév. |
|
E-mail cím
|
subscriptions.subscriber.email_address | string |
Az e-mail-cím. |
|
Állam
|
subscriptions.subscriber.state | string |
Az állam. |
|
Létrehozás dátuma:
|
subscriptions.subscriber.created_at | string |
Amikor létrehozva van. |
|
Vezetéknév
|
subscriptions.subscriber.fields.last_name | string |
A vezetéknév. |
Előfizető címkézése
A címkéket előfizetésként kezeli a rendszer. Iratkozzon fel egy e-mail-címet egy címkére, hogy a címke az adott e-mail-címmel rendelkező előfizetőre vonatkozzon.
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Címkeazonosító
|
tag_id | True | string |
A címke egyedi azonosítója. |
|
Email
|
string |
Az e-mail-cím. |
||
|
Keresztnév
|
first_name | string |
Az utónév. |
|
|
Címkék
|
tags | array of integer |
Válaszok
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
azonosító
|
subscription.id | integer |
Az egyedi azonosító. |
|
Állam
|
subscription.state | string |
Az állam. |
|
Létrehozás dátuma:
|
subscription.created_at | string |
Amikor létrehozva van. |
|
Forrás
|
subscription.source | string |
A forrás. |
|
Hivatkozói
|
subscription.referrer | string |
A hivatkozó. |
|
Leírható azonosító
|
subscription.subscribable_id | integer |
A leírható egyedi azonosító. |
|
Leírható típus
|
subscription.subscribable_type | string |
Az előfizetés típusa. |
|
azonosító
|
subscription.subscriber.id | integer |
Az egyedi azonosító. |
Előfizető frissítése
Frissíti az egyetlen előfizető adatait.
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Előfizető azonosítója
|
subscriber_id | True | string |
Az előfizető egyedi azonosítója. |
|
Keresztnév
|
first_name | string |
Az utónév. |
|
|
E-mail cím
|
email_address | string |
Az e-mail-cím. |
Válaszok
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
azonosító
|
subscriber.id | integer |
Az egyedi azonosító. |
|
Keresztnév
|
subscriber.first_name | string |
Az utónév. |
|
E-mail cím
|
subscriber.email_address | string |
Az e-mail-cím. |
|
Állam
|
subscriber.state | string |
Az állam. |
|
Létrehozás dátuma:
|
subscriber.created_at | string |
Amikor létrehozva van. |
Előfizető hozzáadása egy sorozathoz
Iratkozzon fel egy e-mail-címet valamelyik sorozatára.
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Sorozatazonosító
|
sequence_id | True | string |
A sorozat egyedi azonosítója. |
|
Email
|
True | string |
Az e-mail-cím. |
|
|
Keresztnév
|
first_name | string |
Az utónév. |
|
|
Címkék
|
tags | array of integer |
Válaszok
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
azonosító
|
subscription.id | integer |
Az egyedi azonosító. |
|
Állam
|
subscription.state | string |
Az állam. |
|
Létrehozás dátuma:
|
subscription.created_at | string |
Amikor létrehozva van. |
|
Forrás
|
subscription.source | string |
A forrás. |
|
Hivatkozói
|
subscription.referrer | string |
A hivatkozó. |
|
Leírható azonosító
|
subscription.subscribable_id | integer |
A leírható egyedi azonosító. |
|
Leírható típus
|
subscription.subscribable_type | string |
Az előfizetés típusa. |
|
azonosító
|
subscription.subscriber.id | integer |
Az egyedi azonosító. |
Előfizető hozzáadása űrlaphoz
Iratkozzon fel egy e-mail-címet valamelyik űrlapjára.
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Űrlapazonosító
|
form_id | True | string |
Az űrlap egyedi azonosítója. |
|
Email
|
True | string |
Az e-mail-cím. |
|
|
Keresztnév
|
first_name | string |
Az utónév. |
|
|
Címkék
|
tags | array of integer |
Válaszok
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
azonosító
|
subscription.id | integer |
Az egyedi azonosító. |
|
Állam
|
subscription.state | string |
Az állam. |
|
Létrehozás dátuma:
|
subscription.created_at | string |
Amikor létrehozva van. |
|
Forrás
|
subscription.source | string |
A forrás. |
|
Hivatkozói
|
subscription.referrer | string |
A hivatkozó. |
|
Leírható azonosító
|
subscription.subscribable_id | integer |
A leírható egyedi azonosító. |
|
Leírható típus
|
subscription.subscribable_type | string |
Az előfizetés típusa. |
|
azonosító
|
subscription.subscriber.id | integer |
Az egyedi azonosító. |
|
Keresztnév
|
subscription.subscriber.first_name | string |
Az utónév. |
|
E-mail cím
|
subscription.subscriber.email_address | string |
Az e-mail-cím. |
|
Állam
|
subscription.subscriber.state | string |
Az állam. |
|
Létrehozás dátuma:
|
subscription.subscriber.created_at | string |
Amikor létrehozva van. |
Előfizető leiratkozás
Leiratkozhat egy előfizetőről az összes űrlapról és sorozatról.
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Email
|
True | string |
Az e-mail-cím. |
Válaszok
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
azonosító
|
subscriber.id | integer |
Az egyedi azonosító. |
|
Keresztnév
|
subscriber.first_name | string |
Az utónév. |
|
E-mail cím
|
subscriber.email_address | string |
Az e-mail-cím. |
|
Állam
|
subscriber.state | string |
Az állam. |
|
Létrehozás dátuma:
|
subscriber.created_at | string |
Amikor létrehozva van. |
|
Vezetéknév
|
subscriber.fields.last_name | string |
A vezetéknév. |
Előfizető lekérése
Egyetlen előfizetői rekordot kér le.
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Előfizető azonosítója
|
subscriber_id | True | string |
Az előfizető egyedi azonosítója. |
Válaszok
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
azonosító
|
subscriber.id | integer |
Az egyedi azonosító. |
|
Keresztnév
|
subscriber.first_name | string |
Az utónév. |
|
E-mail cím
|
subscriber.email_address | string |
Az e-mail-cím. |
|
Állam
|
subscriber.state | string |
Az állam. |
|
Létrehozás dátuma:
|
subscriber.created_at | string |
Amikor létrehozva van. |
|
Vezetéknév
|
subscriber.fields.last_name | string |
A vezetéknév. |
Előfizetői címkék listázása
Lekéri az előfizető összes címkéjének listáját.
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Előfizető azonosítója
|
subscriber_id | True | string |
Az előfizető egyedi azonosítója. |
Válaszok
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Címkék
|
tags | array of object | |
|
azonosító
|
tags.id | integer |
Az egyedi azonosító. |
|
Név
|
tags.name | string |
A név. |
|
Létrehozás dátuma:
|
tags.created_at | string |
Amikor létrehozva van. |
Előfizetők listázása
Az előfizetők listáját adja vissza. Csak leiratkozás esetén használja a megszakított értéket a rendezési mező param eleméhez (jelenleg ez az egyetlen támogatott extra rendezési mező).
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Ettől kezdve
|
from | string |
A feladó. |
|
|
Há
|
to | string |
A to. |
|
|
Frissítve innen:
|
updated_from | string |
Amikor frissítve van. |
|
|
Frissítve:
|
updated_to | string |
Amikor frissítve van. |
|
|
Rendezési sorrend
|
sort_order | string |
A rendezési sorrend. |
|
|
Mező rendezése
|
sort_field | string |
A rendezési mező. |
|
|
E-mail cím
|
email_address | string |
Az e-mail-cím. |
|
|
Oldal
|
page | integer |
Az oldal. |
Válaszok
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Összes előfizető
|
total_subscribers | integer |
Az összes előfizető. |
|
Oldal
|
page | integer |
Az oldal. |
|
Összes oldal
|
total_pages | integer |
Az összes oldal. |
|
Subscribers
|
subscribers | array of object | |
|
azonosító
|
subscribers.id | integer |
Az egyedi azonosító. |
|
Keresztnév
|
subscribers.first_name | string |
Az utónév. |
|
E-mail cím
|
subscribers.email_address | string |
Az e-mail-cím. |
|
Állam
|
subscribers.state | string |
Az állam. |
|
Létrehozás dátuma:
|
subscribers.created_at | string |
Amikor létrehozva van. |
|
Vezetéknév
|
subscribers.fields.last_name | string |
A vezetéknév. |
Fiók lekérése
Lekéri az aktuális fiókot.
Válaszok
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Név
|
name | string |
A név. |
|
Csomag típusa
|
plan_type | string |
A terv típusa. |
|
Elsődleges e-mail-cím
|
primary_email_address | string |
Az elsődleges e-mail-cím. |
Közvetítés frissítése
Frissíti egy adott közvetítés attribútumait. Előfordulhat, hogy az éppen küldött vagy elküldött közvetítések nem frissülnek.
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Szórás azonosítója
|
broadcast_id | True | string |
A szórás egyedi azonosítója. |
|
Description
|
description | string |
A leírás. |
|
|
Tárgy
|
subject | string |
A téma. |
|
|
Content
|
content | string |
A tartalom. |
|
|
E-mail cím
|
email_address | string |
Az e-mail-cím. |
|
|
E-mail-elrendezés sablonja
|
email_layout_template | string |
Az e-mail-elrendezés sablonja. |
|
|
Public
|
public | boolean |
Akár nyilvános. |
|
|
Közzétéve:
|
published_at | string |
Amikor közzétenik. |
|
|
Küldés itt:
|
send_at | string |
Küldéskor. |
|
|
Miniatűr alt
|
thumbnail_alt | string |
A miniatűr helyettesítő szövege. |
|
|
Miniatűr URL-címe
|
thumbnail_url | string |
A miniatűr URL-címe. |
Válaszok
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
azonosító
|
broadcast.id | integer |
Az egyedi azonosító. |
|
Létrehozás dátuma:
|
broadcast.created_at | string |
Amikor létrehozva van. |
|
Tárgy
|
broadcast.subject | string |
A téma. |
|
Description
|
broadcast.description | string |
A leírás. |
|
Content
|
broadcast.content | string |
A tartalom. |
|
Public
|
broadcast.public | boolean |
Akár nyilvános. |
|
Közzétéve:
|
broadcast.published_at | string |
Amikor közzétenik. |
|
Küldés itt:
|
broadcast.send_at | string |
Amikor elküldjük. |
|
Miniatűr alt
|
broadcast.thumbnail_alt | string |
A miniatűr helyettesítő szövege. |
|
Miniatűr URL-címe
|
broadcast.thumbnail_url | string |
A miniatűr URL-címe. |
|
E-mail cím
|
broadcast.email_address | string |
Az e-mail-cím. |
|
E-mail-elrendezés sablonja
|
broadcast.email_layout_template | string |
Az e-mail-elrendezés sablonja. |
Közvetítés lekérése
Lekéri egy adott közvetítés részleteit, beleértve a piszkozatokat, az ütemezett és a korábban elküldött közvetítéseket.
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Szórás azonosítója
|
broadcast_id | True | string |
A szórás egyedi azonosítója. |
Válaszok
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
azonosító
|
broadcast.id | integer |
Az egyedi azonosító. |
|
Létrehozás dátuma:
|
broadcast.created_at | string |
Amikor létrehozva van. |
|
Tárgy
|
broadcast.subject | string |
A téma. |
|
Description
|
broadcast.description | string |
A leírás. |
|
Content
|
broadcast.content | string |
A tartalom. |
|
Public
|
broadcast.public | boolean |
Akár nyilvános. |
|
Közzétéve:
|
broadcast.published_at | string |
Amikor közzétenik. |
|
Küldés itt:
|
broadcast.send_at | string |
Amikor elküldjük. |
|
Miniatűr alt
|
broadcast.thumbnail_alt | string |
A miniatűr helyettesítő szövege. |
|
Miniatűr URL-címe
|
broadcast.thumbnail_url | string |
A miniatűr URL-címe. |
|
E-mail cím
|
broadcast.email_address | string |
Az e-mail-cím. |
|
E-mail-elrendezés sablonja
|
broadcast.email_layout_template | string |
Az e-mail-elrendezés sablonja. |
Közvetítés létrehozása
Piszkozat vagy ütemezett adás létrehozása. A piszkozatközvetítést attribútumok nélkül is létrehozhatja. Az ütemezett közvetítéseknek legalább tartalmazniuk kell egy tárgysort és a tartalmat.
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Description
|
description | string |
A leírás. |
|
|
Tárgy
|
subject | string |
A téma. |
|
|
Content
|
content | string |
A tartalom. |
|
|
E-mail cím
|
email_address | string |
Az e-mail-cím. |
|
|
E-mail-elrendezés sablonja
|
email_layout_template | string |
Az e-mail-elrendezés sablonja. |
|
|
Public
|
public | boolean |
Akár nyilvános. |
|
|
Közzétéve:
|
published_at | string |
Amikor közzétenik. |
|
|
Küldés itt:
|
send_at | string |
Küldéskor. |
|
|
Miniatűr alt
|
thumbnail_alt | string |
A miniatűr helyettesítő szövege. |
|
|
Miniatűr URL-címe
|
thumbnail_url | string |
A miniatűr URL-címe. |
Válaszok
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
azonosító
|
broadcast.id | integer |
Az egyedi azonosító. |
|
Létrehozás dátuma:
|
broadcast.created_at | string |
Amikor létrehozva van. |
|
Tárgy
|
broadcast.subject | string |
A téma. |
|
Description
|
broadcast.description | string |
A leírás. |
|
Content
|
broadcast.content | string |
A tartalom. |
|
Public
|
broadcast.public | boolean |
Akár nyilvános. |
|
Közzétéve:
|
broadcast.published_at | string |
Amikor közzétenik. |
|
Küldés itt:
|
broadcast.send_at | string |
Amikor elküldjük. |
|
Miniatűr alt
|
broadcast.thumbnail_alt | string |
A miniatűr helyettesítő szövege. |
|
Miniatűr URL-címe
|
broadcast.thumbnail_url | string |
A miniatűr URL-címe. |
|
E-mail cím
|
broadcast.email_address | string |
Az e-mail-cím. |
|
E-mail-elrendezés sablonja
|
broadcast.email_layout_template | string |
Az e-mail-elrendezés sablonja. |
Közvetítés megsemmisítése
Piszkozat vagy ütemezett szórási rekord végleges törlése. Előfordulhat, hogy az éppen küldött vagy elküldött közvetítések nem törölhetők.
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Szórás azonosítója
|
broadcast_id | True | string |
A szórás egyedi azonosítója. |
Válaszok
- response
- string
Közvetítések listázása
Lekéri a fiók összes közvetítésének listáját.
Válaszok
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Adások
|
broadcasts | array of object | |
|
azonosító
|
broadcasts.id | integer |
Az egyedi azonosító. |
|
Létrehozás dátuma:
|
broadcasts.created_at | string |
Amikor létrehozva van. |
|
Tárgy
|
broadcasts.subject | string |
A téma. |
Listasorozatok
Lekéri a fiók sorozatainak listáját.
Válaszok
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Courses
|
courses | array of object | |
|
azonosító
|
courses.id | integer |
Az egyedi azonosító. |
|
Név
|
courses.name | string |
A név. |
|
Létrehozás dátuma:
|
courses.created_at | string |
Amikor létrehozva van. |
Szórási statisztikák lekérése
Lekéri egy adott közvetítés statisztikáit (címzettek száma, nyitott ráta, kattintási arány, leiratkozás száma, összes kattintás, állapot és küldési folyamat).
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Szórás azonosítója
|
broadcast_id | True | string |
A szórás egyedi azonosítója. |
Válaszok
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Adás
|
broadcast | array of object | |
|
azonosító
|
broadcast.id | integer |
Az egyedi azonosító. |
|
Címzettek
|
broadcast.stats.recipients | integer |
A címzettek. |
|
Megnyitási sebesség
|
broadcast.stats.open_rate | float |
A nyitott sebesség. |
|
Kattintson a Ráta gombra
|
broadcast.stats.click_rate | float |
A kattintási arány. |
|
Leiratkozik
|
broadcast.stats.unsubscribes | integer |
A leiratkozások. |
|
Összes kattintás
|
broadcast.stats.total_clicks | integer |
Az összes kattintás. |
|
Összes kattintás megjelenítése
|
broadcast.stats.show_total_clicks | boolean |
Az összes kattintás megjelenítése. |
|
Státusz
|
broadcast.stats.status | string |
Az állapot. |
|
Progress
|
broadcast.stats.progress | integer |
A folyamat. |
Vásárlás lekérése
Egy adott vásárlás lekérése azonosító alapján.
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Vásárlási azonosító
|
purchase_id | True | string |
A vásárlási azonosító. |
Válaszok
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
azonosító
|
id | integer |
Az egyedi azonosító. |
|
Tranzakcióazonosító
|
transaction_id | string |
A tranzakció egyedi azonosítója. |
|
Státusz
|
status | string |
Az állapot. |
|
E-mail cím
|
email_address | string |
Az e-mail-cím. |
|
Valuta
|
currency | string |
A pénznem. |
|
Tranzakció időtartama
|
transaction_time | string |
A tranzakció ideje. |
|
Részösszeg
|
subtotal | integer |
A részösszeg. |
|
Szállítás
|
shipping | integer |
A szállítás. |
|
Árengedmény
|
discount | integer |
A kedvezmény. |
|
Adó
|
tax | integer |
Az adó. |
|
Total
|
total | integer |
Az összeg. |
|
Products
|
products | array of object | |
|
Egységár
|
products.unit_price | integer |
Az egységár. |
|
Mennyiség
|
products.quantity | integer |
A mennyiség. |
|
SKU
|
products.sku | string |
A termékváltozat. |
|
Név
|
products.name | string |
A név. |
Vásárlás létrehozása
Hozzon létre egy vásárlást.
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Tranzakcióazonosító
|
transaction_id | True | string |
A tranzakció egyedi azonosítója. |
|
E-mail cím
|
email_address | True | string |
Az e-mail-cím. |
|
Keresztnév
|
first_name | string |
Az utónév. |
|
|
Valuta
|
currency | True | string |
A pénznem. |
|
Tranzakció időtartama
|
transaction_time | string |
A tranzakció ideje. |
|
|
Részösszeg
|
subtotal | integer |
A részösszeg. |
|
|
Adó
|
tax | integer |
Az adó. |
|
|
Szállítás
|
shipping | integer |
A szállítás. |
|
|
Árengedmény
|
discount | integer |
A kedvezmény. |
|
|
Total
|
total | integer |
Az összeg. |
|
|
Státusz
|
status | string |
Az állapot. |
|
|
folyamatazonosító
|
pid | True | integer |
A személyes azonosító. |
|
FEDŐ
|
lid | True | integer |
A fedél. |
|
Név
|
name | True | string |
A név. |
|
SKU
|
sku | string |
A termékváltozat. |
|
|
Egységár
|
unit_price | True | integer |
Az egységár. |
|
Mennyiség
|
quantity | True | integer |
A mennyiség. |
Válaszok
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
azonosító
|
id | integer |
Az egyedi azonosító. |
|
Tranzakcióazonosító
|
transaction_id | string |
A tranzakció egyedi azonosítója. |
|
Státusz
|
status | string |
Az állapot. |
|
E-mail cím
|
email_address | string |
Az e-mail-cím. |
|
Valuta
|
currency | string |
A pénznem. |
|
Tranzakció időtartama
|
transaction_time | string |
A tranzakció ideje. |
|
Részösszeg
|
subtotal | integer |
A részösszeg. |
|
Árengedmény
|
discount | integer |
A kedvezmény. |
|
Adó
|
tax | integer |
Az adó. |
|
Szállítás
|
shipping | integer |
A szállítás. |
|
Total
|
total | integer |
Az összeg. |
|
Products
|
products | array of object | |
|
Egységár
|
products.unit_price | integer |
Az egységár. |
|
Mennyiség
|
products.quantity | integer |
A mennyiség. |
|
SKU
|
products.sku | string |
A termékváltozat. |
|
Név
|
products.name | string |
A név. |
Vásárlások listázása
Lekérheti egy fiók összes vásárlásának listáját.
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Oldal
|
page | integer |
Az oldal. |
Válaszok
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Összes vásárlás
|
total_purchases | integer |
A teljes vásárlás. |
|
Oldal
|
page | integer |
Az oldal. |
|
Összes oldal
|
total_pages | integer |
Az összes oldal. |
|
Vásárlások
|
purchases | array of object | |
|
azonosító
|
purchases.id | integer |
Az egyedi azonosító. |
|
Tranzakcióazonosító
|
purchases.transaction_id | string |
A tranzakció egyedi azonosítója. |
|
Státusz
|
purchases.status | string |
Az állapot. |
|
E-mail cím
|
purchases.email_address | string |
Az e-mail-cím. |
|
Valuta
|
purchases.currency | string |
A pénznem. |
|
Tranzakció időtartama
|
purchases.transaction_time | string |
A tranzakció ideje. |
|
Részösszeg
|
purchases.subtotal | integer |
A részösszeg. |
|
Szállítás
|
purchases.shipping | integer |
A szállítás. |
|
Árengedmény
|
purchases.discount | integer |
A kedvezmény. |
|
Adó
|
purchases.tax | integer |
Az adó. |
|
Total
|
purchases.total | integer |
Az összeg. |
|
Products
|
purchases.products | array of object | |
|
Egységár
|
purchases.products.unit_price | integer |
Az egységár. |
|
Mennyiség
|
purchases.products.quantity | integer |
A mennyiség. |
|
SKU
|
purchases.products.sku | string |
A termékváltozat. |
|
Név
|
purchases.products.name | string |
A név. |
Űrlapok lekérése
Kérje le a fiók összes űrlapjának listáját.
Válaszok
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Forms
|
forms | array of object | |
|
azonosító
|
forms.id | integer |
Az egyedi azonosító. |
|
Név
|
forms.name | string |
A név. |
|
Létrehozás dátuma:
|
forms.created_at | string |
Amikor létrehozva van. |
|
Típus
|
forms.type | string |
A típus. |
|
Formátum
|
forms.format | string |
A formátum. |
|
URL
|
forms.url | string |
Az URL-cím. |
|
JS beágyazása
|
forms.embed_js | string |
A beágyazandó Javascript. |
|
Beágyazási URL-cím
|
forms.embed_url | string |
A beágyazandó URL-cím. |
|
Cím
|
forms.title | string |
A cím. |
|
Description
|
forms.description | string |
A leírás. |
|
Regisztráció gombszövege
|
forms.sign_up_button_text | string |
A regisztrációs gomb szövege. |
|
Sikeres üzenet
|
forms.success_message | string |
A sikeres üzenet. |
|
Archivált
|
forms.archived | boolean |
Archiválva van-e. |
|
UID
|
forms.uid | string |
Az egyedi azonosító. |
Definíciók
karakterlánc
Ez a sztring alapszintű adattípusa.