Skip to main content

send_email

Internal beta โ€” config shape is being migrated

The Automation API is an internal beta and is not released yet โ€” endpoints and payloads may change or be withdrawn without notice. This action's config is being migrated to a typed schema; the fields below reflect that in-progress shape. Always read the authoritative, live shape from GET /v1/automation/meta/action before building against it.

Send email โ€” sends an email. group: "action". No specific trigger context is required.

Part of the Email & documents family. This page documents the typed config; for how an action sits inside an automation definition, see Actions and Action examples.

Configโ€‹

KeyTypeRequiredDescription
to_addresstemplate valueyesRecipient address(es).
subjecttemplate valueyesEmail subject.
reply_addresstemplate valuenoReply-to address. Empty when omitted.
cc_addresstemplate valuenoCC address(es). Empty when omitted.
bcc_addresstemplate valuenoBCC address(es). Empty when omitted.
from_addresstemplate valuenoFrom address. Empty when omitted.
from_nametemplate valuenoFrom display name. Empty when omitted.
message_bodytemplate valuenoHTML email body. Empty when omitted.
smtp_account_idintegernoId of the SMTP account to send from. Omitted โ†’ the organization's default SMTP account.
attach_files_variable_defsarray of referencesnoFile variables that are candidates for attachment. Empty when omitted.
attach_files_match_typeenumnoWhich candidate files are attached. Default all.
attach_files_match_conditionfilter group | nullnoRestricts attached files for the filtered / most_recent_filtered modes. Empty AND-group when omitted.

attach_files_match_type tokens (lower-case): all, filtered, most_recent, most_recent_filtered. all and most_recent ignore the condition; filtered and most_recent_filtered restrict to files matching attach_files_match_condition.

Exampleโ€‹

An action entry inside an automation definition's actions[]:

{
"type": "send_email",
"config": {
"to_address": ["[email protected]"],
"subject": ["New record: ", { "kind": "variable", "source": "meta", "meta_type": "app_record_id" }],
"message_body": ["<p>A record was created.</p>"],
"smtp_account_id": 812
}
}

Validation & behaviorโ€‹

  • to_address and subject are the only required members; every other address/name/body template defaults to empty.
  • message_body may be omitted โ€” the email sends with an empty body.
  • With smtp_account_id omitted, the send uses the organization's default SMTP account.
  • Automation email sends draw down the organization's shared 24-hour send quota.

See alsoโ€‹