L'API d'envoi unique envoie des e-mails reposant sur des modèles créés dans l'outil E-mails de HubSpot à l'aide d'une demande POST au format JSON. Tous les e-mails envoyés via l'API seront automatiquement associés à des fiches d'informations de contact en fonction de l'adresse e-mail. S'il n'y a aucun contact avec une adresse e-mail correspondante, un nouveau contact avec cette adresse e-mail sera créé. Si vous souhaitez envoyer des e-mails sans créer de contacts, utilisez l'API SMTP.
Commencez par configurer votre e-mail dans HubSpot. Après la création de l'e-mail, vous pouvez définir les détails du destinataire, y compris les propriétés de contact ou personnalisées configurées dans le modèle d'e-mail, dans le corps de la demande de l'API. Avant de pouvoir effectuer la demande d'API, vous aurez besoin de l'ID de l'e-mail :
- Si vous laissez l'e-mail en tant que brouillon sans le publier, vous pouvez obtenir l'ID d'e-mail à partir de l'URL lorsque vous êtes dans l'éditeur d'e-mail. L'ID est la valeur numérique finale avant la barre oblique finale (
/) dans l'URL (par exemple,https://app.hubspot.com/email/{PORTAL_ID}/edit/{EMAIL_ID}/settings).
- Si vous publiez votre e-mail, vous pouvez copier l'identifiant de l'e-mail à partir de la page de détails de l'e-mail.
Pour envoyer un e-mail avec l'API d'envoi unique, effectuez une demande POST à /marketing/v3/transactional/single-email/send.
La réponse contient les champs suivants :
requestedAt: l'horodatage de la demande de l'envoi.
statusId: un identifiant qui peut être utilisé pour interroger le statut de l'envoi.
status: le statut de la demande d'envoi. ComprendPENDING,PROCESSING,CANCELEDetCOMPLETE.
Propriétés de demande
Le corps de la demande doit être un objet JSON avec les propriétés suivantes :
emailIdmessagecontactPropertiescustomProperties
emailId
Le champ emailId contient l'ID de contenu de l'e-mail transactionnel, qui peut être trouvé dans l'outil E-mails de HubSpot.
Message
Le champ message est un objet JSON contenant tout élément que vous souhaitez remplacer. Au minimum, vous devez inclure le champ to.
Champs d'objet du message :
to: le destinataire de l'e-mail.from: l'en-tête de l'e-mail. Vous pouvez définir un nom d'expéditeur avec le format suivant :"from":"Sender Name <sender@hubspot.com>".sendId: l'ID d'un envoi particulier. Un seul e-mail avec un champsendIdsera envoyé par compte. Vous pouvez donc inclure ce champ pour éviter les envois en double.replyTo: une liste JSON des valeurs de l'en-tête Répondre à pour l'e-mail.cc: une liste JSON des adresses e-mail à mettre en copie.bcc: une liste JSON des adresses e-mail à mettre en copie cachée.
contactProperties
Le champ contactProperties est un mappage JSON de valeurs de propriétés de contact. Chaque propriété de contact contient les champs name et value. Chaque propriété sera définie sur la fiche d'informations du contact et visible dans le modèle sous :
Utilisez ces propriétés si vous souhaitez définir une propriété de contact tout en envoyant l'e-mail. Par exemple, lors de l'envoi d'un reçu, vous souhaiterez peut-être définir une propriété last_paid_date, puisque l'envoi du reçu contiendra des informations sur le dernier paiement.
Une fois envoyé, l'e-mail transactionnel rendra le contenu du modèle d'e-mail programmable associé comme suit :
