> ## Documentation Index
> Fetch the complete documentation index at: https://nango-wari-migrated-bigcommerce-docs.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# SendGrid
## Overview
## Pre-built tooling
| Tools | Status |
| --------------------------------- | ------ |
| Pre-built authorization (API Key) | ✅ |
| Pre-built authorization UI | ✅ |
| Custom authorization UI | ✅ |
| End-user authorization guide | ✅ |
| Expired credentials detection | ✅ |
| Tools | Status |
| ----------------------------------------- | ------------------------------ |
| Pre-built integrations | ✅ |
| API unification | ✅ |
| 2-way sync | ✅ |
| Webhooks from Nango on data modifications | ✅ |
| Real-time webhooks from 3rd-party API | 🚫 (time to contribute: \<48h) |
| Proxy requests | ✅ |
| Tools | Status |
| ----------------------- | ------ |
| HTTP request logging | ✅ |
| End-to-end type safety | ✅ |
| Data runtime validation | ✅ |
| OpenTelemetry export | ✅ |
| Slack alerts on errors | ✅ |
| Integration status API | ✅ |
| Tools | Status |
| ---------------------------------- | ------------------------------ |
| Create or customize use-cases | ✅ |
| Pre-configured pagination | 🚫 (time to contribute: \<48h) |
| Pre-configured rate-limit handling | 🚫 (time to contribute: \<48h) |
| Per-customer configurations | ✅ |
### Others
| Function name | Description | Type | Source code |
| ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| `activate-template-version` | Mark a template version as the active one used when sending. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/activate-template-version.ts) |
| `add-contacts-to-list` | Add existing contacts to a list. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/add-contacts-to-list.ts) |
| `add-global-suppressions` | Add email addresses to the global suppression (unsubscribe) list | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/add-global-suppressions.ts) |
| `add-group-suppressions` | Unsubscribe email addresses from a specific group. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/add-group-suppressions.ts) |
| `create-custom-field` | Create a custom contact field definition. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/create-custom-field.ts) |
| `create-dynamic-template` | Create a dynamic template. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/create-dynamic-template.ts) |
| `create-list` | Create a contact list. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/create-list.ts) |
| `create-segment` | Create a segment from a SQL query over contacts. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/create-segment.ts) |
| `create-sender-identity` | Create a sender identity (triggers a verification email). | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/create-sender-identity.ts) |
| `create-suppression-group` | Create an unsubscribe group. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/create-suppression-group.ts) |
| `create-template-version` | Create a new version of a dynamic template. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/create-template-version.ts) |
| `delete-blocks` | Clear block suppressions for one or more addresses, or all of them. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/delete-blocks.ts) |
| `delete-bounces` | Clear bounce suppressions for one or more addresses, or all of them. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/delete-bounces.ts) |
| `delete-contacts` | Delete contacts by id. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/delete-contacts.ts) |
| `delete-custom-field` | Delete a custom contact field definition. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/delete-custom-field.ts) |
| `delete-dynamic-template` | Delete a dynamic template and all of its versions. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/delete-dynamic-template.ts) |
| `delete-global-suppression` | Remove a single email address from the global suppression list. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/delete-global-suppression.ts) |
| `delete-group-suppression` | Remove a single email address's unsubscribe from a specific group. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/delete-group-suppression.ts) |
| `delete-invalid-emails` | Clear invalid-email suppressions for one or more addresses, or all of them. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/delete-invalid-emails.ts) |
| `delete-list` | Delete a contact list. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/delete-list.ts) |
| `delete-segment` | Delete a segment. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/delete-segment.ts) |
| `delete-sender-identity` | Delete a sender identity. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/delete-sender-identity.ts) |
| `delete-spam-reports` | Clear spam-report suppressions for one or more addresses, or all of them. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/delete-spam-reports.ts) |
| `delete-suppression-group` | Delete an unsubscribe group. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/delete-suppression-group.ts) |
| `delete-template-version` | Delete a template version. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/delete-template-version.ts) |
| `get-contacts-count` | Get total and billable contact counts. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/get-contacts-count.ts) |
| `get-dynamic-template` | Get a single dynamic template and all of its versions. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/get-dynamic-template.ts) |
| `get-list` | Get a single contact list by id. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/get-list.ts) |
| `get-segment` | Get a single segment by id, including a contact sample. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/get-segment.ts) |
| `get-stats` | Get email statistics. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/get-stats.ts) |
| `list-blocks` | List blocked email addresses. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/list-blocks.ts) |
| `list-bounces` | List bounced email addresses. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/list-bounces.ts) |
| `list-contacts` | List marketing contacts (small, capped result set). | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/list-contacts.ts) |
| `list-custom-fields` | List custom contact field definitions. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/list-custom-fields.ts) |
| `list-dynamic-templates` | List dynamic templates. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/list-dynamic-templates.ts) |
| `list-global-suppressions` | List globally unsubscribed email addresses. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/list-global-suppressions.ts) |
| `list-group-suppressions` | List the email addresses unsubscribed from a specific group. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/list-group-suppressions.ts) |
| `list-invalid-emails` | List invalid email addresses. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/list-invalid-emails.ts) |
| `list-lists` | List contact lists. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/list-lists.ts) |
| `list-segments` | List segments (Segmentation v2). | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/list-segments.ts) |
| `list-sender-identities` | List verified sender identities. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/list-sender-identities.ts) |
| `list-spam-reports` | List email addresses that reported spam. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/list-spam-reports.ts) |
| `list-suppression-groups` | List unsubscribe groups. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/list-suppression-groups.ts) |
| `remove-contacts-from-list` | Remove contacts from a list. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/remove-contacts-from-list.ts) |
| `resend-sender-verification` | Resend the verification email for a sender identity. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/resend-sender-verification.ts) |
| `search-contacts` | Search marketing contacts with a SQL-like query. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/search-contacts.ts) |
| `send-mail` | Send an email. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/send-mail.ts) |
| `update-dynamic-template` | Rename a dynamic template. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/update-dynamic-template.ts) |
| `update-segment` | Update a segment's name or query. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/update-segment.ts) |
| `update-sender-identity` | Update a sender identity's details. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/update-sender-identity.ts) |
| `update-suppression-group` | Update an unsubscribe group's name or description. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/update-suppression-group.ts) |
| `update-template-version` | Update a template version's content. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/update-template-version.ts) |
| `upsert-contacts` | Create or update marketing contacts, optionally adding them to lists. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/actions/upsert-contacts.ts) |
| `bounces` | Sync bounced email events. | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/syncs/bounces.ts) |
| `contacts` | Sync a sample of contacts. SendGrid does not offer a paginated or full-export-capable contacts listing endpoint usable here, so this sync only reflects the small recent-contacts sample the API returns and never deletes previously synced records. | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/syncs/contacts.ts) |
| `global-suppressions` | Sync globally unsubscribed email addresses. | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/syncs/global-suppressions.ts) |
| `lists` | Sync lists. | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/syncs/lists.ts) |
| `segments` | Sync segments. | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/syncs/segments.ts) |
| `sender-identities` | Sync verified sender identities. | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/syncs/sender-identities.ts) |
| `stats` | Sync daily email statistics. | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/syncs/stats.ts) |
| `templates` | Sync dynamic templates and their versions. | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/sendgrid/syncs/templates.ts) |
## Access requirements
| Pre-Requisites | Status | Comment |
| ----------------- | ------ | ------- |
| Paid dev account | ❓ | |
| Paid test account | ❓ | |
| Partnership | ❓ | |
| App review | ❓ | |
| Security audit | ❓ | |
## Setup guide
*No setup guide yet.*
Need help getting started? Get help in the [community](https://nango.dev/slack).
Contribute improvements to the setup guide by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/sendgrid.mdx)
## Useful links
* [Generate an API key in your SendGrid account](https://app.sendgrid.com/settings/api_keys)
* [API docs](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/authentication)
* [Auth-related docs](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/authentication#authorization-header)
Contribute useful links by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/sendgrid.mdx)
## API gotchas
Contribute API gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/sendgrid.mdx)
## Going further
Guide to connect to SendGrid using Nango Connect UI.