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 '{
  "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>"
}

Produtos suportados

Requer um dos seguintes produtos ou superior.
Marketing HubMarketing Hub -Enterprise
Sales HubSales Hub -Grátis
Service HubService Hub -Grátis
Content HubContent Hub -Grátis
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.

​
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.

​
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.

Response

successful operation

Describes the status of an email send request.

​
status
enum<string>
required

O status da solicitação de envio.

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

O identificador usado para consultar o status do envio.

​
completedAt
string<date-time>

A hora em que o envio foi concluído.

​
eventId
object

The ID of a send event.

​
message
string
​
requestedAt
string<date-time>

A hora em que o envio foi solicitado.

​
sendResult
enum<string>

O resultado do envio.

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>

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