ConvertKit (oberoende utgivare)

ConvertKit är den go-to marknadsföringshubben för skapare som hjälper dig att växa och tjäna pengar på din målgrupp med lätthet. Konvertera dina följare från sociala medier, YouTube och mycket mer till din e-postlista med en vacker landningssida och opt-in-mallar.

Den här anslutningsappen är tillgänglig i följande produkter och regioner:

Tjänster	Class	Regioner
Copilot Studio	Premie	Alla Power Automate-regioner utom följande:      - Amerikanska myndigheter (GCC)      - Amerikanska myndigheter (GCC High)      – China Cloud drivs av 21Vianet      - US Department of Defense (DoD)
Logiska appar	Norm	Alla Logic Apps-regioner utom följande:      – Azure Government-regioner      – Regioner i Azure Kina      - US Department of Defense (DoD)
Power Apps	Premie	Alla Power Apps-regioner utom följande:      - Amerikanska myndigheter (GCC)      - Amerikanska myndigheter (GCC High)      – China Cloud drivs av 21Vianet      - US Department of Defense (DoD)
Power Automate	Premie	Alla Power Automate-regioner utom följande:      - Amerikanska myndigheter (GCC)      - Amerikanska myndigheter (GCC High)      – China Cloud drivs av 21Vianet      - US Department of Defense (DoD)

Kontakt
Namn	Troy Taylor
URL	https://www.hitachisolutions.com
E-postmeddelande	ttaylor@hitachisolutions.com

Metadata för anslutningsprogram
Utgivare	Troy Taylor, Hitachi Solutions
Webbplats	https://convertkit.com/
Sekretesspolicy	https://convertkit.com/privacy
Kategorier	Marknadsföring

Skapa en anslutning

Anslutningsappen stöder följande autentiseringstyper:

Standardinställning	Parametrar för att skapa anslutning.	Alla regioner	Går inte att dela

Standard

Tillämpligt: Alla regioner

Parametrar för att skapa anslutning.

Det här är inte delningsbar anslutning. Om power-appen delas med en annan användare uppmanas en annan användare att skapa en ny anslutning explicit.

Namn	Typ	Description	Krävs
API-hemlighet	securestring	API-hemligheten för det här API:et	Sann

Begränsningsgränser

Name	Anrop	Förnyelseperiod
API-anrop per anslutning	100	60 sekunder

Åtgärder

Avregistrera prenumerant	Avregistrera en prenumerant från alla dina formulär och sekvenser.
Förstöra en sändning	Ta bort ett utkast eller en schemalagd sändningspost permanent. Sändningar som för närvarande skickar eller som har skickats kanske inte tas bort.
Hämta en sändning	Hämtar information om en specifik sändning, inklusive utkast, schemalagda och tidigare skickade sändningar.
Hämta ett köp	Hämta ett specifikt köp via ID.
Hämta formulär	Hämta en lista över alla formulär för ditt konto.
Hämta konto	Hämtar det aktuella kontot.
Hämta sändningsstatistik	Hämtar statistiken (antal mottagare, öppet pris, klickfrekvens, antal avregistreringar, totalt antal klick, status och sändningsförlopp) för en viss sändning.
Lista köp	Hämta en lista över alla inköp för ett konto.
Lista prenumerantens taggar	Hämtar en lista över alla taggar för en prenumerant.
Lista prenumeranter	Returnerar en lista över dina prenumeranter. För att endast avbryta prenumerationer använder du värdet avbryts för sorteringsfältparam (för närvarande det enda extra sorteringsfält som stöds).
Lista prenumerationer till en sekvens	Hämtar prenumerationer till en sekvens inklusive prenumerantdata.
Lista prenumerationer till ett formulär	Hämtar en lista över prenumerationer till ett formulär inklusive prenumerantdata.
Lista sekvenser	Hämtar en lista över sekvenser för kontot.
Lista sändningar	Hämtar en lista över alla sändningar för ditt konto.
Listtaggar	Hämtar en lista med taggar för kontot.
Lägga till prenumerant i en sekvens	Prenumerera på en e-postadress till en av dina sekvenser.
Lägga till prenumerant i ett formulär	Prenumerera på en e-postadress till ett av dina formulär.
Skaffa en prenumerant	Hämtar en post med en enda prenumerant.
Skapa en sändning	Skapa ett utkast eller en schemalagd sändning. Du kan skapa ett utkast utan attribut. Schemalagda sändningar bör minst innehålla en ämnesrad och ditt innehåll.
Skapa en tagg	Skapar en ny tagg.
Skapa ett köp	Skapa ett köp.
Ta bort tagg från prenumerant	Tar bort en tagg från en prenumerant.
Ta bort tagg från prenumerant via e-post	Ta bort en tagg från en prenumerant via e-postadress.
Tagga en prenumerant	Taggar hanteras som prenumerationer. Prenumerera på en e-postadress till en tagg för att få taggen tillämpad på prenumeranten med den e-postadressen.
Uppdatera en sändning	Uppdaterar attributen för en specifik sändning. Sändningar som för närvarande skickar eller som har skickats kanske inte uppdateras.
Uppdatera prenumerant	Uppdaterar informationen för en enskild prenumerant.
Visa en lista över prenumerationer på en tagg	Hämtar en lista över prenumerationer till en tagg inklusive prenumerantdata.

