Skip Navigation

Newer Version Available

This content describes an older version of this product. View Latest

Simple Email Actions

Send an email where you specify the subject, body, and recipients. Available in API version 32.0 and later.

Email Sending Limits: If you’re using logEmailOnSend or emailTemplateId, the daily email-sending limit is based on the single email limit. For details, see General Email Limits.; If you’re not using logEmailOnSend or emailTemplateId, the daily email-sending limit is based on the daily workflow email limit. For details, see Proactive Alert Monitoring: Daily Workflow Email Limit.

Supported REST HTTP Methods

URI: Get a list of available simple email actions:; /services/data/vXX.X/actions/standard/emailSimple
Formats: JSON, XML
HTTP Methods: GET, HEAD, POST
Authentication: Authorization: Bearer token

Inputs

Input	Details
emailAddresses	Type string Description Optional. A comma-delimited list of the recipients' email addresses. Up to five email recipients, specified as a comma-separated list. If emailAddressesArray and recipientId are also used, the combined number of recipients must be five or fewer.
emailAddressesArray	Type string Description Optional. A collection of the recipients' email addresses. Up to five email recipients, specified as a collection of strings. If emailAddresses is also used, the combined number of recipients must be five or fewer.
emailBody	Type textarea Description Optional. The body of the email. Required if not using an email template.
emailSubject	Type string Description Optional. The subject of the email. Required if not using an email template. The value is treated as plain text.
emailTemplateId	Type text Description Optional. The ID of the email template to use for the subject and body of the email. If this input is included, recipientId is required. If the email template has merge fields from an object other than the one associated with recipientId, specify the record used to supply those merge fields in relatedRecordId. If this input is specified, it changes the API called by the action, which can impact your daily email-sending limit. For details, see Flow Core Action: Send Email in Salesforce Help.
logEmailOnSend	Type boolean Description Optional. Indicates whether to log the email on the specified records’ activity timelines. Valid values are `true` and `false`. Default value is `false`, and the email isn't logged. To log an email, you must specify a value in recipientId or relatedRecordId. If this input is set to `true`, it changes the API called by the action, which can impact your daily email-sending limit. For details, see Flow Core Action: Send Email in Salesforce Help.
recipientId	Type text Description Optional. The ID of a lead, contact, or person account record. If logEmailOnSend is included, then recipientId is the ID of the person to send and log the email to. If emailTemplateId is included, then recipientId is required and is the ID of the person to send the email to.
relatedRecordId	Type text Description Optional. The ID of a record that's not a person. For example, the ID of a case record. If logEmailOnSend is included, relatedRecordId is the ID of a secondary record to log the email to. In this case, relatedRecordId can’t be used to log an email if recipientId is a lead record. If emailTemplateId is included, relatedRecordId is the ID of the non-recipient record used to populate email template merge fields.
sendRichBody	Type boolean Description Optional. Indicates whether the body of the email uses rich or plain text. Valid values are: `{!$GlobalConstant.True}`—The body of the email uses rich text. `{!$GlobalConstant.False}`—The body of the email uses plain text. This value is the default.
senderAddress	Type string Description Optional. The organization-wide email address to be used as the sender. Required only if senderType is set to `OrgWideEmailAddress`.
senderType	Type string Description Optional. Email address used as the email’s From and Reply-To addresses. Valid values are: `CurrentUser`—Email address of the user running the flow. This setting is the default. `DefaultWorkflowUser`—Email address of the default workflow user. `OrgWideEmailAddress`—The organization-wide email address that is specified in senderAddress.

Outputs

None.