SendGrid

Configuration

Send Mail

Operation

Send Mail

SendGrid API Key*

••••••••

From Email*

sender@yourdomain.com

From Name

Sender Name

To Email*

recipient@example.com

To Name

Recipient Name

Subject

Email subject (required unless using template)

Content

Email body content (required unless using template)

Content Type

Select...

cc@example.com

BCC

bcc@example.com

Reply To

replyto@example.com

Reply To Name

Template ID

SendGrid template ID

Dynamic Template Data

json

{"name": "John", "order_id": "12345"}

Attachments

Upload files to attach

Attachments

Reference files from previous blocks

Output

Parameter	Type	Description
`success`	boolean	Operation success status
`message`	string	Status or success message
`messageId`	string	Email message ID (send_mail)
`to`	string	Recipient email address (send_mail)
`subject`	string	Email subject (send_mail, create_template_version)
`id`	string	Resource ID
`jobId`	string	Job ID for async operations
`email`	string	Contact email address
`firstName`	string	Contact first name
`lastName`	string	Contact last name
`createdAt`	string	Creation timestamp
`updatedAt`	string	Last update timestamp
`listIds`	json	Array of list IDs the contact belongs to
`customFields`	json	Custom field values
`contacts`	json	Array of contacts
`contactCount`	number	Number of contacts
`lists`	json	Array of lists
`name`	string	Resource name
`templates`	json	Array of templates
`generation`	string	Template generation
`versions`	json	Array of template versions
`templateId`	string	Template ID
`active`	boolean	Whether template version is active
`htmlContent`	string	HTML content
`plainContent`	string	Plain text content

Add Contact

Operation

Add Contact

SendGrid API Key*

••••••••

Email*

contact@example.com

First Name

John

Last Name

Doe

Custom Fields

json

{"custom_field_1": "value1"}

List IDs

Comma-separated list IDs

Output

Parameter	Type	Description
`success`	boolean	Operation success status
`message`	string	Status or success message
`messageId`	string	Email message ID (send_mail)
`to`	string	Recipient email address (send_mail)
`subject`	string	Email subject (send_mail, create_template_version)
`id`	string	Resource ID
`jobId`	string	Job ID for async operations
`email`	string	Contact email address
`firstName`	string	Contact first name
`lastName`	string	Contact last name
`createdAt`	string	Creation timestamp
`updatedAt`	string	Last update timestamp
`listIds`	json	Array of list IDs the contact belongs to
`customFields`	json	Custom field values
`contacts`	json	Array of contacts
`contactCount`	number	Number of contacts
`lists`	json	Array of lists
`name`	string	Resource name
`templates`	json	Array of templates
`generation`	string	Template generation
`versions`	json	Array of template versions
`templateId`	string	Template ID
`active`	boolean	Whether template version is active
`htmlContent`	string	HTML content
`plainContent`	string	Plain text content

Get Contact

Operation

Get Contact

SendGrid API Key*

••••••••

Contact ID*

Contact ID

Output

Parameter	Type	Description
`success`	boolean	Operation success status
`message`	string	Status or success message
`messageId`	string	Email message ID (send_mail)
`to`	string	Recipient email address (send_mail)
`subject`	string	Email subject (send_mail, create_template_version)
`id`	string	Resource ID
`jobId`	string	Job ID for async operations
`email`	string	Contact email address
`firstName`	string	Contact first name
`lastName`	string	Contact last name
`createdAt`	string	Creation timestamp
`updatedAt`	string	Last update timestamp
`listIds`	json	Array of list IDs the contact belongs to
`customFields`	json	Custom field values
`contacts`	json	Array of contacts
`contactCount`	number	Number of contacts
`lists`	json	Array of lists
`name`	string	Resource name
`templates`	json	Array of templates
`generation`	string	Template generation
`versions`	json	Array of template versions
`templateId`	string	Template ID
`active`	boolean	Whether template version is active
`htmlContent`	string	HTML content
`plainContent`	string	Plain text content

Search Contacts

Operation

Search Contacts

SendGrid API Key*

••••••••

Search Query*

Describe the search criteria...

Output

Parameter	Type	Description
`success`	boolean	Operation success status
`message`	string	Status or success message
`messageId`	string	Email message ID (send_mail)
`to`	string	Recipient email address (send_mail)
`subject`	string	Email subject (send_mail, create_template_version)
`id`	string	Resource ID
`jobId`	string	Job ID for async operations
`email`	string	Contact email address
`firstName`	string	Contact first name
`lastName`	string	Contact last name
`createdAt`	string	Creation timestamp
`updatedAt`	string	Last update timestamp
`listIds`	json	Array of list IDs the contact belongs to
`customFields`	json	Custom field values
`contacts`	json	Array of contacts
`contactCount`	number	Number of contacts
`lists`	json	Array of lists
`name`	string	Resource name
`templates`	json	Array of templates
`generation`	string	Template generation
`versions`	json	Array of template versions
`templateId`	string	Template ID
`active`	boolean	Whether template version is active
`htmlContent`	string	HTML content
`plainContent`	string	Plain text content