Avregistrera prenumerant

Åtgärds-ID:

SubscriberUnsub

Avregistrera en prenumerant från alla dina formulär och sekvenser.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
E-postmeddelande	email	True	string	E-postadressen.

Returer

Name	Sökväg	Typ	Description
ID-nummer	subscriber.id	integer	Den unika identifieraren.
Förnamn	subscriber.first_name	string	Förnamnet.
E-postadress	subscriber.email_address	string	E-postadressen.
Stat/län	subscriber.state	string	Staten.
Skapad vid	subscriber.created_at	string	När den skapas på.
Efternamn	subscriber.fields.last_name	string	Efternamnet.

Förstöra en sändning

Åtgärds-ID:

BroadcastDelete

Ta bort ett utkast eller en schemalagd sändningspost permanent. Sändningar som för närvarande skickar eller som har skickats kanske inte tas bort.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Sändnings-ID	broadcast_id	True	string	Den unika broadcast-identifieraren.

Returer

response

string

Hämta en sändning

Åtgärds-ID:

BroadcastGet

Hämtar information om en specifik sändning, inklusive utkast, schemalagda och tidigare skickade sändningar.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Sändnings-ID	broadcast_id	True	string	Den unika broadcast-identifieraren.

Returer

Name	Sökväg	Typ	Description
ID-nummer	broadcast.id	integer	Den unika identifieraren.
Skapad vid	broadcast.created_at	string	När den skapas på.
Ämne	broadcast.subject	string	Ämnet.
Description	broadcast.description	string	Beskrivningen.
Content	broadcast.content	string	Innehållet.
Public	broadcast.public	boolean	Oavsett om det är offentligt.
Publicerad på	broadcast.published_at	string	När den publiceras på.
Skicka på	broadcast.send_at	string	När det skickas på.
Miniatyr alt	broadcast.thumbnail_alt	string	Alt-text för miniatyrbilden.
URL för miniatyr	broadcast.thumbnail_url	string	URL-adressen för miniatyrbilden.
E-postadress	broadcast.email_address	string	E-postadressen.
Mall för e-postlayout	broadcast.email_layout_template	string	Mallen för e-postlayout.

Hämta ett köp

Åtgärds-ID:

PurchaseGet

Hämta ett specifikt köp via ID.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Inköps-ID	purchase_id	True	string	Inköpsidentifieraren.

Returer

