SendGrid
API actions for the SendGrid integration.
SendGrid
Send emails and manage your marketing contacts in SendGrid.
Add contact to list
Add contacts to a SendGrid marketing list.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
email | string | Yes | Contact email address to add. |
list_ids | array | Yes | Marketing list IDs to add the contact to. |
Response
{
"job_id": "job_987"
}Create marketing list
Create a marketing list for SendGrid contacts.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | List name. |
Response
{
"contact_count": 0,
"id": "list_789",
"name": "My List"
}Get email stats
Retrieve SendGrid email statistics for a date range.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
start_date | string | Yes | Start date (YYYY-MM-DD). |
end_date | string | Yes | End date (YYYY-MM-DD). |
Response
{
"stats": [
{
"date": "2024-01-01",
"stats": [
{
"metrics": {
"clicks": 10,
"delivered": 95,
"opens": 50,
"requests": 100
}
}
]
}
]
}List templates
List SendGrid email templates.
Response
{
"result": [
{
"id": "tmpl_123",
"name": "Welcome Email"
}
]
}Send email
Send an email through SendGrid.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
from_email | string | Yes | Sender email address. |
to_email | string | Yes | Recipient email address. |
subject | string | Yes | Email subject. |
text_content | string | Yes | Plain text email content. |
html_content | string | No | Optional HTML email content. |
cc | array | No | Optional CC email addresses. |
bcc | array | No | Optional BCC email addresses. |
Response
{
"status_code": 202
}Send template email
Send an email built from a saved SendGrid template.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
from_email | string | Yes | Sender email address. |
to_email | string | Yes | Recipient email address. |
template_id | string | Yes | The ID of the SendGrid template to use. |
dynamic_data | object | No | Values to fill into the template's placeholders. |
Response
{
"status_code": 202
}