Delete Contacts

Operation

Delete Contacts

SendGrid API Key*

••••••••

Contact IDs*

Comma-separated contact IDs

Output

Parameter	Type	Description
`success`	boolean	Operation success status
`message`	string	Status or success message
`messageId`	string	Email message ID (send_mail)
`to`	string	Recipient email address (send_mail)
`subject`	string	Email subject (send_mail, create_template_version)
`id`	string	Resource ID
`jobId`	string	Job ID for async operations
`email`	string	Contact email address
`firstName`	string	Contact first name
`lastName`	string	Contact last name
`createdAt`	string	Creation timestamp
`updatedAt`	string	Last update timestamp
`listIds`	json	Array of list IDs the contact belongs to
`customFields`	json	Custom field values
`contacts`	json	Array of contacts
`contactCount`	number	Number of contacts
`lists`	json	Array of lists
`name`	string	Resource name
`templates`	json	Array of templates
`generation`	string	Template generation
`versions`	json	Array of template versions
`templateId`	string	Template ID
`active`	boolean	Whether template version is active
`htmlContent`	string	HTML content
`plainContent`	string	Plain text content

Create List

Operation

Create List

SendGrid API Key*

••••••••

List Name*

List name

Output

Parameter	Type	Description
`success`	boolean	Operation success status
`message`	string	Status or success message
`messageId`	string	Email message ID (send_mail)
`to`	string	Recipient email address (send_mail)
`subject`	string	Email subject (send_mail, create_template_version)
`id`	string	Resource ID
`jobId`	string	Job ID for async operations
`email`	string	Contact email address
`firstName`	string	Contact first name
`lastName`	string	Contact last name
`createdAt`	string	Creation timestamp
`updatedAt`	string	Last update timestamp
`listIds`	json	Array of list IDs the contact belongs to
`customFields`	json	Custom field values
`contacts`	json	Array of contacts
`contactCount`	number	Number of contacts
`lists`	json	Array of lists
`name`	string	Resource name
`templates`	json	Array of templates
`generation`	string	Template generation
`versions`	json	Array of template versions
`templateId`	string	Template ID
`active`	boolean	Whether template version is active
`htmlContent`	string	HTML content
`plainContent`	string	Plain text content

Get List

Operation

Get List

SendGrid API Key*

••••••••

List ID*

List ID

Output

Parameter	Type	Description
`success`	boolean	Operation success status
`message`	string	Status or success message
`messageId`	string	Email message ID (send_mail)
`to`	string	Recipient email address (send_mail)
`subject`	string	Email subject (send_mail, create_template_version)
`id`	string	Resource ID
`jobId`	string	Job ID for async operations
`email`	string	Contact email address
`firstName`	string	Contact first name
`lastName`	string	Contact last name
`createdAt`	string	Creation timestamp
`updatedAt`	string	Last update timestamp
`listIds`	json	Array of list IDs the contact belongs to
`customFields`	json	Custom field values
`contacts`	json	Array of contacts
`contactCount`	number	Number of contacts
`lists`	json	Array of lists
`name`	string	Resource name
`templates`	json	Array of templates
`generation`	string	Template generation
`versions`	json	Array of template versions
`templateId`	string	Template ID
`active`	boolean	Whether template version is active
`htmlContent`	string	HTML content
`plainContent`	string	Plain text content

List All Lists

Operation

List All Lists

SendGrid API Key*

••••••••

Page Size

100

Output

Parameter	Type	Description
`success`	boolean	Operation success status
`message`	string	Status or success message
`messageId`	string	Email message ID (send_mail)
`to`	string	Recipient email address (send_mail)
`subject`	string	Email subject (send_mail, create_template_version)
`id`	string	Resource ID
`jobId`	string	Job ID for async operations
`email`	string	Contact email address
`firstName`	string	Contact first name
`lastName`	string	Contact last name
`createdAt`	string	Creation timestamp
`updatedAt`	string	Last update timestamp
`listIds`	json	Array of list IDs the contact belongs to
`customFields`	json	Custom field values
`contacts`	json	Array of contacts
`contactCount`	number	Number of contacts
`lists`	json	Array of lists
`name`	string	Resource name
`templates`	json	Array of templates
`generation`	string	Template generation
`versions`	json	Array of template versions
`templateId`	string	Template ID
`active`	boolean	Whether template version is active
`htmlContent`	string	HTML content
`plainContent`	string	Plain text content

Delete List

Operation

Delete List

SendGrid API Key*

••••••••

List ID*

List ID

Output