Name	Sökväg	Typ	Description
ID-nummer	id	integer	Den unika identifieraren.
Transaktions-ID	transaction_id	string	Den unika transaktionsidentifieraren.
Läge	status	string	Status.
E-postadress	email_address	string	E-postadressen.
Valuta	currency	string	Valutan.
Transaktionstid	transaction_time	string	Transaktionstiden.
Delsumma	subtotal	integer	Delsumman.
Frakt	shipping	integer	Frakten.
Rabatt	discount	integer	Rabatten.
Skatt	tax	integer	Skatten.
Total	total	integer	Summan.
Produkter	products	array of object
Enhetspris	products.unit_price	integer	Enhetspriset.
Kvantitet	products.quantity	integer	Kvantiteten.
artikelnummer (SKU)	products.sku	string	SKU:n.
Namn	products.name	string	Namnet.

Hämta formulär

Åtgärds-ID:

FormList

Hämta en lista över alla formulär för ditt konto.

Returer

Name	Sökväg	Typ	Description
Blanketter	forms	array of object
ID-nummer	forms.id	integer	Den unika identifieraren.
Namn	forms.name	string	Namnet.
Skapad vid	forms.created_at	string	När den skapas på.
Typ	forms.type	string	Typ.
Format	forms.format	string	Formatet.
URL	forms.url	string	URL-adressen.
Bädda in JS	forms.embed_js	string	Javascript som ska bäddas in.
Bädda in URL	forms.embed_url	string	URL-adressen som ska bäddas in.
Titel	forms.title	string	Rubriken.
Description	forms.description	string	Beskrivningen.
Text på registreringsknapp	forms.sign_up_button_text	string	Texten på registreringsknappen.
Meddelande om lyckat resultat	forms.success_message	string	Meddelandet lyckades.
Arkiverad	forms.archived	boolean	Om arkiveras.
UID	forms.uid	string	Den unika identifieraren.

Hämta konto

Åtgärds-ID:

Account

Hämtar det aktuella kontot.

Returer

Name	Sökväg	Typ	Description
Namn	name	string	Namnet.
Plantyp	plan_type	string	Typ av plan.
Primär e-postadress	primary_email_address	string	Den primära e-postadressen.

Hämta sändningsstatistik

Åtgärds-ID:

BroadcastGetStat

Hämtar statistiken (antal mottagare, öppet pris, klickfrekvens, antal avregistreringar, totalt antal klick, status och sändningsförlopp) för en viss sändning.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Sändnings-ID	broadcast_id	True	string	Den unika broadcast-identifieraren.

Returer

Name	Sökväg	Typ	Description
Sändning	broadcast	array of object
ID-nummer	broadcast.id	integer	Den unika identifieraren.
Mottagare	broadcast.stats.recipients	integer	Mottagarna.
Öppet pris	broadcast.stats.open_rate	float	Den öppna kursen.
Klicka på Hastighet	broadcast.stats.click_rate	float	Klickfrekvensen.
Avbrutna prenumerationer	broadcast.stats.unsubscribes	integer	Avprenumererna.
Totalt antal klick	broadcast.stats.total_clicks	integer	Totalt antal klick.
Visa totalt antal klick	broadcast.stats.show_total_clicks	boolean	Om du vill visa totalt antal klick.
Läge	broadcast.stats.status	string	Status.
Progress	broadcast.stats.progress	integer	Förloppet.

Lista köp

Åtgärds-ID:

PurchaseList

Hämta en lista över alla inköp för ett konto.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Sida	page		integer	Sidan.

Returer

Name	Sökväg	Typ	Description
Totalt antal inköp	total_purchases	integer	Totalt antal inköp.
Sida	page	integer	Sidan.
Totalt antal sidor	total_pages	integer	Totalt antal sidor.
Inköp	purchases	array of object
ID-nummer	purchases.id	integer	Den unika identifieraren.
Transaktions-ID	purchases.transaction_id	string	Den unika transaktionsidentifieraren.
Läge	purchases.status	string	Status.
E-postadress	purchases.email_address	string	E-postadressen.
Valuta	purchases.currency	string	Valutan.
Transaktionstid	purchases.transaction_time	string	Transaktionstiden.
Delsumma	purchases.subtotal	integer	Delsumman.
Frakt	purchases.shipping	integer	Frakten.
Rabatt	purchases.discount	integer	Rabatten.
Skatt	purchases.tax	integer	Skatten.
Total	purchases.total	integer	Summan.
Produkter	purchases.products	array of object
Enhetspris	purchases.products.unit_price	integer	Enhetspriset.
Kvantitet	purchases.products.quantity	integer	Kvantiteten.
artikelnummer (SKU)	purchases.products.sku	string	SKU:n.
Namn	purchases.products.name	string	Namnet.

