Zum Hauptinhalt springen
POST
/
marketing
/
v4
/
email
/
single-send
Enviar um email
curl --request POST \
  --url https://api.hubapi.com/marketing/v4/email/single-send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "customProperties": "{\"customProperty1\":\"value1\",\"customProperty2\":\"value2\"}",
  "emailId": 123,
  "message": {
    "cc": [
      "<string>"
    ],
    "sendId": "<string>",
    "bcc": [
      "<string>"
    ],
    "replyTo": [
      "<string>"
    ],
    "from": "<string>",
    "to": "<string>"
  },
  "contactProperties": "{\"lastname\":\"doe\",\"firstname\":\"john\"}"
}'
{
  "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",
  "message": "<string>",
  "status": "PENDING"
}
Produtos suportados
Requer um dos seguintes produtos ou superior.
Marketing HubMarketing HubEnterprise
Sales HubSales HubGrátis
Service HubService HubGrátis
Content HubContent HubGrátis

​
Escopos Necessários

Esta API requer um dos seguintes escopos:
  • 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

O ID de conteúdo para o e-mail, que pode ser encontrado na UI da ferramenta de e-mail.

​
message
object
required

A JSON object containing anything you want to override.

​
customProperties
object

O campo customProperties é um mapa de valores de propriedade. Cada valor de propriedade contém uma propriedade de nome e valor. Cada propriedade será visível no modelo em {{ custom.NAME }}. Observação: propriedades personalizadas atualmente não são compatíveis com matrizes. Para fornecer uma lista em um e-mail, uma solução alternativa é construir uma lista HTML (seja com tabelas ou ul) e especificá-la como uma propriedade personalizada.

Example:

"{\"customProperty1\":\"value1\",\"customProperty2\":\"value2\"}"

​
contactProperties
object

O campo contactProperties é um mapa de valores de propriedade do contato. Cada valor de propriedade do contato contém uma propriedade de nome e valor. Cada propriedade será definida no registro do contato e será visível no modelo em {{ contact.NAME }}. Use essas propriedades quando quiser definir uma propriedade do contato ao enviar o e-mail. Por exemplo, ao enviar um recibo, você pode querer definir uma propriedade last_paid_date, pois o envio do recibo terá informações sobre o último pagamento.

Example:

"{\"lastname\":\"doe\",\"firstname\":\"john\"}"

Response

successful operation

Describes the status of an email send request.

​
statusId
string
required

O identificador usado para consultar o status do envio.

​
status
enum<string>
required

O status da solicitação de envio.

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

The ID of a send event.

​
completedAt
string<date-time>

A hora em que o envio foi concluído.

​
sendResult
enum<string>

O resultado do envio.

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,
HUBL_LIMIT_EXCEEDED,
LOW_CONTACT_QUALITY_SCORE
​
requestedAt
string<date-time>

A hora em que o envio foi solicitado.

​
startedAt
string<date-time>

A hora em que o envio começou a ser processado.

​
message
string
⌘I