Parameter	Type	Description
`success`	boolean	Operation success status
`message`	string	Status or success message
`messageId`	string	Email message ID (send_mail)
`to`	string	Recipient email address (send_mail)
`subject`	string	Email subject (send_mail, create_template_version)
`id`	string	Resource ID
`jobId`	string	Job ID for async operations
`email`	string	Contact email address
`firstName`	string	Contact first name
`lastName`	string	Contact last name
`createdAt`	string	Creation timestamp
`updatedAt`	string	Last update timestamp
`listIds`	json	Array of list IDs the contact belongs to
`customFields`	json	Custom field values
`contacts`	json	Array of contacts
`contactCount`	number	Number of contacts
`lists`	json	Array of lists
`name`	string	Resource name
`templates`	json	Array of templates
`generation`	string	Template generation
`versions`	json	Array of template versions
`templateId`	string	Template ID
`active`	boolean	Whether template version is active
`htmlContent`	string	HTML content
`plainContent`	string	Plain text content

Add Contacts to List

Operation

Add Contacts to List

SendGrid API Key*

••••••••

Contacts (JSON Array)*

json

[{"email": "user@example.com", "first_name": "John"}]

List ID*

List ID

Output

Parameter	Type	Description
`success`	boolean	Operation success status
`message`	string	Status or success message
`messageId`	string	Email message ID (send_mail)
`to`	string	Recipient email address (send_mail)
`subject`	string	Email subject (send_mail, create_template_version)
`id`	string	Resource ID
`jobId`	string	Job ID for async operations
`email`	string	Contact email address
`firstName`	string	Contact first name
`lastName`	string	Contact last name
`createdAt`	string	Creation timestamp
`updatedAt`	string	Last update timestamp
`listIds`	json	Array of list IDs the contact belongs to
`customFields`	json	Custom field values
`contacts`	json	Array of contacts
`contactCount`	number	Number of contacts
`lists`	json	Array of lists
`name`	string	Resource name
`templates`	json	Array of templates
`generation`	string	Template generation
`versions`	json	Array of template versions
`templateId`	string	Template ID
`active`	boolean	Whether template version is active
`htmlContent`	string	HTML content
`plainContent`	string	Plain text content

Remove Contacts from List

Operation

Remove Contacts from List

SendGrid API Key*

••••••••

Contact IDs*

Comma-separated contact IDs

List ID*

List ID

Output

Parameter	Type	Description
`success`	boolean	Operation success status
`message`	string	Status or success message
`messageId`	string	Email message ID (send_mail)
`to`	string	Recipient email address (send_mail)
`subject`	string	Email subject (send_mail, create_template_version)
`id`	string	Resource ID
`jobId`	string	Job ID for async operations
`email`	string	Contact email address
`firstName`	string	Contact first name
`lastName`	string	Contact last name
`createdAt`	string	Creation timestamp
`updatedAt`	string	Last update timestamp
`listIds`	json	Array of list IDs the contact belongs to
`customFields`	json	Custom field values
`contacts`	json	Array of contacts
`contactCount`	number	Number of contacts
`lists`	json	Array of lists
`name`	string	Resource name
`templates`	json	Array of templates
`generation`	string	Template generation
`versions`	json	Array of template versions
`templateId`	string	Template ID
`active`	boolean	Whether template version is active
`htmlContent`	string	HTML content
`plainContent`	string	Plain text content

Create Template

Operation

Create Template

SendGrid API Key*

••••••••

Template Name*

Template name

Template Generation

Select...

Output

Parameter	Type	Description
`success`	boolean	Operation success status
`message`	string	Status or success message
`messageId`	string	Email message ID (send_mail)
`to`	string	Recipient email address (send_mail)
`subject`	string	Email subject (send_mail, create_template_version)
`id`	string	Resource ID
`jobId`	string	Job ID for async operations
`email`	string	Contact email address
`firstName`	string	Contact first name
`lastName`	string	Contact last name
`createdAt`	string	Creation timestamp
`updatedAt`	string	Last update timestamp
`listIds`	json	Array of list IDs the contact belongs to
`customFields`	json	Custom field values
`contacts`	json	Array of contacts
`contactCount`	number	Number of contacts
`lists`	json	Array of lists
`name`	string	Resource name
`templates`	json	Array of templates
`generation`	string	Template generation
`versions`	json	Array of template versions
`templateId`	string	Template ID
`active`	boolean	Whether template version is active
`htmlContent`	string	HTML content
`plainContent`	string	Plain text content

Get Template

Operation

Get Template

SendGrid API Key*

••••••••

Template ID*

Template ID

Output