Lista prenumerantens taggar

Åtgärds-ID:

SubscriberTags

Hämtar en lista över alla taggar för en prenumerant.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Prenumerant-ID	subscriber_id	True	string	Den unika identifieraren för prenumeranten.

Returer

Name	Sökväg	Typ	Description
Etiketter	tags	array of object
ID-nummer	tags.id	integer	Den unika identifieraren.
Namn	tags.name	string	Namnet.
Skapad vid	tags.created_at	string	När den skapas på.

Lista prenumeranter

Åtgärds-ID:

SubscriberList

Returnerar en lista över dina prenumeranter. För att endast avbryta prenumerationer använder du värdet avbryts för sorteringsfältparam (för närvarande det enda extra sorteringsfält som stöds).

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Från	from		string	Från.
Till	to		string	Till.
Uppdaterad från	updated_from		string	När den uppdateras från.
Uppdaterad till	updated_to		string	När den uppdateras till.
Sorteringsordning	sort_order		string	Sorteringsordningen.
Sorteringsfält	sort_field		string	Sorteringsfältet.
E-postadress	email_address		string	E-postadressen.
Sida	page		integer	Sidan.

Returer

Name	Sökväg	Typ	Description
Totalt antal prenumeranter	total_subscribers	integer	Totalt antal prenumeranter.
Sida	page	integer	Sidan.
Totalt antal sidor	total_pages	integer	Totalt antal sidor.
Prenumeranter	subscribers	array of object
ID-nummer	subscribers.id	integer	Den unika identifieraren.
Förnamn	subscribers.first_name	string	Förnamnet.
E-postadress	subscribers.email_address	string	E-postadressen.
Stat/län	subscribers.state	string	Staten.
Skapad vid	subscribers.created_at	string	När den skapas på.
Efternamn	subscribers.fields.last_name	string	Efternamnet.

Lista prenumerationer till en sekvens

Åtgärds-ID:

SequenceSubList

Hämtar prenumerationer till en sekvens inklusive prenumerantdata.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Sekvens-ID	sequence_id	True	string	Sekvensens unika identifierare.
Sorteringsordning	sort_order		string	Sorteringsordningen.
Prenumeranttillstånd	subscriber_state		string	Prenumerantens tillstånd.
Sida	page		integer	Sidan.

Returer

Name	Sökväg	Typ	Description
Totalt antal prenumerationer	total_subscriptions	integer	Totalt antal prenumerationer.
Sida	page	integer	Sidan.
Totalt antal sidor	total_pages	integer	Totalt antal sidor.
Prenumerationer	subscriptions	array of object
ID-nummer	subscriptions.id	integer	Den unika identifieraren.
Stat/län	subscriptions.state	string	Staten.
Skapad vid	subscriptions.created_at	string	När den skapas på.
Källa	subscriptions.source	string	Källan.
Hänvisningsadress	subscriptions.referrer	string	Referenten.
Subscribable ID	subscriptions.subscribable_id	integer	Den subscribable unika identifieraren.
Typ av subscribable	subscriptions.subscribable_type	string	Den subscribable typen.
ID-nummer	subscriptions.subscriber.id	integer	Den unika identifieraren.
Förnamn	subscriptions.subscriber.first_name	string	Förnamnet.
E-postadress	subscriptions.subscriber.email_address	string	E-postadressen.
Stat/län	subscriptions.subscriber.state	string	Staten.
Skapad vid	subscriptions.subscriber.created_at	string	När den skapas på.
Efternamn	subscriptions.subscriber.fields.last_name	string	Efternamnet.

Lista prenumerationer till ett formulär

Åtgärds-ID:

FormSubList

