Zum Hauptinhalt springen
POST
/
marketing
/
v3
/
transactional
/
single-email
/
send
Senden Sie eine transaktionale Single-Send-E-Mail auf asynchrone Weise.
curl --request POST \
  --url https://api.hubapi.com/marketing/v3/transactional/single-email/send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "emailId": 123,
  "message": {
    "to": "<string>",
    "bcc": [
      "<string>"
    ],
    "cc": [
      "<string>"
    ],
    "from": "<string>",
    "replyTo": [
      "<string>"
    ],
    "sendId": "<string>"
  },
  "contactProperties": {},
  "customProperties": {}
}
'
{
  "status": "CANCELED",
  "statusId": "<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"
}

Unterstützte Produkte

Erfordert eines der folgenden Produkte oder höher.
Marketing HubMarketing Hub -Professional
Sales HubSales Hub -Kostenlos
Service HubService Hub -Kostenlos
Content HubContent Hub -Kostenlos
Diese API erfordert einen der folgenden Bereiche:
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 object describing the email to send.

A request to send a single transactional email asynchronously.

​
emailId
integer<int64>
required

Die Content-ID für die Transaktions-E-Mail, die in der E-Mail-Tool-UI zu finden sind.

​
message
object
required

A JSON object containing anything you want to override.

​
contactProperties
object

Das „contactProperties“-Feld ist eine Karte von Kontakteigenschaftswerten. Jeder Kontakteigenschaftswert enthält eine Namens- und eine Werteigenschaft. Jede Eigenschaft wird im Kontaktdatensatz festgelegt und ist in der Vorlage unter {{ contact.NAME }} sichtbar. Verwenden Sie diese Eigenschaften, wenn Sie eine Kontakteigenschaft während des Sendens der E-Mail festlegen möchten. Legen Sie z. B. beim Senden einer Quittung die „last_paid_date“-Eigenschaft fest, da Informationen über die letzte Zahlung enthalten sein werden.

​
customProperties
object

Das Feld „customProperties“ ist eine Karte mit Eigenschaftswerten. Jeder Eigenschaftswert enthält eine Namens- und eine Werteigenschaft. Alle Eigenschaften werden in der Vorlage unter {{ custom.NAME }} angezeigt. Hinweis: Benutzerdefinierte Eigenschaften unterstützen derzeit keine Arrays. Um ein Listing in einer E-Mail bereitzustellen, kann eine HTML-Liste (entweder mit Tabellen oder ul) erstellt und als benutzerdefinierte Eigenschaft spezifiziert werden.

Response

successful operation

Describes the status of an email send request.

​
status
enum<string>
required

Status der Sendeanfrage.

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

ID für die Abfrage des Sendestatus.

​
completedAt
string<date-time>

Zeitpunkt, an dem der Versand abgeschlossen wurde.

​
eventId
object

The ID of a send event.

​
message
string
​
requestedAt
string<date-time>

Zeitpunkt, an dem der Versand angefordert wurde.

​
sendResult
enum<string>

Ergebnis des Sendevorgangs.

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>

Der Zeitpunkt, ab dem der Versand bearbeitet wurde.