Zum Hauptinhalt springen
POST
/
marketing
/
v4
/
email
/
single-send
Envoyer un e-mail
curl --request POST \
  --url https://api.hubapi.com/marketing/v4/email/single-send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "contactProperties": {},
  "customProperties": {},
  "emailId": 123,
  "message": {
    "bcc": [
      "<string>"
    ],
    "cc": [
      "<string>"
    ],
    "from": "<string>",
    "replyTo": [
      "<string>"
    ],
    "sendId": "<string>",
    "to": "<string>"
  }
}'
{
  "completedAt": "2023-11-07T05:31:56Z",
  "eventId": {
    "created": "2023-11-07T05:31:56Z",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "message": "<string>",
  "requestedAt": "2023-11-07T05:31:56Z",
  "sendResult": "ADDRESS_LIST_BOMBED",
  "startedAt": "2023-11-07T05:31:56Z",
  "status": "CANCELED",
  "statusId": "<string>"
}

Produits pris en charge

Exige l'un des produits suivants ou un produit supérieur.
Marketing HubMarketing Hub -Entreprise
Sales HubSales Hub -Gratuit
Service HubService Hub -Gratuit
Content HubContent Hub -Gratuit
Cette API requiert l'une des portées suivantes :
marketing-email
transactional-email

Authorizations

​
Authorization
string
header
required

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

Body

application/json

A request to send a single email asynchronously.

​
emailId
integer
required

L'identifiant de contenu pour l'e-mail, qui peut être trouvé dans l'interface utilisateur de l'outil d'e-mail.

​
message
object
required

A JSON object containing anything you want to override.

​
contactProperties
object

Le champ « Propriété de contact » est une carte des valeurs des propriétés de contact. Chaque valeur de propriété de contact contient un nom et une propriété 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 lors de l'envoi de l'e-mail. Par exemple, lors de l'envoi d'un reçu, vous pouvez vouloir définir une propriété last_paid_date, car l'envoi du reçu contiendra des informations sur le dernier paiement.

​
customProperties
object

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.

Response

successful operation

Describes the status of an email send request.

​
status
enum<string>
required

Statut de la demande d'envoi.

Verfügbare Optionen:
CANCELED,
COMPLETE,
PENDING,
PROCESSING
​
statusId
string
required

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

​
completedAt
string<date-time>

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

​
eventId
object

The ID of a send event.

​
message
string
​
requestedAt
string<date-time>

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

​
sendResult
enum<string>

Résultat de l'envoi.

Verfügbare Optionen:
ADDRESS_LIST_BOMBED,
ADDRESS_ONLY_ACCEPTED_ON_PROD,
ADDRESS_OPTED_OUT,
BLOCKED_ADDRESS,
BLOCKED_DOMAIN,
CAMPAIGN_CANCELLED,
CANCELLED_ABUSE,
CORRUPT_INPUT,
EMAIL_DISABLED,
EMAIL_UNCONFIRMED,
GDPR_DOI_ENABLED,
GRAYMAIL_SUPPRESSED,
HUBL_LIMIT_EXCEEDED,
IDEMPOTENT_FAIL,
IDEMPOTENT_IGNORE,
INVALID_FROM_ADDRESS,
INVALID_TO_ADDRESS,
LOW_CONTACT_QUALITY_SCORE,
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,
UNCONFIGURED_SENDING_DOMAIN,
UNDELIVERABLE,
VALIDATION_FAILED
​
startedAt
string<date-time>

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