Hämtar en lista över prenumerationer till ett formulär inklusive prenumerantdata.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Formulär-ID	form_id	True	string	Formulärets unika identifierare.
Sorteringsordning	sort_order		string	Sorteringsordningen.
Prenumeranttillstånd	subscriber_state		string	Prenumerantens tillstånd.
Sida	page		integer	Sidan.

Returer

Name	Sökväg	Typ	Description
Totalt antal prenumerationer	total_subscriptions	integer	Totalt antal prenumerationer.
Sida	page	integer	Sidan.
Totalt antal sidor	total_pages	integer	Totalt antal sidor.
Prenumerationer	subscriptions	array of object
ID-nummer	subscriptions.id	integer	Den unika identifieraren.
Stat/län	subscriptions.state	string	Staten.
Skapad vid	subscriptions.created_at	string	När den skapas på.
Källa	subscriptions.source	string	Källan.
Hänvisningsadress	subscriptions.referrer	string	Referenten.
Subscribable ID	subscriptions.subscribable_id	integer	Den subscribable unika identifieraren.
Typ av subscribable	subscriptions.subscribable_type	string	Den subscribable typen.
ID-nummer	subscriptions.subscriber.id	integer	Den unika identifieraren.
Förnamn	subscriptions.subscriber.first_name	string	Förnamnet.
E-postadress	subscriptions.subscriber.email_address	string	E-postadressen.
Stat/län	subscriptions.subscriber.state	string	Staten.
Skapad vid	subscriptions.subscriber.created_at	string	När den skapas på.
Efternamn	subscriptions.subscriber.fields.last_name	string	Efternamnet.

Lista sekvenser

Åtgärds-ID:

SequenceList

Hämtar en lista över sekvenser för kontot.

Returer

Name	Sökväg	Typ	Description
Kurser	courses	array of object
ID-nummer	courses.id	integer	Den unika identifieraren.
Namn	courses.name	string	Namnet.
Skapad vid	courses.created_at	string	När den skapas på.

Lista sändningar

Åtgärds-ID:

BroadcastList

Hämtar en lista över alla sändningar för ditt konto.

Returer

Name	Sökväg	Typ	Description
Sändningar	broadcasts	array of object
ID-nummer	broadcasts.id	integer	Den unika identifieraren.
Skapad vid	broadcasts.created_at	string	När den skapas på.
Ämne	broadcasts.subject	string	Ämnet.

Listtaggar

Åtgärds-ID:

TagList

Hämtar en lista med taggar för kontot.

Returer

Name	Sökväg	Typ	Description
Etiketter	tags	array of object
ID-nummer	tags.id	integer	Den unika identifieraren.
Namn	tags.name	string	Namnet.
Skapad vid	tags.created_at	string	När den skapas på.

Lägga till prenumerant i en sekvens

Åtgärds-ID:

SequenceSubAdd

Prenumerera på en e-postadress till en av dina sekvenser.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Sekvens-ID	sequence_id	True	string	Sekvensens unika identifierare.
E-postmeddelande	email	True	string	E-postadressen.
Förnamn	first_name		string	Förnamnet.
Etiketter	tags		array of integer

Returer

Name	Sökväg	Typ	Description
ID-nummer	subscription.id	integer	Den unika identifieraren.
Stat/län	subscription.state	string	Staten.
Skapad vid	subscription.created_at	string	När den skapas på.
Källa	subscription.source	string	Källan.
Hänvisningsadress	subscription.referrer	string	Referenten.
Subscribable ID	subscription.subscribable_id	integer	Den subscribable unika identifieraren.
Typ av subscribable	subscription.subscribable_type	string	Den subscribable typen.
ID-nummer	subscription.subscriber.id	integer	Den unika identifieraren.

Lägga till prenumerant i ett formulär

Åtgärds-ID:

FormSubAdd

Prenumerera på en e-postadress till ett av dina formulär.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Formulär-ID	form_id	True	string	Formulärets unika identifierare.
E-postmeddelande	email	True	string	E-postadressen.
Förnamn	first_name		string	Förnamnet.
Etiketter	tags		array of integer