Parameter	Type	Description
`success`	boolean	Operation success status
`message`	string	Status or success message
`messageId`	string	Email message ID (send_mail)
`to`	string	Recipient email address (send_mail)
`subject`	string	Email subject (send_mail, create_template_version)
`id`	string	Resource ID
`jobId`	string	Job ID for async operations
`email`	string	Contact email address
`firstName`	string	Contact first name
`lastName`	string	Contact last name
`createdAt`	string	Creation timestamp
`updatedAt`	string	Last update timestamp
`listIds`	json	Array of list IDs the contact belongs to
`customFields`	json	Custom field values
`contacts`	json	Array of contacts
`contactCount`	number	Number of contacts
`lists`	json	Array of lists
`name`	string	Resource name
`templates`	json	Array of templates
`generation`	string	Template generation
`versions`	json	Array of template versions
`templateId`	string	Template ID
`active`	boolean	Whether template version is active
`htmlContent`	string	HTML content
`plainContent`	string	Plain text content

List Templates

Operation

List Templates

SendGrid API Key*

••••••••

Filter by Generation

legacy, dynamic, or both

Page Size

Output

Parameter	Type	Description
`success`	boolean	Operation success status
`message`	string	Status or success message
`messageId`	string	Email message ID (send_mail)
`to`	string	Recipient email address (send_mail)
`subject`	string	Email subject (send_mail, create_template_version)
`id`	string	Resource ID
`jobId`	string	Job ID for async operations
`email`	string	Contact email address
`firstName`	string	Contact first name
`lastName`	string	Contact last name
`createdAt`	string	Creation timestamp
`updatedAt`	string	Last update timestamp
`listIds`	json	Array of list IDs the contact belongs to
`customFields`	json	Custom field values
`contacts`	json	Array of contacts
`contactCount`	number	Number of contacts
`lists`	json	Array of lists
`name`	string	Resource name
`templates`	json	Array of templates
`generation`	string	Template generation
`versions`	json	Array of template versions
`templateId`	string	Template ID
`active`	boolean	Whether template version is active
`htmlContent`	string	HTML content
`plainContent`	string	Plain text content

Delete Template

Operation

Delete Template

SendGrid API Key*

••••••••

Template ID*

Template ID

Output

Parameter	Type	Description
`success`	boolean	Operation success status
`message`	string	Status or success message
`messageId`	string	Email message ID (send_mail)
`to`	string	Recipient email address (send_mail)
`subject`	string	Email subject (send_mail, create_template_version)
`id`	string	Resource ID
`jobId`	string	Job ID for async operations
`email`	string	Contact email address
`firstName`	string	Contact first name
`lastName`	string	Contact last name
`createdAt`	string	Creation timestamp
`updatedAt`	string	Last update timestamp
`listIds`	json	Array of list IDs the contact belongs to
`customFields`	json	Custom field values
`contacts`	json	Array of contacts
`contactCount`	number	Number of contacts
`lists`	json	Array of lists
`name`	string	Resource name
`templates`	json	Array of templates
`generation`	string	Template generation
`versions`	json	Array of template versions
`templateId`	string	Template ID
`active`	boolean	Whether template version is active
`htmlContent`	string	HTML content
`plainContent`	string	Plain text content

Create Template Version

Operation

Create Template Version

SendGrid API Key*

••••••••

Template ID*

Template ID

Version Name*

Version name

Template Subject*

Email subject

HTML Content

html

Plain Text Content

Plain text content

Active

Select...

Output

Parameter	Type	Description
`success`	boolean	Operation success status
`message`	string	Status or success message
`messageId`	string	Email message ID (send_mail)
`to`	string	Recipient email address (send_mail)
`subject`	string	Email subject (send_mail, create_template_version)
`id`	string	Resource ID
`jobId`	string	Job ID for async operations
`email`	string	Contact email address
`firstName`	string	Contact first name
`lastName`	string	Contact last name
`createdAt`	string	Creation timestamp
`updatedAt`	string	Last update timestamp
`listIds`	json	Array of list IDs the contact belongs to
`customFields`	json	Custom field values
`contacts`	json	Array of contacts
`contactCount`	number	Number of contacts
`lists`	json	Array of lists
`name`	string	Resource name
`templates`	json	Array of templates
`generation`	string	Template generation
`versions`	json	Array of template versions
`templateId`	string	Template ID
`active`	boolean	Whether template version is active
`htmlContent`	string	HTML content
`plainContent`	string	Plain text content

Integrate SendGrid into your workflow. Send transactional emails, manage marketing contacts and lists, and work with email templates. Supports dynamic templates, attachments, and comprehensive contact management.

Notes

Category: tools
Type: sendgrid

SendGrid

Configuration

Send Mail

Add Contact

Get Contact

Search Contacts

Delete Contacts

Create List

Get List

List All Lists

Delete List

Add Contacts to List

Remove Contacts from List

Create Template

Get Template

List Templates

Delete Template

Create Template Version

Usage Instructions

Notes

On this page