ConvertKit (éditeur indépendant)
ConvertKit est le hub marketing go-to pour les créateurs qui vous aident à développer et monétiser votre public avec facilité. Convertissez vos abonnés à partir de réseaux sociaux, YouTube et bien plus encore dans votre liste de courriers électroniques avec une belle page d’accueil et des modèles d’opt-in.
Ce connecteur est disponible dans les produits et régions suivants :
| Service | classe | Régions |
|---|---|---|
| Copilot Studio | Premium | Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Applications logiques | Norme | Toutes les régions Logic Apps , à l’exception des suivantes : - Régions Azure Government - Régions Azure Chine - Us Department of Defense (DoD) |
| Power Apps | Premium | Toutes les régions Power Apps , à l’exception des suivantes : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Power Automate | Premium | Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Contact | |
|---|---|
| Nom | Troy Taylor |
| URL | https://www.hitachisolutions.com |
| Messagerie électronique | ttaylor@hitachisolutions.com |
| Métadonnées du connecteur | |
|---|---|
| Éditeur | Troy Taylor, Hitachi Solutions |
| Site internet | https://convertkit.com/ |
| Politique de confidentialité | https://convertkit.com/privacy |
| Catégories | Commercialisation |
Création d’une connexion
Le connecteur prend en charge les types d’authentification suivants :
| Par défaut | Paramètres de création de connexion. | Toutes les régions | Non partageable |
Faire défaut
Applicable : Toutes les régions
Paramètres de création de connexion.
Cette connexion n’est pas partageable. Si l’application power est partagée avec un autre utilisateur, un autre utilisateur est invité à créer une connexion explicitement.
| Nom | Type | Descriptif | Obligatoire |
|---|---|---|---|
| Secret d’API | securestring | Secret d’API pour cette API | Vrai |
Limitations
| Nom | Appels | Période de renouvellement |
|---|---|---|
| Appels d’API par connexion | 100 | 60 secondes |
Actions
| Ajouter un abonné à un formulaire |
Abonnez-vous à une adresse e-mail à l’un de vos formulaires. |
| Ajouter un abonné à une séquence |
Abonnez une adresse e-mail à l’une de vos séquences. |
| Baliser un abonné |
Les balises sont gérées en tant qu’abonnements. Abonnez-vous à une adresse e-mail à une balise pour que cette balise soit appliquée à l’abonné avec cette adresse e-mail. |
| Créer un achat |
Créez un achat. |
| Créer une balise |
Crée une balise. |
| Créer une diffusion |
Créez un brouillon ou une diffusion planifiée. Vous pouvez créer un brouillon de diffusion sans attributs. Les diffusions planifiées au minimum doivent contenir une ligne d’objet et votre contenu. |
| Désabonner l’abonné |
Désinscrivez un abonné de tous vos formulaires et séquences. |
| Détruire une diffusion |
Supprimez définitivement un brouillon ou un enregistrement de diffusion planifié. Les diffusions qui envoient actuellement ou qui ont été envoyées peuvent ne pas être supprimées. |
| Mettre à jour l’abonné |
Met à jour les informations d’un seul abonné. |
| Mettre à jour une diffusion |
Met à jour les attributs d’une diffusion spécifique. Les diffusions qui envoient actuellement ou qui ont été envoyées peuvent ne pas être mises à jour. |
| Obtenir des formulaires |
Récupérez la liste de tous les formulaires de votre compte. |
| Obtenir le détail du compte |
Récupère le compte actif. |
| Obtenir les statistiques de diffusion |
Récupère les statistiques (nombre de destinataires, taux d’ouverture, taux de clics, nombre de désabonnements, clics totaux, état et progression d’envoi) pour une diffusion spécifique. |
| Obtenir un abonné |
Récupère un enregistrement d’abonné unique. |
| Obtenir un achat |
Récupérez un achat spécifique par ID. |
| Récupérer une diffusion |
Récupère les détails d’une diffusion spécifique, y compris les brouillons, planifiés et les diffusions précédemment envoyées. |
| Répertorier les abonnements à un formulaire |
Récupère une liste d’abonnements dans un formulaire, y compris les données de l’abonné. |
| Répertorier les abonnements à une balise |
Récupère une liste d’abonnements à une balise, y compris les données de l’abonné. |
| Répertorier les abonnements à une séquence |
Récupère des abonnements à une séquence, y compris les données de l’abonné. |
| Répertorier les abonnés |
Retourne une liste de vos abonnés. Pour les désabonnements uniquement, utilisez l’annulation à la valeur de l’analyseur de champ de tri (actuellement le seul champ de tri supplémentaire pris en charge). |
| Répertorier les achats |
Récupérez la liste de tous les achats d’un compte. |
| Répertorier les balises de l’abonné |
Récupère une liste de toutes les balises d’un abonné. |
| Répertorier les diffusions |
Récupère une liste de toutes les diffusions de votre compte. |
| Répertorier les séquences |
Récupère une liste de séquences pour le compte. |
| Répertorier les étiquettes |
Récupère une liste d’étiquettes pour le compte. |
| Supprimer l’étiquette de l’abonné |
Supprime une balise d’un abonné. |
| Supprimer une balise de l’abonné par e-mail |
Supprimez une balise d’un abonné par adresse e-mail. |
Ajouter un abonné à un formulaire
Abonnez-vous à une adresse e-mail à l’un de vos formulaires.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de formulaire
|
form_id | True | string |
Identificateur unique du formulaire. |
|
Messagerie électronique
|
True | string |
Adresse e-mail. |
|
|
Prénom
|
first_name | string |
Prénom. |
|
|
Étiquettes
|
tags | array of integer |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
subscription.id | integer |
Identificateur unique. |
|
État
|
subscription.state | string |
État. |
|
Créé à
|
subscription.created_at | string |
Quand il est créé à l’adresse. |
|
Origine
|
subscription.source | string |
Source. |
|
Référent
|
subscription.referrer | string |
Le référent. |
|
ID abonné
|
subscription.subscribable_id | integer |
Identificateur unique abonné. |
|
Type d’abonnement
|
subscription.subscribable_type | string |
Type d’abonnement. |
|
ID
|
subscription.subscriber.id | integer |
Identificateur unique. |
|
Prénom
|
subscription.subscriber.first_name | string |
Prénom. |
|
Adresse électronique
|
subscription.subscriber.email_address | string |
Adresse e-mail. |
|
État
|
subscription.subscriber.state | string |
État. |
|
Créé à
|
subscription.subscriber.created_at | string |
Quand il est créé à l’adresse. |
Ajouter un abonné à une séquence
Abonnez une adresse e-mail à l’une de vos séquences.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de séquence
|
sequence_id | True | string |
Identificateur unique de séquence. |
|
Messagerie électronique
|
True | string |
Adresse e-mail. |
|
|
Prénom
|
first_name | string |
Prénom. |
|
|
Étiquettes
|
tags | array of integer |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
subscription.id | integer |
Identificateur unique. |
|
État
|
subscription.state | string |
État. |
|
Créé à
|
subscription.created_at | string |
Quand il est créé à l’adresse. |
|
Origine
|
subscription.source | string |
Source. |
|
Référent
|
subscription.referrer | string |
Le référent. |
|
ID abonné
|
subscription.subscribable_id | integer |
Identificateur unique abonné. |
|
Type d’abonnement
|
subscription.subscribable_type | string |
Type d’abonnement. |
|
ID
|
subscription.subscriber.id | integer |
Identificateur unique. |
Baliser un abonné
Les balises sont gérées en tant qu’abonnements. Abonnez-vous à une adresse e-mail à une balise pour que cette balise soit appliquée à l’abonné avec cette adresse e-mail.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de balise
|
tag_id | True | string |
Identificateur unique de balise. |
|
Messagerie électronique
|
string |
Adresse e-mail. |
||
|
Prénom
|
first_name | string |
Prénom. |
|
|
Étiquettes
|
tags | array of integer |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
subscription.id | integer |
Identificateur unique. |
|
État
|
subscription.state | string |
État. |
|
Créé à
|
subscription.created_at | string |
Quand il est créé à l’adresse. |
|
Origine
|
subscription.source | string |
Source. |
|
Référent
|
subscription.referrer | string |
Le référent. |
|
ID abonné
|
subscription.subscribable_id | integer |
Identificateur unique abonné. |
|
Type d’abonnement
|
subscription.subscribable_type | string |
Type d’abonnement. |
|
ID
|
subscription.subscriber.id | integer |
Identificateur unique. |
Créer un achat
Créez un achat.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Transaction ID
|
transaction_id | True | string |
Identificateur unique de transaction. |
|
Adresse électronique
|
email_address | True | string |
Adresse e-mail. |
|
Prénom
|
first_name | string |
Prénom. |
|
|
Monnaie
|
currency | True | string |
La devise. |
|
Heure de transaction
|
transaction_time | string |
Heure de la transaction. |
|
|
Sous-total
|
subtotal | integer |
Sous-total. |
|
|
Taxe
|
tax | integer |
La taxe. |
|
|
Livraison
|
shipping | integer |
L’expédition. |
|
|
Remise
|
discount | integer |
La remise. |
|
|
Total
|
total | integer |
Total. |
|
|
Statut
|
status | string |
État. |
|
|
PID
|
pid | True | integer |
Identificateur personnel. |
|
COUVERCLE
|
lid | True | integer |
The LID. |
|
Nom
|
name | True | string |
Nom. |
|
Référence (SKU)
|
sku | string |
Référence SKU. |
|
|
Prix unitaire
|
unit_price | True | integer |
Prix unitaire. |
|
Quantité
|
quantity | True | integer |
Quantité. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | integer |
Identificateur unique. |
|
Transaction ID
|
transaction_id | string |
Identificateur unique de transaction. |
|
Statut
|
status | string |
État. |
|
Adresse électronique
|
email_address | string |
Adresse e-mail. |
|
Monnaie
|
currency | string |
La devise. |
|
Heure de transaction
|
transaction_time | string |
Heure de la transaction. |
|
Sous-total
|
subtotal | integer |
Sous-total. |
|
Remise
|
discount | integer |
La remise. |
|
Taxe
|
tax | integer |
La taxe. |
|
Livraison
|
shipping | integer |
L’expédition. |
|
Total
|
total | integer |
Total. |
|
Produits
|
products | array of object | |
|
Prix unitaire
|
products.unit_price | integer |
Prix unitaire. |
|
Quantité
|
products.quantity | integer |
Quantité. |
|
Référence (SKU)
|
products.sku | string |
Référence SKU. |
|
Nom
|
products.name | string |
Nom. |
Créer une balise
Crée une balise.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nom
|
name | True | string |
Nom. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID de compte
|
account_id | integer |
Identificateur unique du compte. |
|
Créé à
|
created_at | string |
Quand il est créé à l’adresse. |
|
Supprimé à
|
deleted_at | string |
En cas de suppression. |
|
ID
|
id | integer |
Identificateur unique. |
|
Nom
|
name | string |
Nom. |
|
État
|
state | string |
État. |
|
Mise à jour à
|
updated_at | string |
Lorsqu’il est mis à jour à l’adresse. |
Créer une diffusion
Créez un brouillon ou une diffusion planifiée. Vous pouvez créer un brouillon de diffusion sans attributs. Les diffusions planifiées au minimum doivent contenir une ligne d’objet et votre contenu.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Descriptif
|
description | string |
Description. |
|
|
Sujet
|
subject | string |
Objet. |
|
|
Content
|
content | string |
Contenu. |
|
|
Adresse électronique
|
email_address | string |
Adresse e-mail. |
|
|
Modèle de disposition de l’e-mail
|
email_layout_template | string |
Modèle de disposition de l’e-mail. |
|
|
Publique
|
public | boolean |
Indique si public. |
|
|
Publié à
|
published_at | string |
Lorsqu’il est publié à l’adresse. |
|
|
Envoyer à
|
send_at | string |
Lors de l’envoi. |
|
|
Alt miniature
|
thumbnail_alt | string |
Texte de remplacement pour la miniature. |
|
|
URL de miniature
|
thumbnail_url | string |
Adresse URL de la miniature. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
broadcast.id | integer |
Identificateur unique. |
|
Créé à
|
broadcast.created_at | string |
Quand il est créé à l’adresse. |
|
Sujet
|
broadcast.subject | string |
Objet. |
|
Descriptif
|
broadcast.description | string |
Description. |
|
Content
|
broadcast.content | string |
Contenu. |
|
Publique
|
broadcast.public | boolean |
Indique si public. |
|
Publié à
|
broadcast.published_at | string |
Lorsqu’il est publié à l’adresse. |
|
Envoyer à
|
broadcast.send_at | string |
Lorsqu’il est envoyé à. |
|
Alt miniature
|
broadcast.thumbnail_alt | string |
Texte de remplacement pour la miniature. |
|
URL de miniature
|
broadcast.thumbnail_url | string |
Adresse URL de la miniature. |
|
Adresse électronique
|
broadcast.email_address | string |
Adresse e-mail. |
|
Modèle de disposition de l’e-mail
|
broadcast.email_layout_template | string |
Modèle de disposition de l’e-mail. |
Désabonner l’abonné
Désinscrivez un abonné de tous vos formulaires et séquences.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Messagerie électronique
|
True | string |
Adresse e-mail. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
subscriber.id | integer |
Identificateur unique. |
|
Prénom
|
subscriber.first_name | string |
Prénom. |
|
Adresse électronique
|
subscriber.email_address | string |
Adresse e-mail. |
|
État
|
subscriber.state | string |
État. |
|
Créé à
|
subscriber.created_at | string |
Quand il est créé à l’adresse. |
|
Nom de famille
|
subscriber.fields.last_name | string |
Nom. |
Détruire une diffusion
Supprimez définitivement un brouillon ou un enregistrement de diffusion planifié. Les diffusions qui envoient actuellement ou qui ont été envoyées peuvent ne pas être supprimées.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de diffusion
|
broadcast_id | True | string |
Identificateur unique de diffusion. |
Retours
- response
- string
Mettre à jour l’abonné
Met à jour les informations d’un seul abonné.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de l’abonné
|
subscriber_id | True | string |
Identificateur unique de l’abonné. |
|
Prénom
|
first_name | string |
Prénom. |
|
|
Adresse électronique
|
email_address | string |
Adresse e-mail. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
subscriber.id | integer |
Identificateur unique. |
|
Prénom
|
subscriber.first_name | string |
Prénom. |
|
Adresse électronique
|
subscriber.email_address | string |
Adresse e-mail. |
|
État
|
subscriber.state | string |
État. |
|
Créé à
|
subscriber.created_at | string |
Quand il est créé à l’adresse. |
Mettre à jour une diffusion
Met à jour les attributs d’une diffusion spécifique. Les diffusions qui envoient actuellement ou qui ont été envoyées peuvent ne pas être mises à jour.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de diffusion
|
broadcast_id | True | string |
Identificateur unique de diffusion. |
|
Descriptif
|
description | string |
Description. |
|
|
Sujet
|
subject | string |
Objet. |
|
|
Content
|
content | string |
Contenu. |
|
|
Adresse électronique
|
email_address | string |
Adresse e-mail. |
|
|
Modèle de disposition de l’e-mail
|
email_layout_template | string |
Modèle de disposition de l’e-mail. |
|
|
Publique
|
public | boolean |
Indique si public. |
|
|
Publié à
|
published_at | string |
Lorsqu’il est publié à l’adresse. |
|
|
Envoyer à
|
send_at | string |
Lors de l’envoi. |
|
|
Alt miniature
|
thumbnail_alt | string |
Texte de remplacement pour la miniature. |
|
|
URL de miniature
|
thumbnail_url | string |
Adresse URL de la miniature. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
broadcast.id | integer |
Identificateur unique. |
|
Créé à
|
broadcast.created_at | string |
Quand il est créé à l’adresse. |
|
Sujet
|
broadcast.subject | string |
Objet. |
|
Descriptif
|
broadcast.description | string |
Description. |
|
Content
|
broadcast.content | string |
Contenu. |
|
Publique
|
broadcast.public | boolean |
Indique si public. |
|
Publié à
|
broadcast.published_at | string |
Lorsqu’il est publié à l’adresse. |
|
Envoyer à
|
broadcast.send_at | string |
Lorsqu’il est envoyé à. |
|
Alt miniature
|
broadcast.thumbnail_alt | string |
Texte de remplacement pour la miniature. |
|
URL de miniature
|
broadcast.thumbnail_url | string |
Adresse URL de la miniature. |
|
Adresse électronique
|
broadcast.email_address | string |
Adresse e-mail. |
|
Modèle de disposition de l’e-mail
|
broadcast.email_layout_template | string |
Modèle de disposition de l’e-mail. |
Obtenir des formulaires
Récupérez la liste de tous les formulaires de votre compte.
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Formulaires
|
forms | array of object | |
|
ID
|
forms.id | integer |
Identificateur unique. |
|
Nom
|
forms.name | string |
Nom. |
|
Créé à
|
forms.created_at | string |
Quand il est créé à l’adresse. |
|
Type
|
forms.type | string |
Type. |
|
Format
|
forms.format | string |
Format. |
|
URL
|
forms.url | string |
Adresse URL. |
|
Incorporer JS
|
forms.embed_js | string |
Javascript à incorporer. |
|
URL d’incorporation
|
forms.embed_url | string |
Adresse URL à incorporer. |
|
Titre
|
forms.title | string |
Titre. |
|
Descriptif
|
forms.description | string |
Description. |
|
Texte du bouton d’inscription
|
forms.sign_up_button_text | string |
Texte du bouton d’inscription. |
|
Message de réussite
|
forms.success_message | string |
Message de réussite. |
|
Archivés
|
forms.archived | boolean |
Indique s’il est archivé. |
|
Identificateur d’utilisateur
|
forms.uid | string |
Identificateur unique. |
Obtenir le détail du compte
Récupère le compte actif.
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nom
|
name | string |
Nom. |
|
Plan Type
|
plan_type | string |
Type de plan. |
|
Adresse e-mail principale
|
primary_email_address | string |
Adresse e-mail principale. |
Obtenir les statistiques de diffusion
Récupère les statistiques (nombre de destinataires, taux d’ouverture, taux de clics, nombre de désabonnements, clics totaux, état et progression d’envoi) pour une diffusion spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de diffusion
|
broadcast_id | True | string |
Identificateur unique de diffusion. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Émission
|
broadcast | array of object | |
|
ID
|
broadcast.id | integer |
Identificateur unique. |
|
Destinataires
|
broadcast.stats.recipients | integer |
Destinataires. |
|
Taux d’ouverture
|
broadcast.stats.open_rate | float |
Taux d’ouverture. |
|
Taux de clic
|
broadcast.stats.click_rate | float |
Taux de clic. |
|
Annule l’abonnement
|
broadcast.stats.unsubscribes | integer |
Les désabonnements. |
|
Nombre total de clics
|
broadcast.stats.total_clicks | integer |
Nombre total de clics. |
|
Afficher le nombre total de clics
|
broadcast.stats.show_total_clicks | boolean |
Indique s’il faut afficher le total des clics. |
|
Statut
|
broadcast.stats.status | string |
État. |
|
Progrès
|
broadcast.stats.progress | integer |
Progression. |
Obtenir un abonné
Récupère un enregistrement d’abonné unique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de l’abonné
|
subscriber_id | True | string |
Identificateur unique de l’abonné. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
subscriber.id | integer |
Identificateur unique. |
|
Prénom
|
subscriber.first_name | string |
Prénom. |
|
Adresse électronique
|
subscriber.email_address | string |
Adresse e-mail. |
|
État
|
subscriber.state | string |
État. |
|
Créé à
|
subscriber.created_at | string |
Quand il est créé à l’adresse. |
|
Nom de famille
|
subscriber.fields.last_name | string |
Nom. |
Obtenir un achat
Récupérez un achat spécifique par ID.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’achat
|
purchase_id | True | string |
Identificateur d’achat. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | integer |
Identificateur unique. |
|
Transaction ID
|
transaction_id | string |
Identificateur unique de transaction. |
|
Statut
|
status | string |
État. |
|
Adresse électronique
|
email_address | string |
Adresse e-mail. |
|
Monnaie
|
currency | string |
La devise. |
|
Heure de transaction
|
transaction_time | string |
Heure de la transaction. |
|
Sous-total
|
subtotal | integer |
Sous-total. |
|
Livraison
|
shipping | integer |
L’expédition. |
|
Remise
|
discount | integer |
La remise. |
|
Taxe
|
tax | integer |
La taxe. |
|
Total
|
total | integer |
Total. |
|
Produits
|
products | array of object | |
|
Prix unitaire
|
products.unit_price | integer |
Prix unitaire. |
|
Quantité
|
products.quantity | integer |
Quantité. |
|
Référence (SKU)
|
products.sku | string |
Référence SKU. |
|
Nom
|
products.name | string |
Nom. |
Récupérer une diffusion
Récupère les détails d’une diffusion spécifique, y compris les brouillons, planifiés et les diffusions précédemment envoyées.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de diffusion
|
broadcast_id | True | string |
Identificateur unique de diffusion. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
broadcast.id | integer |
Identificateur unique. |
|
Créé à
|
broadcast.created_at | string |
Quand il est créé à l’adresse. |
|
Sujet
|
broadcast.subject | string |
Objet. |
|
Descriptif
|
broadcast.description | string |
Description. |
|
Content
|
broadcast.content | string |
Contenu. |
|
Publique
|
broadcast.public | boolean |
Indique si public. |
|
Publié à
|
broadcast.published_at | string |
Lorsqu’il est publié à l’adresse. |
|
Envoyer à
|
broadcast.send_at | string |
Lorsqu’il est envoyé à. |
|
Alt miniature
|
broadcast.thumbnail_alt | string |
Texte de remplacement pour la miniature. |
|
URL de miniature
|
broadcast.thumbnail_url | string |
Adresse URL de la miniature. |
|
Adresse électronique
|
broadcast.email_address | string |
Adresse e-mail. |
|
Modèle de disposition de l’e-mail
|
broadcast.email_layout_template | string |
Modèle de disposition de l’e-mail. |
Répertorier les abonnements à un formulaire
Récupère une liste d’abonnements dans un formulaire, y compris les données de l’abonné.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de formulaire
|
form_id | True | string |
Identificateur unique du formulaire. |
|
Ordre de tri
|
sort_order | string |
Ordre de tri. |
|
|
État de l’abonné
|
subscriber_state | string |
État de l’abonné. |
|
|
Page
|
page | integer |
La page. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nombre total d’abonnements
|
total_subscriptions | integer |
Nombre total d’abonnements. |
|
Page
|
page | integer |
La page. |
|
Total Pages
|
total_pages | integer |
Nombre total de pages. |
|
Abonnements
|
subscriptions | array of object | |
|
ID
|
subscriptions.id | integer |
Identificateur unique. |
|
État
|
subscriptions.state | string |
État. |
|
Créé à
|
subscriptions.created_at | string |
Quand il est créé à l’adresse. |
|
Origine
|
subscriptions.source | string |
Source. |
|
Référent
|
subscriptions.referrer | string |
Le référent. |
|
ID abonné
|
subscriptions.subscribable_id | integer |
Identificateur unique abonné. |
|
Type d’abonnement
|
subscriptions.subscribable_type | string |
Type d’abonnement. |
|
ID
|
subscriptions.subscriber.id | integer |
Identificateur unique. |
|
Prénom
|
subscriptions.subscriber.first_name | string |
Prénom. |
|
Adresse électronique
|
subscriptions.subscriber.email_address | string |
Adresse e-mail. |
|
État
|
subscriptions.subscriber.state | string |
État. |
|
Créé à
|
subscriptions.subscriber.created_at | string |
Quand il est créé à l’adresse. |
|
Nom de famille
|
subscriptions.subscriber.fields.last_name | string |
Nom. |
Répertorier les abonnements à une balise
Récupère une liste d’abonnements à une balise, y compris les données de l’abonné.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de balise
|
tag_id | True | string |
Identificateur unique de balise. |
|
Ordre de tri
|
sort_order | string |
Ordre de tri. |
|
|
État de l’abonné
|
subscriber_state | string |
État de l’abonné. |
|
|
Page
|
page | integer |
La page. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nombre total d’abonnements
|
total_subscriptions | integer |
Nombre total d’abonnements. |
|
Page
|
page | integer |
La page. |
|
Total Pages
|
total_pages | integer |
Nombre total de pages. |
|
Abonnements
|
subscriptions | array of object | |
|
ID
|
subscriptions.id | integer |
Identificateur unique. |
|
État
|
subscriptions.state | string |
État. |
|
Créé à
|
subscriptions.created_at | string |
Quand il est créé à l’adresse. |
|
Origine
|
subscriptions.source | string |
Source. |
|
Référent
|
subscriptions.referrer | string |
Le référent. |
|
ID abonné
|
subscriptions.subscribable_id | integer |
Identificateur unique abonné. |
|
Type d’abonnement
|
subscriptions.subscribable_type | string |
Type d’abonnement. |
|
ID
|
subscriptions.subscriber.id | integer |
Identificateur unique. |
|
Prénom
|
subscriptions.subscriber.first_name | string |
Prénom. |
|
Adresse électronique
|
subscriptions.subscriber.email_address | string |
Adresse e-mail. |
|
État
|
subscriptions.subscriber.state | string |
État. |
|
Créé à
|
subscriptions.subscriber.created_at | string |
Quand il est créé à l’adresse. |
|
Nom de famille
|
subscriptions.subscriber.fields.last_name | string |
Nom. |
Répertorier les abonnements à une séquence
Récupère des abonnements à une séquence, y compris les données de l’abonné.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de séquence
|
sequence_id | True | string |
Identificateur unique de séquence. |
|
Ordre de tri
|
sort_order | string |
Ordre de tri. |
|
|
État de l’abonné
|
subscriber_state | string |
État de l’abonné. |
|
|
Page
|
page | integer |
La page. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nombre total d’abonnements
|
total_subscriptions | integer |
Nombre total d’abonnements. |
|
Page
|
page | integer |
La page. |
|
Total Pages
|
total_pages | integer |
Nombre total de pages. |
|
Abonnements
|
subscriptions | array of object | |
|
ID
|
subscriptions.id | integer |
Identificateur unique. |
|
État
|
subscriptions.state | string |
État. |
|
Créé à
|
subscriptions.created_at | string |
Quand il est créé à l’adresse. |
|
Origine
|
subscriptions.source | string |
Source. |
|
Référent
|
subscriptions.referrer | string |
Le référent. |
|
ID abonné
|
subscriptions.subscribable_id | integer |
Identificateur unique abonné. |
|
Type d’abonnement
|
subscriptions.subscribable_type | string |
Type d’abonnement. |
|
ID
|
subscriptions.subscriber.id | integer |
Identificateur unique. |
|
Prénom
|
subscriptions.subscriber.first_name | string |
Prénom. |
|
Adresse électronique
|
subscriptions.subscriber.email_address | string |
Adresse e-mail. |
|
État
|
subscriptions.subscriber.state | string |
État. |
|
Créé à
|
subscriptions.subscriber.created_at | string |
Quand il est créé à l’adresse. |
|
Nom de famille
|
subscriptions.subscriber.fields.last_name | string |
Nom. |
Répertorier les abonnés
Retourne une liste de vos abonnés. Pour les désabonnements uniquement, utilisez l’annulation à la valeur de l’analyseur de champ de tri (actuellement le seul champ de tri supplémentaire pris en charge).
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
De
|
from | string |
De. |
|
|
À
|
to | string |
À. |
|
|
Mise à jour à partir de
|
updated_from | string |
Lorsqu’il est mis à jour à partir de. |
|
|
Mise à jour vers
|
updated_to | string |
Lorsqu’il est mis à jour. |
|
|
Ordre de tri
|
sort_order | string |
Ordre de tri. |
|
|
Trier le champ
|
sort_field | string |
Champ de tri. |
|
|
Adresse électronique
|
email_address | string |
Adresse e-mail. |
|
|
Page
|
page | integer |
La page. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nombre total d’abonnés
|
total_subscribers | integer |
Nombre total d’abonnés. |
|
Page
|
page | integer |
La page. |
|
Total Pages
|
total_pages | integer |
Nombre total de pages. |
|
Subscribers
|
subscribers | array of object | |
|
ID
|
subscribers.id | integer |
Identificateur unique. |
|
Prénom
|
subscribers.first_name | string |
Prénom. |
|
Adresse électronique
|
subscribers.email_address | string |
Adresse e-mail. |
|
État
|
subscribers.state | string |
État. |
|
Créé à
|
subscribers.created_at | string |
Quand il est créé à l’adresse. |
|
Nom de famille
|
subscribers.fields.last_name | string |
Nom. |
Répertorier les achats
Récupérez la liste de tous les achats d’un compte.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Page
|
page | integer |
La page. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Total des achats
|
total_purchases | integer |
Nombre total d’achats. |
|
Page
|
page | integer |
La page. |
|
Total Pages
|
total_pages | integer |
Nombre total de pages. |
|
Achats
|
purchases | array of object | |
|
ID
|
purchases.id | integer |
Identificateur unique. |
|
Transaction ID
|
purchases.transaction_id | string |
Identificateur unique de transaction. |
|
Statut
|
purchases.status | string |
État. |
|
Adresse électronique
|
purchases.email_address | string |
Adresse e-mail. |
|
Monnaie
|
purchases.currency | string |
La devise. |
|
Heure de transaction
|
purchases.transaction_time | string |
Heure de la transaction. |
|
Sous-total
|
purchases.subtotal | integer |
Sous-total. |
|
Livraison
|
purchases.shipping | integer |
L’expédition. |
|
Remise
|
purchases.discount | integer |
La remise. |
|
Taxe
|
purchases.tax | integer |
La taxe. |
|
Total
|
purchases.total | integer |
Total. |
|
Produits
|
purchases.products | array of object | |
|
Prix unitaire
|
purchases.products.unit_price | integer |
Prix unitaire. |
|
Quantité
|
purchases.products.quantity | integer |
Quantité. |
|
Référence (SKU)
|
purchases.products.sku | string |
Référence SKU. |
|
Nom
|
purchases.products.name | string |
Nom. |
Répertorier les balises de l’abonné
Récupère une liste de toutes les balises d’un abonné.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de l’abonné
|
subscriber_id | True | string |
Identificateur unique de l’abonné. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Étiquettes
|
tags | array of object | |
|
ID
|
tags.id | integer |
Identificateur unique. |
|
Nom
|
tags.name | string |
Nom. |
|
Créé à
|
tags.created_at | string |
Quand il est créé à l’adresse. |
Répertorier les diffusions
Récupère une liste de toutes les diffusions de votre compte.
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Émissions
|
broadcasts | array of object | |
|
ID
|
broadcasts.id | integer |
Identificateur unique. |
|
Créé à
|
broadcasts.created_at | string |
Quand il est créé à l’adresse. |
|
Sujet
|
broadcasts.subject | string |
Objet. |
Répertorier les séquences
Récupère une liste de séquences pour le compte.
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Cours
|
courses | array of object | |
|
ID
|
courses.id | integer |
Identificateur unique. |
|
Nom
|
courses.name | string |
Nom. |
|
Créé à
|
courses.created_at | string |
Quand il est créé à l’adresse. |
Répertorier les étiquettes
Récupère une liste d’étiquettes pour le compte.
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Étiquettes
|
tags | array of object | |
|
ID
|
tags.id | integer |
Identificateur unique. |
|
Nom
|
tags.name | string |
Nom. |
|
Créé à
|
tags.created_at | string |
Quand il est créé à l’adresse. |
Supprimer l’étiquette de l’abonné
Supprime une balise d’un abonné.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de l’abonné
|
subscriber_id | True | string |
Identificateur unique de l’abonné. |
|
ID de balise
|
tag_id | True | string |
Identificateur unique de balise. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | integer |
Identificateur unique. |
|
Nom
|
name | string |
Nom. |
|
Créé à
|
created_at | string |
Quand il est créé à l’adresse. |
Supprimer une balise de l’abonné par e-mail
Supprimez une balise d’un abonné par adresse e-mail.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de balise
|
tag_id | True | string |
Identificateur unique de balise. |
|
Messagerie électronique
|
True | string |
Adresse e-mail. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | integer |
Identificateur unique. |
|
Nom
|
name | string |
Nom. |
|
Créé à
|
created_at | string |
Quand il est créé à l’adresse. |
Définitions
ficelle
Il s’agit du type de données de base « string ».