MailJet (éditeur indépendant) (préversion)
Collection complète de tous les points de terminaison et méthodes disponibles publiquement pour l’API Mailjet
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 | Clement OLIVIER |
| URL | https://stuffandtacos.azurewebsites.net/ |
| Messagerie électronique | clement@carfup.com |
| Métadonnées du connecteur | |
|---|---|
| Éditeur | Clement Olivier |
| Site internet | https://www.mailjet.com/ |
| Politique de confidentialité | https://www.mailjet.com/security-privacy/ |
| Catégories | Marketing; Communication |
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 |
|---|---|---|---|
| Clé API/Connexion | securestring | Clé API/Connexion émise par MailJet | Vrai |
| Secret d’API | securestring | Secret d’API/PassWord émis par MailJet | Vrai |
Limitations
| Nom | Appels | Période de renouvellement |
|---|---|---|
| Appels d’API par connexion | 100 | 60 secondes |
Actions
| Créer un brouillon de campagne |
Créez un brouillon de campagne. Les objets Newsletter et CampaignDraft sont différenciés par les valeurs EditMode. |
| Créer un contact |
Ajouter un nouveau contact unique à votre liste de contacts globale et sélectionner son état d’exclusion |
| Créer une liste de contacts |
Créer une liste de contacts |
| Envoyer un e-mail v3 |
Envoyer un e-mail via l’API d’envoi v3 |
| Envoyer un e-mail v3.1 |
Envoyer un e-mail via l’API d’envoi v3.1 |
| Mettre à jour la liste des contacts |
Mettre à jour une liste de contacts spécifique en modifiant son nom et/ou son état de suppression |
| Mettre à jour le brouillon de campagne |
Mettre à jour un brouillon de campagne existant |
| Mettre à jour le contact |
Mettre à jour le nom donné par l’utilisateur et l’état d’exclusion d’un contact spécifique |
| Obtenir des contacts |
Récupérez une liste de tous les contacts. Inclut des informations sur l’état du contact et la création / horodatages d’activité |
| Obtenir des données de contacts |
Obtenir des informations sur tous les contacts et les valeurs de propriété associées |
| Obtenir des informations sur les messages |
Récupérer les informations d’envoi/taille/courrier indésirable sur tous les messages |
| Obtenir des listes de contacts |
Récupérez les détails de toutes les listes de contacts : nom, nombre d’abonnés, horodatage de création, état de suppression. |
| Obtenir des statistiques de contacts |
Récupérer une liste des statistiques globales de remise et d’engagement agrégées, regroupées par contact |
| Obtenir la liste des contacts par ID |
Récupérez les détails d’une liste de contacts spécifique : nom, nombre d’abonnés, horodatage de création, état de suppression. |
| Obtenir le brouillon de campagne par ID |
Obtenir un brouillon de campagne spécifique et ses détails de configuration |
| Obtenir le brouillon des campagnes |
Obtenir tous les brouillons de campagne et leur configuration |
| Obtenir les données de contact par ID |
Récupérer toutes les propriétés et valeurs respectives associées à un contact spécifique |
| Obtenir un contact par ID |
Récupérer un contact spécifique |
| Recevoir des messages |
Obtenir une liste de messages avec des informations spécifiques sur le type de contenu, de suivi, d’envoi et de remise |
| Supprimer la liste des contacts |
Supprimer une liste de contacts |
| Vue d’ensemble de la campagne |
Obtenir des détails généraux et des statistiques pour tous les brouillons, objets AB Testing et/ou campagnes envoyées |
Créer un brouillon de campagne
Créez un brouillon de campagne. Les objets Newsletter et CampaignDraft sont différenciés par les valeurs EditMode.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
En cours
|
Current | integer |
En cours |
|
|
Mode d’édition
|
EditMode | string |
Mode d’édition du brouillon de campagne. |
|
|
IsStarred
|
IsStarred | boolean |
Est en vedette |
|
|
IsTextPartIncluded
|
IsTextPartIncluded | boolean |
Composant Texte inclus |
|
|
ReplyEmail
|
ReplyEmail | string |
Adresse e-mail de réponse |
|
|
SenderName
|
SenderName | string |
Nom de l’expéditeur |
|
|
TemplateID
|
TemplateID | integer |
ID de modèle |
|
|
Titre
|
Title | string |
Titre |
|
|
ContactsListID
|
ContactsListID | string |
ID de liste de contacts |
|
|
ContactsListAlt
|
ContactsListAlt | string |
Alt de la liste de contacts |
|
|
Paramètres régionaux
|
Locale | True | string |
Paramètres régionaux |
|
SegmentationID
|
SegmentationID | integer |
Segmentation ID |
|
|
SegmentationAlt
|
SegmentationAlt | string |
Segmentation Alt |
|
|
Expéditeur
|
Sender | string |
Expéditeur |
|
|
SenderEmail
|
SenderEmail | string |
Adresse e-mail de l’expéditeur |
|
|
Sujet
|
Subject | True | string |
Sujet |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nombre
|
Count | integer |
Nombre |
|
Data
|
Data | array of CampaignDraftResponse |
Data |
|
Total
|
Total | integer |
Total |
Créer un contact
Ajouter un nouveau contact unique à votre liste de contacts globale et sélectionner son état d’exclusion
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
IsExcludedFromCampaigns
|
IsExcludedFromCampaigns | string |
Indique si le contact est ajouté à la liste d’exclusions pour les campagnes ou non |
|
|
Nom
|
Name | string |
Nom sélectionné par l’utilisateur pour ce contact |
|
|
Messagerie électronique
|
True | string |
Adresse e-mail du contact |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nombre
|
Count | integer |
Nombre |
|
Data
|
Data | array of ContactResponse |
Data |
|
Total
|
Total | integer |
Total |
Créer une liste de contacts
Créer une liste de contacts
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nom
|
Name | True | string |
Nom spécifié par l’utilisateur pour cette liste de contacts (doit être unique) |
|
IsDeleted
|
IsDeleted | boolean |
Lorsque la valeur est true, la liste de contacts est marquée comme supprimée |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nombre
|
Count | integer |
Nombre |
|
Data
|
Data | array of ContactsListResponse |
Data |
|
Total
|
Total | integer |
Total |
Envoyer un e-mail v3
Envoyer un e-mail via l’API d’envoi v3
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
À partir de l’e-mail
|
FromEmail | True | string |
À partir de l’e-mail |
|
Nom de l’expéditeur
|
FromName | string |
Nom de l’expéditeur |
|
|
Expéditeur
|
Sender | boolean |
Expéditeur |
|
|
Adresse e-mail de recettes
|
string |
Messagerie électronique |
||
|
Nom de la recette
|
Name | string |
Nom |
|
|
Pour envoyer un e-mail
|
To | True | string |
Pour envoyer un e-mail |
|
E-mail Cc
|
Cc | string |
E-mail Cc |
|
|
E-mail cci
|
Bcc | string |
E-mail cci |
|
|
Sujet
|
Subject | string |
Ligne d’objet de l’e-mail |
|
|
Composant texte
|
Text-part | string |
Composant texte |
|
|
Composant Html
|
Html-part | string |
Composant Html |
|
|
Filename
|
Filename | string |
Nom complet du fichier (y compris l’extension de fichier) |
|
|
Content-type
|
Content-type | string |
Définit le type de contenu envoyé à l’aide d’un type MIME |
|
|
Content
|
Content | string |
Contenu encodé en base64 du fichier joint |
|
|
Filename
|
Filename | string |
Filename |
|
|
Content-type
|
Content-type | string |
Content-type |
|
|
Content
|
Content | string |
Content |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Sent
|
Sent | array of object |
Sent |
|
Messagerie électronique
|
Sent.Email | string |
Messagerie électronique |
|
MessageID
|
Sent.MessageID | integer |
Message ID |
|
MessageUUID
|
Sent.MessageUUID | string |
Message UUID |
Envoyer un e-mail v3.1
Envoyer un e-mail via l’API d’envoi v3.1
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
À partir de l’e-mail
|
True | string |
Adresse e-mail From |
|
|
Nom de l’expéditeur
|
Name | string |
Nom de l’expéditeur |
|
|
Pour envoyer un e-mail
|
string |
Adresse e-mail du destinataire |
||
|
Pour nommer
|
Name | string |
Nom du destinataire |
|
|
Adresse e-mail de l’expéditeur
|
string |
Adresse e-mail utilisée pour envoyer le message |
||
|
Nom de l’expéditeur
|
Name | string |
Nom sélectionné par l’utilisateur pour l’adresse e-mail de l’expéditeur |
|
|
Adresse e-mail ReplyTo
|
string |
Adresse e-mail ReplyTo |
||
|
Nom replyTo
|
Name | string |
Nom replyTo |
|
|
E-mail Cc
|
string |
E-mail Cc |
||
|
Nom cc
|
Name | string |
Nom cc |
|
|
E-mail cci
|
string |
E-mail cci |
||
|
Nom du cci
|
Name | string |
Nom du cci |
|
|
Sujet
|
Subject | string |
Ligne d’objet de l’e-mail. |
|
|
TextPart
|
TextPart | string |
Fournit la partie Texte du message |
|
|
HTMLPart
|
HTMLPart | string |
Fournit la partie HTML du message. |
|
|
TemplateID
|
TemplateID | integer |
ID numérique unique du modèle à utiliser comme contenu de messagerie. |
|
|
Filename
|
Filename | string |
Nom complet du fichier (y compris l’extension de fichier) |
|
|
Content-type
|
Content-type | string |
Définit le type de contenu envoyé à l’aide d’un type MIME |
|
|
Content
|
Base64Content | string |
Contenu encodé en base64 du fichier joint |
|
|
SandboxMode
|
SandboxMode | boolean |
Mode bac à sable |
|
|
AdvanceErrorHandling
|
AdvanceErrorHandling | boolean |
Gestion avancée des erreurs |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Messages
|
Messages | array of object |
Messages |
|
Statut
|
Messages.Status | string |
Statut |
|
Errors
|
Messages.Errors | array of object |
Errors |
|
ErrorIdentifier
|
Messages.Errors.ErrorIdentifier | string |
Identificateur d’erreur |
|
ErrorCode
|
Messages.Errors.ErrorCode | string |
Code d’erreur |
|
StatusCode
|
Messages.Errors.StatusCode | integer |
Code de statut |
|
Message d'erreur
|
Messages.Errors.ErrorMessage | string |
Message d'erreur |
|
ErrorRelatedTo
|
Messages.Errors.ErrorRelatedTo | string |
Erreur liée à |
|
CustomID
|
Messages.CustomID | string |
ID personnalisé |
|
À
|
Messages.To | array of object |
À |
|
Messagerie électronique
|
Messages.To.Email | string |
Messagerie électronique |
|
MessageUUID
|
Messages.To.MessageUUID | string |
Message UUID |
|
MessageID
|
Messages.To.MessageID | integer |
Message ID |
|
MessageHref
|
Messages.To.MessageHref | string |
Message Href |
|
Cc
|
Messages.Cc | array of object |
Cc |
|
Messagerie électronique
|
Messages.Cc.Email | string |
Messagerie électronique |
|
MessageUUID
|
Messages.Cc.MessageUUID | string |
Message UUID |
|
MessageID
|
Messages.Cc.MessageID | integer |
Message ID |
|
MessageHref
|
Messages.Cc.MessageHref | string |
Message Href |
|
Bcc
|
Messages.Bcc | array of object |
Bcc |
|
Messagerie électronique
|
Messages.Bcc.Email | string |
Messagerie électronique |
|
MessageUUID
|
Messages.Bcc.MessageUUID | string |
Message UUID |
|
MessageID
|
Messages.Bcc.MessageID | integer |
Message ID |
|
MessageHref
|
Messages.Bcc.MessageHref | string |
Message Href |
Mettre à jour la liste des contacts
Mettre à jour une liste de contacts spécifique en modifiant son nom et/ou son état de suppression
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de liste
|
list_ID | True | string |
ID numérique unique attribué à cette liste de contacts |
|
Nom
|
Name | True | string |
Nom spécifié par l’utilisateur pour cette liste de contacts (doit être unique) |
|
IsDeleted
|
IsDeleted | boolean |
Lorsque la valeur est true, la liste de contacts est marquée comme supprimée |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nombre
|
Count | integer |
Nombre |
|
Data
|
Data | array of ContactsListResponse |
Data |
|
Total
|
Total | integer |
Total |
Mettre à jour le brouillon de campagne
Mettre à jour un brouillon de campagne existant
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID brouillon
|
draft_ID | True | integer |
ID numérique unique du brouillon de campagne que vous souhaitez mettre à jour |
|
Type de contenu
|
Content-Type | string |
Type de contenu |
|
|
En cours
|
Current | integer |
En cours |
|
|
Mode d’édition
|
EditMode | string |
Mode d’édition du brouillon de campagne. |
|
|
IsStarred
|
IsStarred | boolean |
Est en vedette |
|
|
IsTextPartIncluded
|
IsTextPartIncluded | boolean |
Composant Texte inclus |
|
|
ReplyEmail
|
ReplyEmail | string |
Adresse e-mail de réponse |
|
|
SenderName
|
SenderName | string |
Nom de l’expéditeur |
|
|
TemplateID
|
TemplateID | integer |
ID de modèle |
|
|
Titre
|
Title | string |
Titre |
|
|
ContactsListID
|
ContactsListID | string |
ID de liste de contacts |
|
|
ContactsListAlt
|
ContactsListAlt | string |
Alt de la liste de contacts |
|
|
Paramètres régionaux
|
Locale | True | string |
Paramètres régionaux |
|
SegmentationID
|
SegmentationID | integer |
Segmentation ID |
|
|
SegmentationAlt
|
SegmentationAlt | string |
Segmentation Alt |
|
|
Expéditeur
|
Sender | string |
Expéditeur |
|
|
SenderEmail
|
SenderEmail | string |
Adresse e-mail de l’expéditeur |
|
|
Sujet
|
Subject | True | string |
Sujet |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nombre
|
Count | integer |
Nombre |
|
Data
|
Data | array of CampaignDraftResponse |
Data |
|
Total
|
Total | integer |
Total |
Mettre à jour le contact
Mettre à jour le nom donné par l’utilisateur et l’état d’exclusion d’un contact spécifique
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Identifiant de contact
|
contact_ID | True | string |
ID numérique unique du contact que vous souhaitez mettre à jour |
|
IsExcludedFromCampaigns
|
IsExcludedFromCampaigns | boolean |
Indique si le contact est ajouté à la liste d’exclusions pour les campagnes ou non |
|
|
Nom
|
Name | string |
Nom sélectionné par l’utilisateur pour ce contact |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nombre
|
Count | integer |
Nombre |
|
Data
|
Data | array of ContactResponse |
Data |
|
Total
|
Total | integer |
Total |
Obtenir des contacts
Récupérez une liste de tous les contacts. Inclut des informations sur l’état du contact et la création / horodatages d’activité
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Campagne
|
Campaign | integer |
Récupère uniquement les contacts ciblés par cet ID de campagne |
|
|
ContactsList
|
ContactsList | integer |
Récupère uniquement les contacts qui font partie de cet ID de liste de contacts |
|
|
IsExcludedFromCampaigns
|
IsExcludedFromCampaigns | boolean |
Récupère uniquement les contacts qui ont été ajoutés à la liste d’exclusions pour les e-mails marketing |
|
|
Limit
|
Limit | integer |
Limiter la réponse à un nombre sélectionné d’objets retournés |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nombre
|
Count | integer |
Nombre |
|
Data
|
Data | array of ContactResponse |
Data |
|
Total
|
Total | integer |
Total |
Obtenir des données de contacts
Obtenir des informations sur tous les contacts et les valeurs de propriété associées
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Campagne
|
Campaign | integer |
Récupère une liste de valeurs de propriété de contact uniquement pour les contacts, qui ont reçu des e-mails de cet ID de campagne |
|
|
E-mail de contact
|
ContactEmail | string |
Récupère une liste de valeurs de propriété de contact uniquement pour le contact avec cette adresse e-mail |
|
|
ID de liste de contacts
|
ContactsList | integer |
Récupère une liste de valeurs de propriété de contact uniquement pour les contacts qui font partie de cet ID de liste de contacts |
|
|
Fields
|
Fields | string |
Plusieurs propriétés peuvent être spécifiées en les séparant par des virgules |
|
|
Dernière activité à
|
LastActivityAt | string |
Récupère une liste de valeurs de propriété de contact uniquement pour les contacts |
|
|
Limit
|
Limit | integer |
Limiter la réponse à un nombre sélectionné d’objets retournés |
|
|
Décalage
|
OffSet | integer |
Récupérer une liste d’objets à partir d’un certain décalage |
|
|
Nombre uniquement
|
countOnly | boolean |
Nombre de retours uniquement. |
|
|
Trier
|
Sort | string |
Spécifiez un nom de propriété pour ce paramètre de requête pour trier les objets dans Data |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nombre
|
Count | integer |
Nombre |
|
Data
|
Data | array of ContactDataResponse |
Data |
|
Total
|
Total | integer |
Total |
Obtenir des informations sur les messages
Récupérer les informations d’envoi/taille/courrier indésirable sur tous les messages
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
CampaignID
|
CampaignID | integer |
Récupère des informations uniquement sur les messages qui font partie de cette campagne |
|
|
ContactsList
|
ContactsList | integer |
Récupère uniquement des informations sur les messages envoyés à cette liste de contacts |
|
|
CustomCampaign
|
CustomCampaign | integer |
Récupère uniquement des informations sur les messages qui font partie d’une campagne avec l’ID personnalisé spécifié |
|
|
De
|
From | string |
Récupère des informations uniquement sur les messages envoyés à partir de l’adresse e-mail de l’expéditeur spécifié |
|
|
FromDomain
|
FromDomain | string |
Récupère des informations uniquement sur les messages envoyés à partir du domaine d’expéditeur spécifié |
|
|
FromID
|
FromID | integer |
Récupère des informations uniquement sur les messages envoyés à partir de l’ID d’expéditeur spécifié |
|
|
FromTS
|
FromTS | date-time |
Récupère uniquement les messages envoyés après l’horodatage spécifié |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nombre
|
Count | integer |
Nombre |
|
Data
|
Data | array of MessageInformationResponse |
Data |
|
Total
|
Total | integer |
Total |
Obtenir des listes de contacts
Récupérez les détails de toutes les listes de contacts : nom, nombre d’abonnés, horodatage de création, état de suppression.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Adresse
|
Address | string |
Récupère uniquement la liste de contacts avec l’adresse unique spécifiée créée par Mailjet. |
|
|
Exclure l’ID
|
ExcludeID | integer |
Exclut la liste de contacts avec l’ID spécifié de la réponse. |
|
|
Est-ce que la suppression est supprimée ?
|
IsDeleted | boolean |
Lorsque la valeur est true, récupère uniquement les listes supprimées. Lorsque la valeur est false, récupère les listes qui ne sont pas supprimées. |
|
|
Nom
|
Name | string |
Récupère uniquement la liste avec le nom sélectionné par l’utilisateur spécifié. |
|
|
Limit
|
Limit | integer |
Limitez la réponse à un nombre sélectionné d’objets retournés. |
|
|
Décalage
|
OffSet | integer |
Récupérez une liste d’objets à partir d’un certain décalage. |
|
|
Nombre uniquement
|
countOnly | boolean |
Retourne les lignes de nombre uniquement ou non. |
|
|
Trier
|
Sort | string |
Spécifiez un nom de propriété pour ce paramètre de requête pour trier les objets dans Data. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nombre
|
Count | integer |
Nombre |
|
Data
|
Data | array of ContactsListResponse |
Data |
|
Total
|
Total | integer |
Total |
Obtenir des statistiques de contacts
Récupérer une liste des statistiques globales de remise et d’engagement agrégées, regroupées par contact
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nombre
|
Count | integer |
Nombre |
|
Data
|
Data | array of object |
Data |
|
BlockedCount
|
Data.BlockedCount | integer |
Nombre bloqué |
|
BouncedCount
|
Data.BouncedCount | integer |
Nombre de rebonds |
|
ClickedCount
|
Data.ClickedCount | integer |
Nombre cliqué |
|
ContactID
|
Data.ContactID | integer |
Identifiant de contact |
|
DeferredCount
|
Data.DeferredCount | integer |
Nombre différé |
|
DeliveredCount
|
Data.DeliveredCount | integer |
Nombre livré |
|
HardbouncedCount
|
Data.HardbouncedCount | integer |
Nombre hardbounced |
|
LastActivityAt
|
Data.LastActivityAt | date-time |
Dernière activité à |
|
MarketingContacts
|
Data.MarketingContacts | integer |
Marketing Contacts |
|
OpenedCount
|
Data.OpenedCount | integer |
Nombre ouvert |
|
ProcessedCount
|
Data.ProcessedCount | integer |
Nombre traité |
|
QueuedCount
|
Data.QueuedCount | integer |
Nombre mis en file d’attente |
|
SoftbouncedCount
|
Data.SoftbouncedCount | integer |
Nombre de rebonds doux |
|
SpamComplaintCount
|
Data.SpamComplaintCount | integer |
Nombre de plaintes contre le courrier indésirable |
|
UnsubscribedCount
|
Data.UnsubscribedCount | integer |
Nombre d’annulations |
|
UserMarketingContacts
|
Data.UserMarketingContacts | integer |
Contacts marketing utilisateur |
|
WorkFlowExitedCount
|
Data.WorkFlowExitedCount | integer |
Nombre de sorties WorkFlow |
|
Total
|
Total | integer |
Total |
Obtenir la liste des contacts par ID
Récupérez les détails d’une liste de contacts spécifique : nom, nombre d’abonnés, horodatage de création, état de suppression.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID numérique unique
|
list_ID | True | string |
ID numérique unique attribué à cette liste de contacts. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nombre
|
Count | integer |
Nombre |
|
Data
|
Data | array of ContactsListResponse |
Data |
|
Total
|
Total | integer |
Total |
Obtenir le brouillon de campagne par ID
Obtenir un brouillon de campagne spécifique et ses détails de configuration
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID brouillon
|
draft_ID | True | integer |
ID numérique unique du brouillon de campagne que vous souhaitez récupérer. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nombre
|
Count | integer |
Nombre |
|
Data
|
Data | array of CampaignDraftResponse |
Data |
|
Total
|
Total | integer |
Total |
Obtenir le brouillon des campagnes
Obtenir tous les brouillons de campagne et leur configuration
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nombre
|
Count | integer |
Nombre |
|
Data
|
Data | array of CampaignDraftResponse |
Data |
|
Total
|
Total | integer |
Total |
Obtenir les données de contact par ID
Récupérer toutes les propriétés et valeurs respectives associées à un contact spécifique
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Identifiant de contact
|
contactID | True | integer |
ID numérique unique pour le contact, dont vous souhaitez récupérer les propriétés |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nombre
|
Count | integer |
Nombre |
|
Data
|
Data | array of ContactDataResponse |
Data |
|
Total
|
Total | integer |
Total |
Obtenir un contact par ID
Récupérer un contact spécifique
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Identifiant de contact
|
contact_ID | True | string |
ID numérique unique du contact que vous souhaitez récupérer |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nombre
|
Count | integer |
Nombre |
|
Data
|
Data | array of ContactResponse |
Data |
|
Total
|
Total | integer |
Total |
Recevoir des messages
Obtenir une liste de messages avec des informations spécifiques sur le type de contenu, de suivi, d’envoi et de remise
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Contact
|
Contact | integer |
Récupère uniquement les messages envoyés à l’ID de contact spécifié |
|
|
CustomID
|
CustomID | integer |
Récupère uniquement les messages marqués avec le CustomID spécifié |
|
|
Destination
|
Destination | integer |
Récupère uniquement les messages envoyés à l’ID de destination spécifié |
|
|
FromTS
|
FromTS | date-time |
Récupère uniquement les messages envoyés après l’horodatage spécifié |
|
|
Limit
|
Limit | integer |
Limiter la réponse à un nombre sélectionné d’objets retournés |
|
|
FromType
|
FromType | integer |
|
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nombre
|
Count | integer |
Nombre |
|
Data
|
Data | array of MessageResponse |
Data |
|
Total
|
Total | integer |
Total |
Supprimer la liste des contacts
Supprimer une liste de contacts
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de liste
|
list_ID | True | string |
ID de liste |
Vue d’ensemble de la campagne
Obtenir des détails généraux et des statistiques pour tous les brouillons, objets AB Testing et/ou campagnes envoyées
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nombre
|
Count | integer |
Nombre |
|
Data
|
Data | array of object |
Data |
|
ClickedCount
|
Data.ClickedCount | integer |
Nombre cliqué |
|
DeliveredCount
|
Data.DeliveredCount | integer |
Nombre livré |
|
EditMode
|
Data.EditMode | string |
Mode d’édition |
|
EditType
|
Data.EditType | string |
Modifier le type |
|
ID
|
Data.ID | integer |
ID |
|
IDType
|
Data.IDType | string |
Type d’ID |
|
OpenedCount
|
Data.OpenedCount | integer |
Nombre ouvert |
|
ProcessedCount
|
Data.ProcessedCount | integer |
Nombre traité |
|
SendTimeStart
|
Data.SendTimeStart | integer |
Début de l’heure d’envoi |
|
Joué
|
Data.Starred | boolean |
Joué |
|
Statut
|
Data.Status | integer |
Statut |
|
Sujet
|
Data.Subject | string |
Sujet |
|
Titre
|
Data.Title | string |
Titre |
|
Total
|
Total | integer |
Total |
Définitions
MessageResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ArrivéAt
|
ArrivedAt | string |
Arrivé à |
|
Nombre de pièces jointes
|
AttachmentCount | integer |
Nombre de pièces jointes |
|
AttemptCount
|
AttemptCount | integer |
Nombre de tentatives |
|
CampaignID
|
CampaignID | integer |
ID de campagne |
|
ContactAlt
|
ContactAlt | string |
Contact Alt |
|
ContactID
|
ContactID | integer |
Identifiant de contact |
|
Delay
|
Delay | number |
Delay |
|
DESTINATIONID
|
DestinationID | integer |
Destination ID |
|
FilterTime
|
FilterTime | integer |
Heure du filtre |
|
ID
|
ID | integer |
ID |
|
IsClickTracked
|
IsClickTracked | boolean |
Cliquez sur Suivi |
|
IsHTMLPartIncluded
|
IsHTMLPartIncluded | boolean |
Composant HTML inclus |
|
IsOpenTracked
|
IsOpenTracked | boolean |
Est ouvert suivi |
|
IsTextPartIncluded
|
IsTextPartIncluded | boolean |
Composant Texte inclus |
|
IsUnsubTracked
|
IsUnsubTracked | boolean |
Is Unsubscription Tracked |
|
MessageSize
|
MessageSize | integer |
Taille du message |
|
SenderID
|
SenderID | integer |
ID de l’expéditeur |
|
SpamassassinScore
|
SpamassassinScore | number |
Spamassassin Score |
|
SpamassRules
|
SpamassRules | string |
Règles de spamass |
|
StateID
|
StateID | integer |
ID d’état |
|
StatePermanent
|
StatePermanent | boolean |
État permanent |
|
Statut
|
Status | string |
Statut |
|
Sujet
|
Subject | string |
Sujet |
|
UUID (Identifiant Unique Universel)
|
UUID | string |
UUID (Identifiant Unique Universel) |
MessageInformationResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
CampaignID
|
CampaignID | integer |
ID de campagne |
|
ClickTrackedCount
|
ClickTrackedCount | integer |
Cliquez sur Nombre suivi |
|
ContactID
|
ContactID | integer |
Identifiant de contact |
|
CreatedAt
|
CreatedAt | date-time |
Créé à |
|
ID
|
ID | integer |
ID |
|
MessageSize
|
MessageSize | integer |
Taille du message |
|
OpenTrackedCount
|
OpenTrackedCount | integer |
Ouvrir le nombre suivi |
|
QueuedCount
|
QueuedCount | integer |
Nombre mis en file d’attente |
|
SendEndAt
|
SendEndAt | string |
Envoyer à la fin |
|
SentCount
|
SentCount | integer |
Nombre envoyé |
|
SpamAssassinScore
|
SpamAssassinScore | number |
Score d’assassin de courrier indésirable |
ContactResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
IsExcludedFromCampaigns
|
IsExcludedFromCampaigns | boolean |
Est exclu deCampaigns |
|
Nom
|
Name | string |
Nom |
|
CreatedAt
|
CreatedAt | date-time |
Créé à |
|
DeliveredCount
|
DeliveredCount | integer |
Nombre livré |
|
Messagerie électronique
|
string |
Messagerie électronique |
|
|
ExclusionFromCampaignsUpdatedAt
|
ExclusionFromCampaignsUpdatedAt | string |
Exclusion des campagnes mises à jour à l’adresse |
|
ID
|
ID | integer |
ID |
|
IsOptInPending
|
IsOptInPending | boolean |
OptIn en attente |
|
IsSpamComplaining
|
IsSpamComplaining | boolean |
Se plaindre du courrier indésirable |
|
LastActivityAt
|
LastActivityAt | date-time |
Dernière activité à |
|
LastUpdateAt
|
LastUpdateAt | date-time |
Dernière mise à jour à l’adresse |
ContactsListResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nom
|
Name | string |
Nom |
|
Adresse
|
Address | string |
Adresse |
|
CreatedAt
|
CreatedAt | date-time |
Créé à |
|
ID
|
ID | integer |
ID |
|
SubscriberCount
|
SubscriberCount | integer |
Nombre d’abonnés |
CampaignDraftResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
AXFraction
|
AXFraction | integer |
AX Fraction |
|
AXFractionName
|
AXFractionName | string |
Nom de fraction AX |
|
AXTesting
|
AXTesting | string |
Test AX |
|
En cours
|
Current | integer |
En cours |
|
EditMode
|
EditMode | string |
Mode d’édition |
|
IsStarred
|
IsStarred | boolean |
Est en vedette |
|
IsTextPartIncluded
|
IsTextPartIncluded | boolean |
TextPart inclus |
|
ReplyEmail
|
ReplyEmail | string |
Adresse e-mail de réponse |
|
SenderName
|
SenderName | string |
Nom de l’expéditeur |
|
TemplateID
|
TemplateID | integer |
ID de modèle |
|
Titre
|
Title | string |
Titre |
|
CampaignID
|
CampaignID | integer |
ID de campagne |
|
ContactsListID
|
ContactsListID | integer |
ID de liste de contacts |
|
CreatedAt
|
CreatedAt | date-time |
Créé à |
|
DeliveredAt
|
DeliveredAt | date-time |
Livré à |
|
ID
|
ID | integer |
ID |
|
Paramètres régionaux
|
Locale | string |
Paramètres régionaux |
|
ModifiedAt
|
ModifiedAt | date-time |
Modifié à |
|
Preset
|
Preset | string |
Preset |
|
SegmentationID
|
SegmentationID | integer |
Segmentation ID |
|
Expéditeur
|
Sender | string |
Expéditeur |
|
SenderEmail
|
SenderEmail | string |
Adresse e-mail de l’expéditeur |
|
Statut
|
Status | integer |
Statut |
|
Sujet
|
Subject | string |
Sujet |
|
URL
|
Url | string |
URL |
|
Utilisé
|
Used | boolean |
Utilisé |
ContactDataResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ContactID
|
ContactID | integer |
ID numérique unique pour ce contact |
|
Data
|
Data | array of |
Tableau JSON contenant des propriétés de contact et leurs valeurs |
|
ID
|
ID | integer |
ID numérique unique pour l’objet Data de ce contact |
|
MethodCollection
|
MethodCollection | string |
MethodCollection |