Returer

Name	Sökväg	Typ	Description
ID-nummer	subscription.id	integer	Den unika identifieraren.
Stat/län	subscription.state	string	Staten.
Skapad vid	subscription.created_at	string	När den skapas på.
Källa	subscription.source	string	Källan.
Hänvisningsadress	subscription.referrer	string	Referenten.
Subscribable ID	subscription.subscribable_id	integer	Den subscribable unika identifieraren.
Typ av subscribable	subscription.subscribable_type	string	Den subscribable typen.
ID-nummer	subscription.subscriber.id	integer	Den unika identifieraren.
Förnamn	subscription.subscriber.first_name	string	Förnamnet.
E-postadress	subscription.subscriber.email_address	string	E-postadressen.
Stat/län	subscription.subscriber.state	string	Staten.
Skapad vid	subscription.subscriber.created_at	string	När den skapas på.

Skaffa en prenumerant

Åtgärds-ID:

SubscriberGet

Hämtar en post med en enda prenumerant.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Prenumerant-ID	subscriber_id	True	string	Den unika identifieraren för prenumeranten.

Returer

Name	Sökväg	Typ	Description
ID-nummer	subscriber.id	integer	Den unika identifieraren.
Förnamn	subscriber.first_name	string	Förnamnet.
E-postadress	subscriber.email_address	string	E-postadressen.
Stat/län	subscriber.state	string	Staten.
Skapad vid	subscriber.created_at	string	När den skapas på.
Efternamn	subscriber.fields.last_name	string	Efternamnet.

Skapa en sändning

Åtgärds-ID:

BroadcastAdd

Skapa ett utkast eller en schemalagd sändning. Du kan skapa ett utkast utan attribut. Schemalagda sändningar bör minst innehålla en ämnesrad och ditt innehåll.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Description	description		string	Beskrivningen.
Ämne	subject		string	Ämnet.
Content	content		string	Innehållet.
E-postadress	email_address		string	E-postadressen.
Mall för e-postlayout	email_layout_template		string	Mallen för e-postlayout.
Public	public		boolean	Oavsett om det är offentligt.
Publicerad på	published_at		string	När den publiceras på.
Skicka på	send_at		string	När du skickar på.
Miniatyr alt	thumbnail_alt		string	Alt-text för miniatyrbilden.
URL för miniatyr	thumbnail_url		string	URL-adressen för miniatyrbilden.

Returer

Name	Sökväg	Typ	Description
ID-nummer	broadcast.id	integer	Den unika identifieraren.
Skapad vid	broadcast.created_at	string	När den skapas på.
Ämne	broadcast.subject	string	Ämnet.
Description	broadcast.description	string	Beskrivningen.
Content	broadcast.content	string	Innehållet.
Public	broadcast.public	boolean	Oavsett om det är offentligt.
Publicerad på	broadcast.published_at	string	När den publiceras på.
Skicka på	broadcast.send_at	string	När det skickas på.
Miniatyr alt	broadcast.thumbnail_alt	string	Alt-text för miniatyrbilden.
URL för miniatyr	broadcast.thumbnail_url	string	URL-adressen för miniatyrbilden.
E-postadress	broadcast.email_address	string	E-postadressen.
Mall för e-postlayout	broadcast.email_layout_template	string	Mallen för e-postlayout.

Skapa en tagg

Åtgärds-ID:

TagAdd

Skapar en ny tagg.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Namn	name	True	string	Namnet.

Returer

Name	Sökväg	Typ	Description
Konto-ID	account_id	integer	Kontots unika identifierare.
Skapad vid	created_at	string	När den skapas på.
Borttaget vid	deleted_at	string	När den tas bort på.
ID-nummer	id	integer	Den unika identifieraren.
Namn	name	string	Namnet.
Stat/län	state	string	Staten.
Uppdaterad kl	updated_at	string	När den uppdateras på.

Skapa ett köp

Åtgärds-ID:

PurchaseAdd

