Skip to main content
POST
/
marketing
/
v3
/
transactional
/
single-email
/
send
Enviar un solo correo transaccional de forma asíncrona.
curl --request POST \
  --url https://api.hubapi.com/marketing/v3/transactional/single-email/send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "customProperties": {},
  "emailId": 123,
  "message": {
    "cc": [
      "<string>"
    ],
    "sendId": "<string>",
    "bcc": [
      "<string>"
    ],
    "replyTo": [
      "<string>"
    ],
    "from": "<string>",
    "to": "<string>"
  },
  "contactProperties": {}
}'
{
  "eventId": {
    "created": "2023-11-07T05:31:56Z",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "completedAt": "2023-11-07T05:31:56Z",
  "statusId": "<string>",
  "sendResult": "SENT",
  "requestedAt": "2023-11-07T05:31:56Z",
  "startedAt": "2023-11-07T05:31:56Z",
  "status": "PENDING"
}

Productos compatibles

Se requiere uno de los siguientes productos o productos de ediciones superiores.
Marketing HubMarketing Hub -Pro
Sales HubSales Hub -Gratuito
Service HubService Hub -Gratuito
Content HubContent Hub -Gratuito
Esta API requiere uno de los siguientes ámbitos:
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
required

El ID del contenido del correo transaccional, que se puede encontrar en la UI de la herramienta de correo.

​
message
object
required

A JSON object containing anything you want to override.

​
customProperties
object

El campo customProperties es un mapa de valores de propiedad. Cada uno de estos valores contiene una propiedad de nombre y valor. Cada propiedad será visible en la plantilla bajo {{ custom.NAME }}. Nota: Las propiedades personalizadas actualmente no admiten secuencias. Para proporcionar una lista en un correo, un método alternativo es construir una lista HTML (ya sea con tablas o ul) y especificarla como una propiedad personalizada.

​
contactProperties
object

El campo contactProperties es un mapa de valores de propiedad de contacto. Cada uno de estos valores contiene una propiedad de nombre y valor. Cada propiedad se establecerá en el registro de contacto y será visible en la plantilla bajo {{ contact.NAME }}. Utiliza estas propiedades cuando desees establecer una propiedad de contacto mientras envías el correo. Por ejemplo, al enviar un recibo, puede que desees establecer una propiedad last_paid_date, ya que el envío del recibo tendrá información sobre el último registro de pago.

Response

successful operation

Describes the status of an email send request.

​
statusId
string
required

Identificador utilizado para consultar el estado del envío.

​
status
enum<string>
required

Estado de la solicitud de envío.

Available options:
PENDING,
PROCESSING,
CANCELED,
COMPLETE
​
eventId
object

The ID of a send event.

​
completedAt
string<date-time>

La hora cuando se completó el envío.

​
sendResult
enum<string>

Resultado del envío.

Available options:
SENT,
IDEMPOTENT_IGNORE,
QUEUED,
IDEMPOTENT_FAIL,
THROTTLED,
EMAIL_DISABLED,
PORTAL_SUSPENDED,
INVALID_TO_ADDRESS,
BLOCKED_DOMAIN,
PREVIOUSLY_BOUNCED,
EMAIL_UNCONFIRMED,
PREVIOUS_SPAM,
PREVIOUSLY_UNSUBSCRIBED_MESSAGE,
PREVIOUSLY_UNSUBSCRIBED_PORTAL,
INVALID_FROM_ADDRESS,
CAMPAIGN_CANCELLED,
VALIDATION_FAILED,
MTA_IGNORE,
BLOCKED_ADDRESS,
PORTAL_OVER_LIMIT,
PORTAL_EXPIRED,
PORTAL_MISSING_MARKETING_SCOPE,
MISSING_TEMPLATE_PROPERTIES,
MISSING_REQUIRED_PARAMETER,
PORTAL_AUTHENTICATION_FAILURE,
MISSING_CONTENT,
CORRUPT_INPUT,
TEMPLATE_RENDER_EXCEPTION,
GRAYMAIL_SUPPRESSED,
UNCONFIGURED_SENDING_DOMAIN,
UNDELIVERABLE,
CANCELLED_ABUSE,
QUARANTINED_ADDRESS,
ADDRESS_ONLY_ACCEPTED_ON_PROD,
PORTAL_NOT_AUTHORIZED_FOR_APPLICATION,
ADDRESS_LIST_BOMBED,
ADDRESS_OPTED_OUT,
RECIPIENT_FATIGUE_SUPPRESSED,
TOO_MANY_RECIPIENTS,
PREVIOUSLY_UNSUBSCRIBED_BRAND,
NON_MARKETABLE_CONTACT,
PREVIOUSLY_UNSUBSCRIBED_BUSINESS_UNIT,
GDPR_DOI_ENABLED
​
requestedAt
string<date-time>

La hora cuando se solicitó el envío.

​
startedAt
string<date-time>

La hora cuando comenzó el procesamiento del envío.

⌘I