Send Email

Send an email using SendGrid.

Options

Field Definition Type Required
Use Template? Indicates whether to use an email template. If set to Yes, the Template ID and Dynamic Template Data fields are added as inputs.

If set to No, the Subject, Substitutions and Content fields are added as inputs.

Dropdown TRUE
With Bypass List Management? If set to Yes, allows you to bypass the spam report list to ensure that the email is delivered to recipients. Bounce and unsubscribe lists will still be checked; addresses on these other lists will not receive the message. This filter cannot be combined with the bypass_list_management filter.

If set to Yes, adds the Bypass List Management input field.

If set to No, adds Bypass Spam Management?, Bypass Bounce Management? and Bypass Unsubscribe Management? as inputs.

Bypass List Management input fields cannot be combined with other Bypass fields.

Dropdown TRUE
With Spam Check? If set to Yes, allows you to bypass the spam report list to ensure that the email is delivered to recipients. Bounce and unsubscribe lists will still be checked; addresses on these other lists will not receive the message.

If set to Yes, the Threshold and Post to URL required.

If set to No, Span Check doesn't appear in the inputs.

Dropdown TRUE

Input

Field Definition Type Required
Email
Template ID An email template ID. A template that contains a subject and content — either text or html — will override any subject and content values specified at the personalizations or message level. String TRUE
From 'From' email address used to deliver the message. This address should be a verified sender in your Twilio SendGrid account. String TRUE
To Intended recipient's email address. String TRUE
CC Array of recipients who will receive a copy of your email. Each object in this array must contain the recipient's email address.

An email may be sent to a maximum of 1000 CC recipients.

List of Text FALSE
BCC Array of recipients who will receive a blind carbon copy of your email. Each object in this array must contain the recipient's email address.

An email may be sent to a maximum of 1000 BCC recipients.

List of Text FALSE
Headers JSON key/value pairs allowing you to specify handling instructions for your email. You may not overwrite the following headers:
  • x-sg-id

  • x-sg-eid

  • received

  • dkim-signature

  • Content-Type

  • Content-Transfer-Encoding

  • To

  • From

  • Subject

  • Reply-To

  • CC

  • BCC

Object FALSE
Substitutions Substitutions allow you to insert data without using Dynamic Transactional Templates. This field should not be used in combination with a Dynamic Transactional Template, which can be identified by a template_id starting with d-. This field is a collection of key/value pairs following the pattern "substitution_tag":"value to substitute". Object FALSE
Dynamic Template Data Dynamic template data is available using Handlebars syntax in Dynamic Transactional Templates. This field should be used in combination with a Dynamic Transactional Template, which can be identified by a template_id starting with d-. This field is a collection of key/value pairs following the pattern "variable_name":"value to insert". Object FALSE
Custom Arguments Values that are specific to this personalization that will be carried along with the email and its activity data. Any string that is entered into this parameter will be assumed to be the custom argument that you would like to be used. This field may not exceed 10,000 bytes. Object FALSE
Send At Accepts a UNIX timestamp allowing you to specify when you want your email to be delivered. Delivery cannot be scheduled more than 72 hours in advance. It is recommended to schedule mail for off-peak times. Most emails are scheduled and sent at the top of the hour or half hour. Scheduling email to avoid peak times — for example, scheduling at 10:53 — can result in lower deferral rates due to the reduced traffic during off-peak times. Number FALSE
Categories Categories to associate with this email. List of Text FALSE
Batch ID An ID representing a batch of emails to be sent at the same time. Including a batch ID value in your request allows you include this email in that batch. It also enables you to cancel or pause the delivery of that batch. String FALSE
Reply To Email address where any replies or bounces will be returned. String FALSE
Attachments An array of objects where you can specify any attachments you want to include. List of Objects FALSE
  • content: File to be attached.

File TRUE
  • type: MIME type of the content you are attaching.
    For example: “text/plain” or “text/html”.

String FALSE
  • filename: Attachment's filename.

String TRUE
  • disposition: Attachment's content-disposition, specifying how you would like the attachment to be displayed. For example, “inline” results in the attached file are displayed automatically within the message while “attachment” results in the attached file require some action to be taken before it is displayed, such as opening or downloading the file.

