Courier (Éditeur indépendant) (préversion)
Courier est un service et un studio web pour les équipes de développement pour gérer toutes les communications déclenchées par le produit (e-mail, conversation, in-app, SMS, push, etc.) en un seul endroit. Courier est conçu pour les développeurs qui souhaitent offrir une expérience de notification exceptionnelle.
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 |
| Site internet | https://www.courier.com/ |
| Politique de confidentialité | https://www.courier.com/privacy/ |
| Catégories | Communication; Réseaux sociaux |
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 |
|---|---|---|---|
| Jeton (sous la forme « Porteur yourToken ») | securestring | Jeton (sous la forme « Bearer yourToken ») pour cette API | Vrai |
Limitations
| Nom | Appels | Période de renouvellement |
|---|---|---|
| Appels d’API par connexion | 100 | 60 secondes |
Actions
| Ajouter des abonnés à une liste |
Ajoutez des abonnés supplémentaires à une liste. |
| Ajouter des utilisateurs à un travail en bloc |
Ingérer des données utilisateur dans un travail en bloc. |
| Archiver un message |
Demandez qu’un message soit archivé. |
| Créer ou mettre à jour une audience |
Crée ou met à jour un public en fonction des paramètres et des filtres fournis. |
| Créer un profil |
Fusionnez les valeurs fournies avec un profil existant ou créez un profil s’il n’en existe pas déjà. |
| Créer un travail en bloc |
Crée un travail en bloc pour les paramètres de message fournis. |
| Créer une marque |
Crée une marque à partir des paramètres fournis. |
| Désabonner un utilisateur d’une liste |
Supprime un abonnement à une liste par liste et identificateurs de destinataire. |
| Envoyer un message |
Envoie un message à un ou plusieurs destinataires. |
| Exécuter un travail en bloc |
Commencez à exécuter un travail en bloc. |
| Exécuter une automatisation ad hoc |
Appelez une automatisation dans une exécution ad hoc. |
| Exécuter une automatisation avec modèle |
Appelez une exécution d’automatisation à partir d’un modèle Automation. |
| Mettre à jour un profil |
Mises à jour sur une partie d’un profil. |
| Mettre à jour une liste |
Crée ou remplace une liste existante par les valeurs fournies. |
| Obtenir le contenu d’un message |
Récupérez le contenu d’un message précédemment envoyé. |
| Obtenir les abonnements de la liste |
Récupère les abonnements d’une liste. |
| Obtenir les utilisateurs d’un travail en bloc |
Récupérez les utilisateurs d’un travail en bloc. |
| Obtenir l’historique d’un message |
Récupérez les événements d’un message précédemment envoyé. |
| Obtenir tous les événements d’audit |
Récupérez une liste d’événements d’audit. |
| Obtenir toutes les listes de destinataires |
Récupérez une liste de toutes les listes de destinataires. |
| Obtenir un message |
Récupérez l’état d’un message. |
| Obtenir un profil |
Récupère le profil de destinataire spécifié. |
| Obtenir un public |
Retourne l’audience spécifiée par identificateur. |
| Obtenir un travail en bloc |
Récupérez les informations relatives à un travail en bloc. |
| Obtenir un événement d’audit |
Récupérez un événement d’audit spécifique par identificateur. |
| Obtenir une liste |
Récupérez les éléments d’une liste. |
| Obtenir une marque |
Récupérez une marque spécifique par identificateur. |
| Restaurer une liste |
Restaure une liste existante par identificateur. |
| Répertorier des messages |
Récupérez les états des messages précédemment envoyés. |
| Répertorier les marques |
Récupérez une liste de marques. |
| Répertorier les membres de l’audience |
Récupérez une liste de membres d’une audience. |
| Répertorier les notifications |
Récupère une liste de notifications. |
| Répertorier toutes les audiences |
Récupérez toutes les audiences associées à votre compte. |
| Supprimer un profil |
Supprime le profil de destinataire spécifié. |
| Supprimer un public |
Supprime l’audience de destinataire spécifiée. |
| Supprimer une liste |
Supprime une liste par identificateur de liste. |
Ajouter des abonnés à une liste
Ajoutez des abonnés supplémentaires à une liste.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de liste
|
list_id | True | string |
Identificateur de liste. |
|
ID du destinataire
|
recipientId | string |
Identificateur du destinataire. |
Retours
- response
- string
Ajouter des utilisateurs à un travail en bloc
Ingérer des données utilisateur dans un travail en bloc.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID du travail
|
job_id | True | string |
L’identificateur de la tâche. |
|
Recipient
|
recipient | string |
Destinataire. |
Retours
- response
- string
Archiver un message
Demandez qu’un message soit archivé.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Demande d'ID
|
request_id | True | string |
Identificateur de la demande. |
Retours
- response
- string
Créer ou mettre à jour une audience
Crée ou met à jour un public en fonction des paramètres et des filtres fournis.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’audience
|
audience_id | True | string |
Identificateur de l’audience. |
|
Nom
|
name | string |
Nom. |
|
|
Chemin
|
path | string |
Chemin d’accès. |
|
|
Operator
|
operator | string |
Opérateur. |
|
|
Valeur
|
value | string |
Valeur. |
|
|
Chemin
|
path | string |
Chemin d’accès. |
|
|
Operator
|
operator | string |
Opérateur. |
|
|
Valeur
|
value | string |
Valeur. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
Identificateur. |
|
Nom
|
name | string |
Nom. |
|
Descriptif
|
description | string |
Description. |
|
Operator
|
filter.operator | string |
Opérateur. |
|
Valeur
|
filter.value | string |
Valeur. |
|
Chemin
|
filter.path | string |
Chemin d’accès. |
|
Filtres
|
filter.filters | array of object | |
|
Chemin
|
filter.filters.path | string |
Chemin d’accès. |
|
Operator
|
filter.filters.operator | string |
Opérateur. |
|
Valeur
|
filter.filters.value | string |
Valeur. |
Créer un profil
Fusionnez les valeurs fournies avec un profil existant ou créez un profil s’il n’en existe pas déjà.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID du destinataire
|
recipient_id | True | string |
Identificateur du destinataire. |
|
Messagerie électronique
|
string |
Adresse e-mail. |
||
|
Numéro de téléphone
|
phone_number | string |
Numéro de téléphone. |
|
|
Formaté
|
formatted | string |
Adresse mise en forme. |
|
|
Adresse de rue
|
street_address | string |
Adresse postale. |
|
|
Localité
|
locality | string |
Localité. |
|
|
Région
|
region | string |
Région |
|
|
Code postal
|
postal_code | string |
Code postal. |
|
|
Pays
|
country | string |
Le pays. |
|
|
Date de naissance
|
birthdate | string |
Date de naissance. |
|
|
E-mail vérifié
|
email_verified | boolean |
Indique si l’e-mail a été vérifié. |
|
|
Numéro de téléphone vérifié
|
phone_number_verified | boolean |
Indique si le numéro de téléphone a été vérifié. |
|
|
Prénom
|
given_name | string |
Nom donné. |
|
|
Deuxième prénom
|
middle_name | string |
Le prénom. |
|
|
Nom de famille
|
family_name | string |
Nom de la famille. |
|
|
Nom préféré
|
preferred_name | string |
Nom préféré. |
|
|
Gender
|
gender | string |
Le genre. |
|
|
Paramètres régionaux
|
locale | string |
Paramètres régionaux. |
|
|
Image
|
picture | string |
L’image. |
|
|
Profil
|
profile | string |
Profil. |
|
|
Sub
|
sub | string |
Sous-élément. |
|
|
Mise à jour à
|
updated_at | string |
Lorsqu’il est mis à jour à l’adresse. |
|
|
Site internet
|
website | string |
Le site web. |
|
|
Informations sur la zone
|
zoneinfo | string |
Informations sur la zone. |
|
|
Utilisateur nommé
|
named_user | string |
Utilisateur nommé. |
|
|
Types d’appareils
|
device_types | array of string |
Types d’appareils. |
|
|
APN
|
apn | string |
The APN. |
|
|
ARN cible
|
target_arn | string |
ARN cible. |
|
|
ID de canal
|
channel_id | string |
Identificateur de canal. |
|
|
ID d’utilisateur
|
user_id | string |
Identificateur de l’utilisateur. |
|
|
Jeton
|
token | string |
Jeton. |
|
|
Tokens
|
tokens | array of string |
Jetons. |
|
|
Facebook PS ID
|
facebookPSID | string |
Identificateur du PS Facebook. |
|
|
Jeton Firebase
|
firebaseToken | string |
Jeton Firebase. |
|
|
De
|
from | string |
De. |
|
|
ID
|
id | string |
Identificateur. |
|
|
ID d’utilisateur
|
user_id | string |
Identificateur de l’utilisateur. |
|
|
ID de conversation
|
conversation_id | string |
Identificateur de conversation. |
|
|
ID du locataire
|
tenant_id | string |
Identificateur du locataire. |
|
|
Service URL
|
service_url | string |
Adresse d’URL du service. |
|
|
ID du lecteur OneSignal
|
oneSignalPlayerID | string |
Identificateur oneSignal Player. |
|
|
Jeton d'accès
|
access_token | string |
Jeton d’accès. |
|
|
Canal
|
channel | string |
Canal. |
|
|
Messagerie électronique
|
string |
Adresse e-mail. |
||
|
ID d’utilisateur
|
user_id | string |
Identificateur de l’utilisateur. |
|
|
URL
|
url | string |
Adresse URL. |
|
|
URL
|
url | string |
Adresse URL. |
|
|
Méthode
|
method | string |
Méthodes. |
|
|
Mode
|
mode | string |
Mode. |
|
|
Nom d’utilisateur
|
username | string |
Nom d’utilisateur. |
|
|
Mot de passe
|
password | string |
Mot de passe. |
|
|
Jeton
|
token | string |
Jeton. |
|
|
Profil
|
profile | string |
Profil. |
Retours
- response
- string
Créer un travail en bloc
Crée un travail en bloc pour les paramètres de message fournis.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Événement
|
event | string |
Événement. |
|
|
Marque
|
brand | string |
La marque. |
|
|
Template
|
template | string |
Modèle. |
|
|
ID de marque
|
brand_id | string |
Identificateur de marque. |
|
|
Méthode
|
method | string |
Méthode. |
|
|
Canaux
|
channels | array of string |
Canaux. |
|
|
Événement
|
event | string |
Événement. |
|
|
Étiquettes
|
tags | array of string |
Balises. |
|
|
Trace ID
|
trace_id | string |
Identificateur de trace. |
|
|
Campagne
|
campaign | string |
La campagne. |
|
|
Content
|
content | string |
Contenu. |
|
|
Moyen
|
medium | string |
Le moyen. |
|
|
Origine
|
source | string |
Source. |
|
|
Terme
|
term | string |
Le terme. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID du travail
|
jobId | string |
L’identificateur de la tâche. |
Créer une marque
Crée une marque à partir des paramètres fournis.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID
|
id | string |
Identificateur. |
|
|
Nom
|
name | True | string |
Nom. |
|
Primary
|
primary | string |
Principal. |
|
|
Secondary
|
secondary | string |
Secondaire. |
|
|
Tertiaire
|
tertiary | string |
Le tertiaire. |
|
|
Couleur de la barre
|
barColor | string |
Couleur de la barre. |
|
|
HREF
|
href | string |
The HREF. |
|
|
Image
|
image | string |
Image. |
|
|
Markdown
|
markdown | string |
Markdown. |
|
|
URL
|
url | string |
Adresse URL. |
|
|
URL
|
url | string |
Adresse URL. |
|
|
URL
|
url | string |
Adresse URL. |
|
|
URL
|
url | string |
Adresse URL. |
|
|
URL
|
url | string |
Adresse URL. |
|
|
Icône Désactiver le message
|
disableMessageIcon | boolean |
Indique s’il faut désactiver l’icône de message. |
|
|
Sélection élective
|
placement | string |
Placement. |
|
|
Objets
|
items | array of string |
Éléments. |
Retours
- response
- string
Désabonner un utilisateur d’une liste
Supprime un abonnement à une liste par liste et identificateurs de destinataire.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de liste
|
list_id | True | string |
Identificateur de liste. |
|
ID du destinataire
|
recipient_id | True | string |
Identificateur du destinataire. |
Retours
- response
- string
Envoyer un message
Envoie un message à un ou plusieurs destinataires.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Idempotence
|
idempotency | True | string |
Clé d’idempotency. |
|
Titre
|
title | string |
Titre. |
|
|
Corps
|
body | string |
Le corps. |
|
|
ID d’utilisateur
|
user_id | string |
Identificateur de l’utilisateur. |
|
|
ID de liste
|
list_id | string |
Identificateur de liste. |
|
|
ID d’audience
|
audience_id | string |
Identificateur de l’audience. |
|
|
Messagerie électronique
|
string |
Adresse e-mail. |
||
|
Numéro de téléphone
|
phone_number | string |
Numéro de téléphone. |
|
|
Paramètres régionaux
|
locale | string |
Paramètres régionaux. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Demande d'ID
|
requestId | string |
Identificateur de la demande. |
Exécuter un travail en bloc
Commencez à exécuter un travail en bloc.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID du travail
|
job_id | True | string |
L’identificateur de la tâche. |
Retours
- response
- object
Exécuter une automatisation ad hoc
Appelez une automatisation dans une exécution ad hoc.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton d’annulation
|
cancelation_token | string |
Jeton d’annulation. |
|
|
Marque
|
brand | string |
La marque. |
|
|
Template
|
template | string |
Modèle. |
|
|
Recipient
|
recipient | string |
Destinataire. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID d’exécution
|
runId | string |
L’identificateur de l'exécution. |
Exécuter une automatisation avec modèle
Appelez une exécution d’automatisation à partir d’un modèle Automation.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de modèle
|
templateId | True | string |
Identificateur du modèle. |
|
Marque
|
brand | string |
La marque. |
|
|
Template
|
template | string |
Modèle. |
|
|
Recipient
|
recipient | string |
Destinataire. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID d’exécution
|
runId | string |
L’identificateur de l'exécution. |
Mettre à jour un profil
Mises à jour sur une partie d’un profil.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID du destinataire
|
recipient_id | True | string |
Identificateur du destinataire. |
|
Opération
|
op | string |
Opération. |
|
|
Chemin
|
path | string |
Chemin d’accès. |
|
|
Valeur
|
value | string |
Valeur. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Statut
|
status | string |
État. |
Mettre à jour une liste
Crée ou remplace une liste existante par les valeurs fournies.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de liste
|
list_id | True | string |
Identificateur de liste. |
|
Nom
|
name | string |
Nom. |
Retours
- response
- string
Obtenir le contenu d’un message
Récupérez le contenu d’un message précédemment envoyé.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Message ID
|
message_id | True | string |
Identificateur du message. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Canal
|
results.channel | string |
Canal. |
|
ID de canal
|
results.channel_id | string |
Identificateur de canal. |
|
HTML
|
results.content.html | string |
The HTML. |
|
Sujet
|
results.content.subject | string |
Objet. |
|
Texto
|
results.content.text | string |
Texte. |
|
Blocs
|
results.content.blocks | array of object | |
|
Type
|
results.content.blocks.type | string |
Type. |
|
Texto
|
results.content.blocks.text | string |
Texte. |
Obtenir les abonnements de la liste
Récupère les abonnements d’une liste.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de liste
|
list_id | True | string |
Identificateur de liste. |
|
Cursor
|
cursor | string |
Curseur. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Cursor
|
paging.cursor | string |
Curseur. |
|
More
|
paging.more | boolean |
S’il y en a plus. |
|
Objets
|
items | array of object | |
|
ID du destinataire
|
items.recipientId | string |
Identificateur du destinataire. |
|
Créé
|
items.created | string |
Lors de la création. |
Obtenir les utilisateurs d’un travail en bloc
Récupérez les utilisateurs d’un travail en bloc.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID du travail
|
job_id | True | string |
L’identificateur de la tâche. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
items | array of object | |
|
Recipient
|
items.recipient | string |
Destinataire. |
|
Messagerie électronique
|
items.email | string |
Adresse e-mail. |
|
Paramètres régionaux
|
items.locale | string |
Paramètres régionaux. |
|
Cursor
|
paging.cursor | string |
Curseur. |
|
More
|
paging.more | boolean |
S’il y en a plus. |
Obtenir l’historique d’un message
Récupérez les événements d’un message précédemment envoyé.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Message ID
|
message_id | True | string |
Identificateur du message. |
|
Type
|
type | string |
Type. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Nom
|
results.data.name | string |
Nom. |
|
Événement
|
results.event | string |
Événement. |
|
Recipient
|
results.recipient | string |
Destinataire. |
|
TS
|
results.ts | integer |
The TS. |
|
Type
|
results.type | string |
Type. |
|
ID de l’événement
|
results.event_id | string |
Identificateur d’événement. |
|
Notification ID
|
results.notification_id | string |
Identificateur de notification. |
|
ID
|
results.channel.id | string |
Identificateur. |
|
ID
|
results.integration.id | string |
Identificateur. |
|
Provider
|
results.integration.provider | string |
Fournisseur. |
Obtenir tous les événements d’audit
Récupérez une liste d’événements d’audit.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Cursor
|
cursor | string |
Curseur. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Cursor
|
paging.cursor | string |
Curseur. |
|
More
|
paging.more | boolean |
S’il y en a plus. |
|
Results
|
results | array of object | |
|
ID d’événement d’audit
|
results.auditEventId | string |
Identificateur d’événement d’audit. |
|
ID
|
results.actor.id | string |
Identificateur. |
|
Messagerie électronique
|
results.actor.email | string |
Adresse e-mail. |
|
ID
|
results.target.id | string |
Identificateur. |
|
Messagerie électronique
|
results.target.email | string |
Adresse e-mail. |
|
Origine
|
results.source | string |
Source. |
|
Timestamp
|
results.timestamp | string |
Horodatage. |
|
Type
|
results.type | string |
Type. |
Obtenir toutes les listes de destinataires
Récupérez une liste de toutes les listes de destinataires.
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Cursor
|
paging.cursor | string |
Curseur. |
|
More
|
paging.more | boolean |
S’il y en a plus. |
|
Results
|
results | array of object | |
|
Créé
|
results.created | string |
Lors de la création. |
|
ID
|
results.id | string |
Identificateur. |
|
Nom
|
results.name | string |
Nom. |
|
Updated
|
results.updated | string |
En cas de mise à jour. |
Obtenir un message
Récupérez l’état d’un message.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Message ID
|
message_id | True | string |
Identificateur du message. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
Identificateur. |
|
Statut
|
status | string |
État. |
|
Mis en file d’attente
|
enqueued | integer |
Mis en file d’attente. |
|
Sent
|
sent | integer |
Envoyé. |
|
Livré
|
delivered | integer |
Livré. |
|
Ouvert
|
opened | integer |
Ouvert. |
|
Cliqué
|
clicked | integer |
Cliquez dessus. |
|
Recipient
|
recipient | string |
Destinataire. |
|
Événement
|
event | string |
Événement. |
|
Notification
|
notification | string |
Notification. |
|
Erreur
|
error | string |
Erreur. |
|
Reason
|
reason | string |
La raison. |
|
Providers
|
providers | array of object | |
|
Sent
|
providers.sent | integer |
Envoyé. |
|
Livré
|
providers.delivered | integer |
Livré. |
|
Cliqué
|
providers.clicked | integer |
Cliquez dessus. |
|
Ouvert
|
providers.opened | integer |
Ouvert. |
|
Erreur
|
providers.error | string |
Erreur. |
|
Provider
|
providers.provider | string |
Fournisseur. |
|
Statut
|
providers.status | string |
État. |
Obtenir un profil
Récupère le profil de destinataire spécifié.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID du destinataire
|
recipient_id | True | string |
Identificateur du destinataire. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Messagerie électronique
|
profile.email | string |
Adresse e-mail. |
|
Numéro de téléphone
|
profile.phone_number | string |
Numéro de téléphone. |
Obtenir un public
Retourne l’audience spécifiée par identificateur.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’audience
|
audience_id | True | string |
Identificateur de l’audience. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
Identificateur. |
|
Nom
|
name | string |
Nom. |
|
Descriptif
|
description | string |
Description. |
|
Operator
|
filter.operator | string |
Opérateur. |
|
Valeur
|
filter.value | string |
Valeur. |
|
Chemin
|
filter.path | string |
Chemin d’accès. |
Obtenir un travail en bloc
Récupérez les informations relatives à un travail en bloc.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID du travail
|
job_id | True | string |
L’identificateur de la tâche. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Événement
|
job.definition.event | string |
Événement. |
|
Mis en file d’attente
|
job.enqueued | integer |
Mis en file d’attente. |
|
Échecs
|
job.failures | integer |
Échecs. |
|
Reçu
|
job.received | integer |
Lorsqu’elle est reçue. |
|
Statut
|
job.status | string |
État. |
Obtenir un événement d’audit
Récupérez un événement d’audit spécifique par identificateur.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’événement d’audit
|
audit-event-id | True | string |
Identificateur d’événement d’audit. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID d’événement d’audit
|
auditEventId | string |
Identificateur d’événement d’audit. |
|
ID
|
actor.id | string |
Identificateur. |
|
Messagerie électronique
|
actor.email | string |
Adresse e-mail. |
|
ID
|
target.id | string |
Identificateur. |
|
Messagerie électronique
|
target.email | string |
Adresse e-mail. |
|
Origine
|
source | string |
Source. |
|
Timestamp
|
timestamp | string |
Horodatage. |
|
Type
|
type | string |
Type. |
Obtenir une liste
Récupérez les éléments d’une liste.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de liste
|
list_id | True | string |
Identificateur de liste. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Créé
|
created | string |
Lors de la création. |
|
ID
|
id | string |
Identificateur. |
|
Nom
|
name | string |
Nom. |
|
Updated
|
updated | string |
Mise à jour. |
Obtenir une marque
Récupérez une marque spécifique par identificateur.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de marque
|
brand_id | True | string |
Identificateur de marque. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Créé
|
created | integer |
Lors de la création. |
|
ID
|
id | string |
Identificateur. |
|
Nom
|
name | string |
Nom. |
|
Publiée
|
published | integer |
Lorsqu’il est publié. |
|
Updated
|
updated | integer |
Mise à jour. |
|
Version
|
version | string |
Version. |
|
Primary
|
settings.colors.primary | string |
Principal. |
|
Secondary
|
settings.colors.secondary | string |
Secondaire. |
|
Tertiaire
|
settings.colors.tertiary | string |
Le tertiaire. |
|
Couleur de la barre
|
settings.email.header.barColor | string |
Couleur de la barre. |
|
HREF
|
settings.email.header.logo.href | string |
The HREF. |
|
Image
|
settings.email.header.logo.image | string |
Image. |
|
Markdown
|
settings.email.footer.markdown | string |
Markdown. |
|
URL
|
settings.email.footer.social.facebook.url | string |
Adresse URL. |
|
URL
|
settings.email.footer.social.instagram.url | string |
Adresse URL. |
|
URL
|
settings.email.footer.social.linkedin.url | string |
Adresse URL. |
|
URL
|
settings.email.footer.social.medium.url | string |
Adresse URL. |
|
URL
|
settings.email.footer.social.twitter.url | string |
Adresse URL. |
|
Icône Désactiver le message
|
settings.inapp.disableMessageIcon | boolean |
Indique s’il faut désactiver l’icône de message. |
|
Sélection élective
|
settings.inapp.placement | string |
Placement. |
|
Objets
|
snippets.items | array of string |
Éléments. |
Restaurer une liste
Restaure une liste existante par identificateur.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de liste
|
list_id | True | string |
Identificateur de liste. |
Retours
- response
- string
Répertorier des messages
Récupérez les états des messages précédemment envoyés.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Archivés
|
archived | boolean |
Indique s’il est archivé. |
|
|
Cursor
|
cursor | string |
Curseur. |
|
|
Événement
|
event | string |
Événement. |
|
|
Liste
|
list | string |
Liste. |
|
|
Message ID
|
messageId | string |
Identificateur du message. |
|
|
Notification
|
notification | string |
Notification. |
|
|
Recipient
|
recipient | string |
Destinataire. |
|
|
Statut
|
status | string |
État. |
|
|
Étiquettes
|
tags | string |
Balises. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Cursor
|
paging.cursor | string |
Curseur. |
|
More
|
paging.more | boolean |
S’il y en a plus. |
|
Results
|
results | array of object | |
|
ID
|
results.id | string |
Identificateur. |
|
Statut
|
results.status | string |
État. |
|
Mis en file d’attente
|
results.enqueued | integer |
Mis en file d’attente. |
|
Sent
|
results.sent | integer |
Envoyé. |
|
Livré
|
results.delivered | integer |
Livré. |
|
Ouvert
|
results.opened | integer |
Ouvert. |
|
Cliqué
|
results.clicked | integer |
Cliquez dessus. |
|
Recipient
|
results.recipient | string |
Destinataire. |
|
Événement
|
results.event | string |
Événement. |
|
Notification
|
results.notification | string |
Notification. |
|
Erreur
|
results.error | string |
Erreur. |
|
Reason
|
results.reason | string |
La raison. |
Répertorier les marques
Récupérez une liste de marques.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Cursor
|
cursor | string |
Curseur. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Cursor
|
paging.cursor | string |
Curseur. |
|
More
|
paging.more | boolean |
S’il y en a plus. |
|
Results
|
results | array of object | |
|
Créé
|
results.created | integer |
Lors de la création. |
|
ID
|
results.id | string |
Identificateur. |
|
Nom
|
results.name | string |
Nom. |
|
Publiée
|
results.published | integer |
Lorsqu’il est publié. |
|
Updated
|
results.updated | integer |
En cas de mise à jour. |
|
Version
|
results.version | string |
Version. |
|
Primary
|
results.settings.colors.primary | string |
Principal. |
|
Secondary
|
results.settings.colors.secondary | string |
Secondaire. |
|
Tertiaire
|
results.settings.colors.tertiary | string |
Le tertiaire. |
|
Couleur de la barre
|
results.settings.email.header.barColor | string |
Couleur de la barre. |
|
HREF
|
results.settings.email.header.logo.href | string |
The HREF. |
|
Image
|
results.settings.email.header.logo.image | string |
Image. |
|
Markdown
|
results.settings.email.footer.markdown | string |
Markdown. |
|
URL
|
results.settings.email.footer.social.facebook.url | string |
Adresse URL. |
|
URL
|
results.settings.email.footer.social.instagram.url | string |
Adresse URL. |
|
URL
|
results.settings.email.footer.social.linkedin.url | string |
Adresse URL. |
|
URL
|
results.settings.email.footer.social.medium.url | string |
Adresse URL. |
|
URL
|
results.settings.email.footer.social.twitter.url | string |
Adresse URL. |
|
Icône Désactiver le message
|
results.settings.inapp.disableMessageIcon | boolean |
Indique s’il faut désactiver l’icône de message. |
|
Sélection élective
|
results.settings.inapp.placement | string |
Placement. |
|
Objets
|
results.snippets.items | array of string |
Éléments. |
Répertorier les membres de l’audience
Récupérez une liste de membres d’une audience.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’audience
|
audience_id | True | string |
Identificateur de l’audience. |
|
Cursor
|
cursor | string |
Curseur. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
items | array of object | |
|
ID de membre
|
items.member_id | string |
Identificateur de membre. |
|
Ajouté à
|
items.added_at | string |
Lorsqu’il est ajouté à. |
|
ID d’audience
|
items.audience_id | string |
Identificateur de l’audience. |
|
Version de l’audience
|
items.audience_version | integer |
Version de l’audience. |
|
Reason
|
items.reason | string |
La raison. |
|
Cursor
|
paging.cursor | string |
Curseur. |
|
More
|
paging.more | boolean |
S’il y en a plus. |
Répertorier les notifications
Récupère une liste de notifications.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Cursor
|
cursor | string |
Curseur. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Cursor
|
paging.cursor | string |
Curseur. |
|
More
|
paging.more | boolean |
S’il y en a plus. |
|
Results
|
results | array of object | |
|
Créé à
|
results.created_at | integer |
Quand il est créé à l’adresse. |
|
ID
|
results.id | string |
Identificateur. |
|
Data
|
results.tags.data | array of object | |
|
ID
|
results.tags.data.id | string |
Identificateur. |
|
Nom
|
results.tags.data.name | string |
Nom. |
|
Titre
|
results.title | string |
Titre. |
|
Mise à jour à
|
results.updated_at | integer |
Lorsqu’il est mis à jour à l’adresse. |
Répertorier toutes les audiences
Récupérez toutes les audiences associées à votre compte.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Cursor
|
cursor | string |
Curseur. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Objets
|
items | array of object | |
|
ID
|
items.id | string |
Identificateur. |
|
Nom
|
items.name | string |
Nom. |
|
Descriptif
|
items.description | string |
Description. |
|
Operator
|
items.filter.operator | string |
Opérateur. |
|
Valeur
|
items.filter.value | string |
Valeur. |
|
Chemin
|
items.filter.path | string |
Chemin d’accès. |
|
Cursor
|
paging.cursor | string |
Curseur. |
|
More
|
paging.more | boolean |
S’il y en a plus. |
Supprimer un profil
Supprime le profil de destinataire spécifié.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID du destinataire
|
recipient_id | True | string |
Identificateur du destinataire. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Statut
|
status | string |
État. |
Supprimer un public
Supprime l’audience de destinataire spécifiée.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’audience
|
audience_id | True | string |
Identificateur de l’audience. |
Retours
- response
- string
Supprimer une liste
Supprime une liste par identificateur de liste.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de liste
|
list_id | True | string |
Identificateur de liste. |
Retours
- response
- string
Définitions
ficelle
Il s’agit du type de données de base « string ».
objet
Il s’agit du type "objet".