Tools
SendGrid
Send emails and manage contacts, lists, and templates with SendGrid
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.
Send an email using SendGrid API
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | SendGrid API key |
from | string | Yes | Sender email address (must be verified in SendGrid) |
fromName | string | No | Sender name |
to | string | Yes | Recipient email address |
toName | string | No | Recipient name |
subject | string | No | Email subject (required unless using a template with pre-defined subject) |
content | string | No | Email body content (required unless using a template with pre-defined content) |
contentType | string | No | Content type (text/plain or text/html) |
cc | string | No | CC email address |
bcc | string | No | BCC email address |
replyTo | string | No | Reply-to email address |
replyToName | string | No | Reply-to name |
attachments | file[] | No | Files to attach to the email |
templateId | string | No | SendGrid template ID to use |
dynamicTemplateData | json | No | JSON object of dynamic template data |
| Parameter | Type | Description |
|---|
success | boolean | Whether the email was sent successfully |
messageId | string | SendGrid message ID |
to | string | Recipient email address |
subject | string | Email subject |
Add a new contact to SendGrid
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | SendGrid API key |
email | string | Yes | Contact email address |
firstName | string | No | Contact first name |
lastName | string | No | Contact last name |
customFields | json | No | JSON object of custom field key-value pairs (use field IDs like e1_T, e2_N, e3_D, not field names) |
listIds | string | No | Comma-separated list IDs to add the contact to |
| Parameter | Type | Description |
|---|
jobId | string | Job ID for tracking the async contact creation |
email | string | Contact email address |
firstName | string | Contact first name |
lastName | string | Contact last name |
message | string | Status message |
Get a specific contact by ID from SendGrid
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | SendGrid API key |
contactId | string | Yes | Contact ID |
| Parameter | Type | Description |
|---|
id | string | Contact ID |
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 |
Search for contacts in SendGrid using a query
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | SendGrid API key |
query | string | Yes | Search query (e.g., "email LIKE '%example.com%' AND CONTAINS(list_ids, 'list-id')") |
| Parameter | Type | Description |
|---|
contacts | json | Array of matching contacts |
contactCount | number | Total number of contacts found |
Delete one or more contacts from SendGrid
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | SendGrid API key |
contactIds | string | Yes | Comma-separated contact IDs to delete |
| Parameter | Type | Description |
|---|
jobId | string | Job ID for the deletion request |
Create a new contact list in SendGrid
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | SendGrid API key |
name | string | Yes | List name |
| Parameter | Type | Description |
|---|
id | string | List ID |
name | string | List name |
contactCount | number | Number of contacts in the list |
Get a specific list by ID from SendGrid
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | SendGrid API key |
listId | string | Yes | List ID |
| Parameter | Type | Description |
|---|
id | string | List ID |
name | string | List name |
contactCount | number | Number of contacts in the list |
Get all contact lists from SendGrid
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | SendGrid API key |
pageSize | number | No | Number of lists to return per page (default: 100) |
| Parameter | Type | Description |
|---|
lists | json | Array of lists |
Delete a contact list from SendGrid
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | SendGrid API key |
listId | string | Yes | List ID to delete |
| Parameter | Type | Description |
|---|
message | string | Success message |
Add or update contacts and assign them to a list in SendGrid (uses PUT /v3/marketing/contacts)
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | SendGrid API key |
listId | string | Yes | List ID to add contacts to |
contacts | json | Yes | JSON array of contact objects. Each contact must have at least: email (or phone_number_id/external_id/anonymous_id). Example: [{"email": "user@example.com", "first_name": "John"}] |
| Parameter | Type | Description |
|---|
jobId | string | Job ID for tracking the async operation |
message | string | Status message |
Remove contacts from a specific list in SendGrid
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | SendGrid API key |
listId | string | Yes | List ID |
contactIds | string | Yes | Comma-separated contact IDs to remove from the list |
| Parameter | Type | Description |
|---|
jobId | string | Job ID for the request |
Create a new email template in SendGrid
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | SendGrid API key |
name | string | Yes | Template name |
generation | string | No | Template generation type (legacy or dynamic, default: dynamic) |
| Parameter | Type | Description |
|---|
id | string | Template ID |
name | string | Template name |
generation | string | Template generation |
updatedAt | string | Last update timestamp |
versions | json | Array of template versions |
Get a specific template by ID from SendGrid
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | SendGrid API key |
templateId | string | Yes | Template ID |
| Parameter | Type | Description |
|---|
id | string | Template ID |
name | string | Template name |
generation | string | Template generation |
updatedAt | string | Last update timestamp |
versions | json | Array of template versions |
Get all email templates from SendGrid
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | SendGrid API key |
generations | string | No | Filter by generation (legacy, dynamic, or both) |
pageSize | number | No | Number of templates to return per page (default: 20) |
| Parameter | Type | Description |
|---|
templates | json | Array of templates |
Delete an email template from SendGrid
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | SendGrid API key |
templateId | string | Yes | Template ID to delete |
Create a new version of an email template in SendGrid
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | SendGrid API key |
templateId | string | Yes | Template ID |
name | string | Yes | Version name |
subject | string | Yes | Email subject line |
htmlContent | string | No | HTML content of the template |
plainContent | string | No | Plain text content of the template |
active | boolean | No | Whether this version is active (default: true) |
| Parameter | Type | Description |
|---|
id | string | Version ID |
templateId | string | Template ID |
name | string | Version name |
subject | string | Email subject |
active | boolean | Whether this version is active |
htmlContent | string | HTML content |
plainContent | string | Plain text content |
updatedAt | string | Last update timestamp |
- Category:
tools
- Type:
sendgrid