Send a transactional email

Supported products

Required Scopes

Autorisations

Authorization

string

header

requis

The access token received from the authorization server in the OAuth 2.0 flow.

Corps

application/json

contactProperties

object

requis

Le champ contact « Propriété » est une carte des valeurs de propriété de contact. Chaque valeur de propriété de contact contient une propriété de nom et de valeur. Chaque propriété sera définie sur l'enregistrement de contact et sera visible dans le modèle sous {{ contact.NAME }}. Utilisez ces propriétés lorsque vous souhaitez définir une propriété de contact pendant l'envoi de l'e-mail. Par exemple, lors de l'envoi d'un reçu, vous voudrez peut-être définir une propriété last_paid_date, car l'envoi du reçu aura des informations sur le dernier paiement.

Show child attributes

customProperties

object

requis

Le champ personnalisé « Properties » est une carte de valeurs de propriété. Chaque valeur de propriété contient un nom et une propriété de valeur. Chaque propriété sera visible dans le modèle sous {{ custom.NAME }}. Note : les propriétés personnalisées ne prennent actuellement pas en charge les tableaux. Pour fournir une liste dans un e-mail, une solution de contournement consiste à créer une liste HTML (soit avec des tables, soit avec ul) et à la spécifier comme propriété personnalisée.

Show child attributes

emailId

integer<int64>

requis

L'ID de contenu pour l'e-mail transactionnel, trouvable dans l'interface utilisateur de l'outil d'e-mail.

message

object

requis

Show child attributes

Réponse

successful operation

status

enum<string>

requis

Statut de la demande d'envoi.

Options disponibles:

CANCELED,

COMPLETE,

PENDING,

PROCESSING

statusId

string

requis

Identifiant utilisé pour interroger le statut de l'envoi.

completedAt

string<date-time>

Heure à laquelle l'envoi a été effectué.

eventId

object

Show child attributes

message

string

Un message lisible par la personne décrivant l'erreur ainsi que les mesures correctives possibles, le cas échéant

requestedAt

string<date-time>

Heure à laquelle l'envoi a été demandé.

sendResult

enum<string>

Résultat de l'envoi.

Options disponibles:

ADDRESS_LIST_BOMBED,

ADDRESS_ONLY_ACCEPTED_ON_PROD,

ADDRESS_OPTED_OUT,

ATTACHMENT_DOWNLOAD_QUEUE_FULL,

BLOCKED_ADDRESS,

BLOCKED_DOMAIN,

BRAND_RECIPIENT_FATIGUE_SUPPRESSED,

CAMPAIGN_CANCELLED,

CANCELLED_ABUSE,

CONTACT_VIEW_PERMISSION,

CORRUPT_INPUT,

EMAIL_DISABLED,

EMAIL_UNCONFIRMED,

GDPR_DOI_ENABLED,

GRAYMAIL_SUPPRESSED,

HUBL_LIMIT_EXCEEDED,

IDEMPOTENT_FAIL,

IDEMPOTENT_IGNORE,

INVALID_APP_ID_ATTRIBUTION,

INVALID_FROM_ADDRESS,

INVALID_TO_ADDRESS,

LOW_CONTACT_QUALITY_SCORE,

MARKETING_ACTIVATION_DISALLOWED,

MISSING_CONTENT,

MISSING_REQUIRED_PARAMETER,

MISSING_TEMPLATE_PROPERTIES,

MTA_IGNORE,

NON_MARKETABLE_CONTACT,

PORTAL_AUTHENTICATION_FAILURE,

PORTAL_EXPIRED,

PORTAL_MISSING_MARKETING_SCOPE,

PORTAL_NOT_AUTHORIZED_FOR_APPLICATION,

PORTAL_OVER_LIMIT,

PORTAL_SUSPENDED,

PREVIOUS_SPAM,

PREVIOUSLY_BOUNCED,

PREVIOUSLY_UNSUBSCRIBED_BRAND,

PREVIOUSLY_UNSUBSCRIBED_BUSINESS_UNIT,

PREVIOUSLY_UNSUBSCRIBED_MESSAGE,

PREVIOUSLY_UNSUBSCRIBED_PORTAL,

QUARANTINED_ADDRESS,

QUEUED,

RECIPIENT_FATIGUE_SUPPRESSED,

SENT,

TEMPLATE_RENDER_EXCEPTION,

THROTTLED,

TOO_MANY_RECIPIENTS,

UBB_GOVERNANCE_MISSING,

UNCONFIGURED_SENDING_DOMAIN,

UNDELIVERABLE,

VALIDATION_FAILED

startedAt

string<date-time>

Heure à laquelle l'envoi a commencé à être traité.