Skapa ett köp.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Transaktions-ID	transaction_id	True	string	Den unika transaktionsidentifieraren.
E-postadress	email_address	True	string	E-postadressen.
Förnamn	first_name		string	Förnamnet.
Valuta	currency	True	string	Valutan.
Transaktionstid	transaction_time		string	Transaktionstiden.
Delsumma	subtotal		integer	Delsumman.
Skatt	tax		integer	Skatten.
Frakt	shipping		integer	Frakten.
Rabatt	discount		integer	Rabatten.
Total	total		integer	Summan.
Läge	status		string	Status.
PID	pid	True	integer	Den personliga identifieraren.
LOCK	lid	True	integer	LOCKET.
Namn	name	True	string	Namnet.
artikelnummer (SKU)	sku		string	SKU:n.
Enhetspris	unit_price	True	integer	Enhetspriset.
Kvantitet	quantity	True	integer	Kvantiteten.

Returer

Name	Sökväg	Typ	Description
ID-nummer	id	integer	Den unika identifieraren.
Transaktions-ID	transaction_id	string	Den unika transaktionsidentifieraren.
Läge	status	string	Status.
E-postadress	email_address	string	E-postadressen.
Valuta	currency	string	Valutan.
Transaktionstid	transaction_time	string	Transaktionstiden.
Delsumma	subtotal	integer	Delsumman.
Rabatt	discount	integer	Rabatten.
Skatt	tax	integer	Skatten.
Frakt	shipping	integer	Frakten.
Total	total	integer	Summan.
Produkter	products	array of object
Enhetspris	products.unit_price	integer	Enhetspriset.
Kvantitet	products.quantity	integer	Kvantiteten.
artikelnummer (SKU)	products.sku	string	SKU:n.
Namn	products.name	string	Namnet.

Ta bort tagg från prenumerant

Åtgärds-ID:

TagSubRemove

Tar bort en tagg från en prenumerant.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Prenumerant-ID	subscriber_id	True	string	Den unika identifieraren för prenumeranten.
Tagg-ID	tag_id	True	string	Taggens unika identifierare.

Returer

Name	Sökväg	Typ	Description
ID-nummer	id	integer	Den unika identifieraren.
Namn	name	string	Namnet.
Skapad vid	created_at	string	När den skapas på.

Ta bort tagg från prenumerant via e-post

Åtgärds-ID:

TagSubRemoveEmail

Ta bort en tagg från en prenumerant via e-postadress.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Tagg-ID	tag_id	True	string	Taggens unika identifierare.
E-postmeddelande	email	True	string	E-postadressen.

Returer

Name	Sökväg	Typ	Description
ID-nummer	id	integer	Den unika identifieraren.
Namn	name	string	Namnet.
Skapad vid	created_at	string	När den skapas på.

Tagga en prenumerant

Åtgärds-ID:

TagSub

Taggar hanteras som prenumerationer. Prenumerera på en e-postadress till en tagg för att få taggen tillämpad på prenumeranten med den e-postadressen.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Tagg-ID	tag_id	True	string	Taggens unika identifierare.
E-postmeddelande	email		string	E-postadressen.
Förnamn	first_name		string	Förnamnet.
Etiketter	tags		array of integer

Returer

Name	Sökväg	Typ	Description
ID-nummer	subscription.id	integer	Den unika identifieraren.
Stat/län	subscription.state	string	Staten.
Skapad vid	subscription.created_at	string	När den skapas på.
Källa	subscription.source	string	Källan.
Hänvisningsadress	subscription.referrer	string	Referenten.
Subscribable ID	subscription.subscribable_id	integer	Den subscribable unika identifieraren.
Typ av subscribable	subscription.subscribable_type	string	Den subscribable typen.
ID-nummer	subscription.subscriber.id	integer	Den unika identifieraren.

Uppdatera en sändning

Åtgärds-ID:

BroadcastUpdate