String FALSE
  • content_id: An email template ID. A template that contains a subject and content — either text or html — will override any subject and content values specified at the personalizations or message level.

String FALSE
Subject Subject of your email. This may be overridden by subject lines set in personalizations. String TRUE
Content Array of objects where you can specify content of your email.
  • type

  • value

Object TRUE
Spam Check
Threshold Assigned SpamAssassin value that indicates the level of filtering. Range is between 1 and 10. The lower the number, the more strict the filtering. Dropdown FALSE
Post to URL Inbound parse URL to which to send spam messages for inspection. String TRUE
Footer
Enable? If set to True, a default footer will be included on every email. Boolean FALSE
Type Indicates the type of footer. Options are Text and HTML. Dropdown FALSE
Content Content of the footer.
Note

Footer content only displays when the footer is enabled and the type matches the email Content type.

String FALSE
Unsubscribes
Group ID Unsubscribe group to associate with this email. Number FALSE
Groups to Display An array containing the unsubscribe groups that you would like to be displayed on the unsubscribe preferences page. List of Numbers FALSE
Mail Settings
IP Pool Name Name of the IP Pool from which the email is sent. String FALSE
Bypass List Management? If set to True, allows you to bypass all unsubscribe groups and suppressions to ensure that the email is delivered to every single recipient. This should only be used in emergencies when it is absolutely necessary that every recipient receives your email. This filter cannot be combined with any other bypass filters. Boolean FALSE
Bypass Spam Management Allows you to bypass the spam report list to ensure that the email is delivered to recipients. Boolean FALSE
Bypass Bounce Management Allows you to bypass the bounce list to ensure that the email is delivered to recipients. Boolean FALSE
Bypass Unsubscribe Management Allows you to bypass the global unsubscribe list to ensure that the email is delivered to recipients. Boolean FALSE
Sandbox Mode? If set to True, allows you to send a test email to ensure that your request body is valid and formatted correctly. Boolean FALSE
Click Tracking
Enable? If set to True, allows you to track if a recipient clicked a link in your email. Boolean FALSE
Enable Text? If set to True, indicates if this setting should be included in the text/plain portion of your email. Boolean FALSE
Open Tracking
Enable? If set to True, allows you to track if the email was opened by including a single pixel image in the body of the content. When the pixel is loaded, Twilio SendGrid can log that the email was opened. Boolean FALSE
Substitution Tag Allows you to specify a substitution tag that you can insert in the body of your email at a location that you desire. This tag will be replaced by the open tracking pixel. String FALSE
Subscription Tracking
Enable? If set to True, allows you to insert a subscription management link at the bottom of the text and HTML bodies of your email. Boolean FALSE
Substitution Tag A tag that will be replaced with the unsubscribe URL. For example: [unsubscribe_url]. If this parameter is used, it will override both the text and html parameters. The URL of the link will be placed at the substitution tag’s location with no additional formatting. String FALSE
Type Indicates the type of substitution tag. Options are Text and HTML. Dropdown FALSE
Content Content of the substitution tag. String FALSE
Google Analytics
Enable? If set to True, allows you to enable tracking provided by Google Analytics. Boolean FALSE
UTM Source Name of the referrer source. For example, Google, SomeDomain.com, or Marketing Email. String FALSE
UTM Medium Name of the marketing medium. For example, Email. String FALSE
UTM Term Used to identify any paid keywords. String FALSE
UTM Content Used to differentiate your campaign from advertisements. String FALSE
UTM Campaign Name of the campaign. String FALSE

Output

Field Definition Type
Status Code Result of the operation. The HTTP status code is returned by the connector and indicates whether the action taken by the card succeeded or failed. For example:
  • A 201 Created status code indicates success where a new resource was created.
  • A 403 Forbidden error indicates that the HTTP request was not processed because the necessary permissions were missing.

For a full list of possible status codes, see HTTP status codes.

Number

Related topics

SendGrid connector

About the elements of Okta Workflows

SendGrid API Reference