POST
/
marketing
/
v4
/
email
/
single-send
Eメールを送信
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"
}
サポートされる製品
次のいずれかの製品またはそれ以上が必要です。
Marketing HubMarketing HubEnterprise
Sales HubSales Hub無料ツール
Service HubService Hub無料ツール
Content HubContent Hub無料ツール

​
必須スコープ

この API には、次のいずれかのスコープが必要です。
  • 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

EメールツールのUIで確認できるEメールのコンテンツID。

​
message
object
required

A JSON object containing anything you want to override.

​
customProperties
object

customPropertiesフィールドはプロパティー値のひも付けです。各プロパティー値には名前と値プロパティーが含まれています。各プロパティーは{{ custom.NAME }}のテンプレートに表示されます。 注：カスタムプロパティーでは現在のところ配列はサポートされていません。Eメールでリストを指定する場合の回避策の1つとして、HTMLリスト（テーブルまたはulを使用）を作成してカスタムプロパティーとして指定する方法があります。

Example:

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

​
contactProperties
object

contactPropertiesフィールドはコンタクトプロパティー値の対応付けです。各コンタクトプロパティー値には名前と値プロパティーが含まれています。各プロパティーはコンタクトレコードで設定され、{{ contact.NAME }}のテンプレートに表示されます。 Eメールを送信する際にコンタクトプロパティーを設定する場合は、これらのプロパティーを使用します。例えば、領収証を送信する場合、領収証の送信には前回の支払いに関する情報が含まれるため、last_paid_dateプロパティーを設定する必要がある場合があります。

Example:

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

Response

successful operation

Describes the status of an email send request.

​
statusId
string
required

送信のステータスを照会するために使用されるID。

​
status
enum<string>
required

送信リクエストのステータス。

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

The ID of a send event.

​
completedAt
string<date-time>

送信が完了した日時。

​
sendResult
enum<string>

送信の結果。

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>

送信がリクエストされた日時。

​
startedAt
string<date-time>

送信の処理が開始された日時。

​
message
string