Uppdaterar attributen för en specifik sändning. Sändningar som för närvarande skickar eller som har skickats kanske inte uppdateras.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Sändnings-ID	broadcast_id	True	string	Den unika broadcast-identifieraren.
Description	description		string	Beskrivningen.
Ämne	subject		string	Ämnet.
Content	content		string	Innehållet.
E-postadress	email_address		string	E-postadressen.
Mall för e-postlayout	email_layout_template		string	Mallen för e-postlayout.
Public	public		boolean	Oavsett om det är offentligt.
Publicerad på	published_at		string	När den publiceras på.
Skicka på	send_at		string	När du skickar på.
Miniatyr alt	thumbnail_alt		string	Alt-text för miniatyrbilden.
URL för miniatyr	thumbnail_url		string	URL-adressen för miniatyrbilden.

Returer

Name	Sökväg	Typ	Description
ID-nummer	broadcast.id	integer	Den unika identifieraren.
Skapad vid	broadcast.created_at	string	När den skapas på.
Ämne	broadcast.subject	string	Ämnet.
Description	broadcast.description	string	Beskrivningen.
Content	broadcast.content	string	Innehållet.
Public	broadcast.public	boolean	Oavsett om det är offentligt.
Publicerad på	broadcast.published_at	string	När den publiceras på.
Skicka på	broadcast.send_at	string	När det skickas på.
Miniatyr alt	broadcast.thumbnail_alt	string	Alt-text för miniatyrbilden.
URL för miniatyr	broadcast.thumbnail_url	string	URL-adressen för miniatyrbilden.
E-postadress	broadcast.email_address	string	E-postadressen.
Mall för e-postlayout	broadcast.email_layout_template	string	Mallen för e-postlayout.

Uppdatera prenumerant

Åtgärds-ID:

SubscriberUpdate

Uppdaterar informationen för en enskild prenumerant.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Prenumerant-ID	subscriber_id	True	string	Den unika identifieraren för prenumeranten.
Förnamn	first_name		string	Förnamnet.
E-postadress	email_address		string	E-postadressen.

Returer

Name	Sökväg	Typ	Description
ID-nummer	subscriber.id	integer	Den unika identifieraren.
Förnamn	subscriber.first_name	string	Förnamnet.
E-postadress	subscriber.email_address	string	E-postadressen.
Stat/län	subscriber.state	string	Staten.
Skapad vid	subscriber.created_at	string	När den skapas på.

Visa en lista över prenumerationer på en tagg

Åtgärds-ID:

TagSubList

Hämtar en lista över prenumerationer till en tagg inklusive prenumerantdata.

Parametrar

Name	Nyckel	Obligatorisk	Typ	Description
Tagg-ID	tag_id	True	string	Taggens unika identifierare.
Sorteringsordning	sort_order		string	Sorteringsordningen.
Prenumeranttillstånd	subscriber_state		string	Prenumerantens tillstånd.
Sida	page		integer	Sidan.

Returer

Name	Sökväg	Typ	Description
Totalt antal prenumerationer	total_subscriptions	integer	Totalt antal prenumerationer.
Sida	page	integer	Sidan.
Totalt antal sidor	total_pages	integer	Totalt antal sidor.
Prenumerationer	subscriptions	array of object
ID-nummer	subscriptions.id	integer	Den unika identifieraren.
Stat/län	subscriptions.state	string	Staten.
Skapad vid	subscriptions.created_at	string	När den skapas på.
Källa	subscriptions.source	string	Källan.
Hänvisningsadress	subscriptions.referrer	string	Referenten.
Subscribable ID	subscriptions.subscribable_id	integer	Den subscribable unika identifieraren.
Typ av subscribable	subscriptions.subscribable_type	string	Den subscribable typen.
ID-nummer	subscriptions.subscriber.id	integer	Den unika identifieraren.
Förnamn	subscriptions.subscriber.first_name	string	Förnamnet.
E-postadress	subscriptions.subscriber.email_address	string	E-postadressen.
Stat/län	subscriptions.subscriber.state	string	Staten.
Skapad vid	subscriptions.subscriber.created_at	string	När den skapas på.
Efternamn	subscriptions.subscriber.fields.last_name	string	Efternamnet.

Definitioner

snöre

Det här är den grundläggande datatypen "string".