# How to integrate Sendgrid MCP with Hermes

```json
{
  "title": "How to integrate Sendgrid MCP with Hermes",
  "toolkit": "Sendgrid",
  "toolkit_slug": "sendgrid",
  "framework": "Hermes",
  "framework_slug": "hermes-agent",
  "url": "https://composio.dev/toolkits/sendgrid/framework/hermes-agent",
  "markdown_url": "https://composio.dev/toolkits/sendgrid/framework/hermes-agent.md",
  "updated_at": "2026-05-06T08:27:33.304Z"
}
```

## Introduction

Hermes is a 24/7 autonomous agent that lives on your computer or server — it remembers what it learns and evolves as your usage grows.
This guide explains the easiest and most robust way to connect your Sendgrid account to Hermes. You can do this through either Composio Connect CLI or Composio Connect MCP. For personal use we recommend the CLI, but you won't go wrong with MCP either.

## Also integrate Sendgrid with

- [OpenAI Agents SDK](https://composio.dev/toolkits/sendgrid/framework/open-ai-agents-sdk)
- [Claude Agent SDK](https://composio.dev/toolkits/sendgrid/framework/claude-agents-sdk)
- [Claude Code](https://composio.dev/toolkits/sendgrid/framework/claude-code)
- [Claude Cowork](https://composio.dev/toolkits/sendgrid/framework/claude-cowork)
- [Codex](https://composio.dev/toolkits/sendgrid/framework/codex)
- [OpenClaw](https://composio.dev/toolkits/sendgrid/framework/openclaw)
- [CLI](https://composio.dev/toolkits/sendgrid/framework/cli)
- [Google ADK](https://composio.dev/toolkits/sendgrid/framework/google-adk)
- [LangChain](https://composio.dev/toolkits/sendgrid/framework/langchain)
- [Vercel AI SDK](https://composio.dev/toolkits/sendgrid/framework/ai-sdk)
- [Mastra AI](https://composio.dev/toolkits/sendgrid/framework/mastra-ai)
- [LlamaIndex](https://composio.dev/toolkits/sendgrid/framework/llama-index)
- [CrewAI](https://composio.dev/toolkits/sendgrid/framework/crew-ai)

## TL;DR

### What is Composio Connect?
Composio Connect is a consumer offering that lets anyone plug 1,000+ applications directly into their agent harness — including Hermes. It can:
- Search and load tools from relevant toolkits on-demand, reducing context usage.
- Chain multiple tools to accomplish complex workflows via a remote workbench, without excessive back-and-forth with the LLM.
- Manage app authentication end-to-end with zero manual overhead.

## Connect Sendgrid to Hermes

### Integrating Sendgrid with Hermes
### Using Composio Connect CLI
1. Install the Composio CLI
Run the install script directly, or paste https://composio.dev/hermes into your Hermes chat box to have it installed for you.

```bash
curl -fsSL https://composio.dev/install | bash
```

## What is the Sendgrid MCP server, and what's possible with it?

The Sendgrid MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Sendgrid account. It provides structured and secure access to your email delivery platform, so your agent can perform actions like managing contacts, sending transactional emails, organizing IP pools, and handling suppression lists on your behalf.
- Automated contact and recipient management: Allow your agent to add or update contacts, assign recipients to specific lists, and manage your marketing audiences efficiently.
- Email template and version control: Enable the agent to activate specific template versions, ensuring your email campaigns always use the latest approved content.
- IP pool and address management: Let your agent add IP addresses to pools, authenticated domains, or allow lists, helping you scale and secure your email delivery infrastructure.
- Suppression and compliance automation: Direct the agent to add email addresses to global suppression groups, keeping your mailing lists compliant and minimizing bounces or spam issues.
- Bulk operations for marketing efficiency: Use the agent to perform batch actions like appending multiple IPs to pools or adding large groups of contacts, streamlining high-volume marketing workflows.

## Supported Tools

| Tool slug | Name | Description |
|---|---|---|
| `SENDGRID_ACTIVATE_TEMPLATE_VERSION` | Activate template version | **this endpoint allows you to activate a version of one of your templates.** |
| `SENDGRID_ADD_A_BATCH_OF_IPS_TO_AN_IP_POOL` | Add a batch of ips to an ip pool | This operation appends a batch of ips to an ip pool. this operation requires all ip assignments to succeed. if any ip assignments fail, this endpoint will return an error. |
| `SENDGRID_ADD_AN_IP_ADDRESS_TO_A_POOL` | Add an ip address to a pool | Add an ip address to a pool with this endpoint. activation in sendgrid needed first. it takes up to 60 seconds. possible to add to multiple pools. retrieve ips via a specific endpoint. |
| `SENDGRID_ADD_AN_IP_TO_AN_AUTHENTICATED_DOMAIN` | Add an ip to an authenticated domain | **this endpoint allows you to add an ip address to an authenticated domain.** |
| `SENDGRID_ADD_A_SINGLE_RECIPIENT_TO_A_LIST` | Add a single recipient to a list | **this endpoint allows you to add a single recipient to a list.** |
| `SENDGRID_ADD_A_TWILIO_SEND_GRID_IP_ADDRESS` | Add a twilio sendgrid ip address | This operation adds a twilio sendgrid ip address to your account. you can also assign up to 100 subusers to the ip address at creation. |
| `SENDGRID_ADD_IPS` | Add ips | **this endpoint is for adding a(n) ip address(es) to your account.** |
| `SENDGRID_ADD_ONE_OR_MORE_IPS_TO_THE_ALLOW_LIST` | Add one or more ips to the allow list | This endpoint adds allowed ip addresses to a list, which then assigns each ip an id for future removal; ids can be retrieved via a specific retrieval endpoint. |
| `SENDGRID_ADD_OR_UPDATE_A_CONTACT` | Add or update a contact | The endpoint can handle 30k contacts or 6mb, reports queuing/errors, needs extra steps to confirm changes and retrieve ids. custom fields must pre-exist and exact identifiers are required for updates; email addresses are auto-lowered in case. |
| `SENDGRID_ADD_RECIPIENT_ADDRESSES_TO_THE_GLOBAL_SUPPRESSION_GROUP` | Add recipient addresses to the global suppression group | **this endpoint allows you to add one or more email addresses to the global suppressions group.** |
| `SENDGRID_ADD_SUPPRESSIONS_TO_A_SUPPRESSION_GROUP` | Add suppressions to a suppression group | **this endpoint allows you to add email addresses to an unsubscribe group.** if you attempt to add suppressions to a group that has been deleted or does not exist, the suppressions will be added to the global suppressions list. |
| `SENDGRID_APPROVE_ACCESS_REQUEST` | Approve access request | **this endpoint allows you to approve an access attempt.** **note:** only teammate admins may approve another teammate’s access request. |
| `SENDGRID_ASSIGN_A_BATCH_OF_SUBUSERS_TO_AN_IP` | Assign a batch of subusers to an ip | This operation appends a batch of subusers to a specified ip address. this endpoint requires all subuser assignments to succeed. if a subuser assignment fails, this endpoint will return an error. |
| `SENDGRID_ASSOCIATE_A_BRANDED_LINK_WITH_A_SUBUSER` | Associate a branded link with a subuser | Parent accounts can create and validate branded links, then assign them to subusers through the api or twilio sendgrid app, enabling subusers to use the branded links for mail. |
| `SENDGRID_ASSOCIATE_AN_AUTHENTICATED_DOMAIN_WITH_A_GIVEN_USER` | Associate an authenticated domain with a given user | Associate authenticated domains with subusers under a parent account to enable email sending using the parent's domain. authentication by the parent is required. multiple domains can be linked using the specified endpoint. |
| `SENDGRID_AUTHENTICATE_A_DOMAIN` | Authenticate a domain | The endpoint enables domain authentication for users or subusers, offering two methods—'username' parameter for visibility and modification, or the association workflow for a fixed, non-editable domain assignment. |
| `SENDGRID_AUTHENTICATE_AN_ACCOUNT_WITH_SINGLE_SIGN_ON` | Authenticate an account with single sign on | Authenticates and logs in a user to twilio sendgrid as a specific admin identity configured for sso by partner. any additional teammates or subusers will need to log in directly via app.sendgrid.com |
| `SENDGRID_BIND_AUTHENTICATED_DOMAINS_TO_USER` | Bind authenticated domains to user | This endpoint enables linking up to five authenticated domains from a parent account to a subuser, giving them permission to send emails with the parent's domain. domains are prioritized when sending emails. |
| `SENDGRID_BULK_DELETE_SINGLE_SENDS` | Bulk delete single sends | This api endpoint enables the deletion of multiple single sends by providing their ids. retrieve ids with a get request to `/marketing/singlensends`. deletions are irreversible. |
| `SENDGRID_CANCEL_OR_PAUSE_A_SCHEDULED_SEND` | Cancel or pause a scheduled send | This api endpoint allows users to cancel or pause a scheduled email by providing its `batch id`. to change or remove this status, specific endpoints must be used; exceeding limits or duplicating actions will trigger a `400` error. |
| `SENDGRID_COMPLETED_STEPS` | Completed steps | This api endpoint checks if a sendgrid account has completed domain authentication (`domain verified`) and single sender verification (`sender verified`), returning boolean values for each. |
| `SENDGRID_CREATE_A_BATCH_ID` | Create a batch id | Create a new mail batch id to group email sends, allowing pause or cancel actions via the scheduled sends api. |
| `SENDGRID_CREATE_A_BRANDED_LINK` | Create a branded link | Create a new branded link by specifying the root domain, which must align with your from email, and an optional unique subdomain. subusers can request using the `on-behalf-of` header. |
| `SENDGRID_CREATE_A_CAMPAIGN` | Create a campaign | This endpoint enables campaign creation, requiring a subject, sender id, content (html and text suggested), and a list or segment id for sending or scheduling, but not for initial creation. |
| `SENDGRID_CREATE_A_CUSTOM_FIELD` | Create a custom field | **this endpoint allows you to create a custom field.** **you can create up to 120 custom fields.** |
| `SENDGRID_CREATE_A_LIST` | Create a list | **this endpoint allows you to create a list for your recipients.** |
| `SENDGRID_CREATE_AN_ACCOUNT` | Create an account | Creates a new account, with specified offering, under the organization. |
| `SENDGRID_CREATE_A_NEW_ALERT` | Create a new alert | **this endpoint allows you to create a new alert.** |
| `SENDGRID_CREATE_A_NEW_EVENT_WEBHOOK` | Create a new event webhook | Set up an event webhook by providing a url, choosing events for post requests, and receive a unique id. after creation, you can add names, oauth, and signature verification. |
| `SENDGRID_CREATE_A_NEW_SUPPRESSION_GROUP` | Create a new suppression group | **this endpoint allows you to create a new suppression group.** to add an email address to the suppression group, [create a suppression](https://docs.sendgrid.com/api-reference/suppressions-suppressions/add-suppressions-to-a-suppression-group). |
| `SENDGRID_CREATE_A_NEW_TRANSACTIONAL_TEMPLATE_VERSION` | Create a new transactional template version | **this endpoint allows you to create a new version of a template.** |
| `SENDGRID_CREATE_AN_IP_POOL` | Create an ip pool | Create an ip pool by activating an ip in sendgrid: log in, go to settings > ip addresses, edit selected ip, check to allow sending, and save. |
| `SENDGRID_CREATE_AN_IP_POOL_WITH_A_NAME_AND_IP_ASSIGNMENTS` | Create an ip pool with a name and ip assignments | Creating an ip pool associates specified ips with it. all ips must be successfully assigned, or creation fails with an error. a pool can have up to 100 ips. |
| `SENDGRID_CREATE_AN_SSO_CERTIFICATE` | Create an sso certificate | **this endpoint allows you to create an sso certificate.** |
| `SENDGRID_CREATE_AN_SSO_INTEGRATION` | Create an sso integration | **this endpoint allows you to create an sso integration.** |
| `SENDGRID_CREATE_AN_SSO_TEAMMATE` | Create an sso teammate | Create an sso teammate with email as username. assign roles using `is admin`, `scopes`, or `persona`. admins have full rights, personas have predefined permissions, and scopes are specific rights. teammates can manage subusers with potential limitations. |
| `SENDGRID_CREATE_A_PARSE_SETTING` | Create a parse setting | Create a new inbound parse setting with a twilio sendgrid authenticated `hostname` and a public `url` to receive parsed messages via http post. complete domain authentication and mx record setup as instructed in sendgrid documentation. |
| `SENDGRID_CREATE_API_KEYS` | Create api keys | Use sendgrid app to create an initial api key; then manage others via api. json with 'name' required; 100 key limit. keys have unique ids, default 'full access' unless scopes specified. update scopes with 'update api keys' endpoint. |
| `SENDGRID_CREATE_A_SEGMENT` | Create a segment | New segment endpoint created: supports various operators for date, text, number, and email fields. values must be strings, can specify campaign for email actions. conditions combinable via "and"/"or". |
| `SENDGRID_CREATE_A_SENDER` | Create a sender | This api endpoint is for creating new senders, with a limit of 100. verification is mandatory, either automatic upon domain authentication or via a confirmation email sent to the sender's address. |
| `SENDGRID_CREATE_A_SENDER_IDENTITY` | Create a sender identity | **this endpoint allows you to create a new sender identity.** you may create up to 100 unique sender identities. |
| `SENDGRID_CREATE_A_TRANSACTIONAL_TEMPLATE` | Create a transactional template | **this endpoint allows you to create a transactional template.** |
| `SENDGRID_CREATE_CUSTOM_FIELD_DEFINITION` | Create custom field definition | Create unique case-insensitive custom fields with alphanumeric/underscore names starting with a letter/underscore. save the id for edits/deletes. limited to 500 fields of type date, text, or number. avoid starting with numbers to prevent campaign issues. |
| `SENDGRID_CREATE_DESIGN` | Create design | Create new designs via `/designs` by submitting html content. consider email client limitations and see the guide for best practices. convert html to editable modules in the design library, or use preferred tools/migrate existing designs. |
| `SENDGRID_CREATE_INTEGRATION` | Createintegration | This endpoint creates an integration for email event forwarding. each integration has a maximum number of allowed integration instances per user. for example, users can create up to 10 segment integrations. |
| `SENDGRID_CREATE_LIST` | Create list | This endpoint enables the creation of a new contacts list, which can automate email sending when new contacts are added. a link to the new list is provided in ` metadata`. |
| `SENDGRID_CREATE_SEGMENT` | Create segment | Segment `name` has to be unique. a user can not create a new segment with an existing segment name. |
| `SENDGRID_CREATE_SINGLE_SEND` | Create single send | The endpoint lets you create a single send draft without needing a template id; it now uses `email config`. a set `send at` doesn't schedule it; it must be done through another endpoint or ui. |
| `SENDGRID_CREATE_SUBUSER` | Create subuser | **this endpoint allows you to create a new subuser.** |
| `SENDGRID_CREATE_VERIFIED_SENDER_REQUEST` | Create verified sender request | This endpoint creates a new sender identity via `post`, sends a verification email to `from email`, and requires email verification. to resend, use `/resend/{id}`. for domain authentication, refer to the domain authentication api. |
| `SENDGRID_DELETE_A_BATCH_OF_IPS_FROM_AN_IP_POOL` | Delete a batch of ips from an ip pool | This operation removes a batch of ips from an ip pool. all ips associated with the pool will be unassigned from the deleted pool. however, this operation does not remove the ips from your account. |
| `SENDGRID_DELETE_A_BATCH_OF_SUBUSERS_FROM_AN_IP` | Delete a batch of subusers from an ip | This operation removes a batch of subusers from a specified ip address. |
| `SENDGRID_DELETE_A_BOUNCE` | Delete a bounce | **this endpoint allows you to remove an email address from your bounce list.** |
| `SENDGRID_DELETE_A_BRANDED_LINK` | Delete a branded link | Delete a branded link using this endpoint; successful deletion returns a 204 status. record link details beforehand as they're not provided. subuser deletions are possible with their id in the header. |
| `SENDGRID_DELETE_A_CAMPAIGN` | Delete a campaign | **this endpoint allows you to delete a specific campaign.** |
| `SENDGRID_DELETE_A_CANCELLATION_OR_PAUSE_FROM_A_SCHEDULED_SEND` | Delete a cancellation or pause from a scheduled send | **this endpoint allows you to delete the cancellation/pause of a scheduled send.** scheduled sends cancelled less than 10 minutes before the scheduled time are not guaranteed to be cancelled. |
| `SENDGRID_DELETE_A_CONTACT_IDENTIFIER` | Delete a contact identifier | This endpoint asynchronously deletes an identifier (not the entire contact) from a contact, failing if it's their only one. allowed identifier types are email, phonenumberid, externalid, or anonymousid. |
| `SENDGRID_DELETE_A_CUSTOM_FIELD` | Delete a custom field | **this endpoint allows you to delete a custom field by id.** |
| `SENDGRID_DELETE_A_GLOBAL_SUPPRESSION` | Delete a global suppression | This endpoint removes an email from suppressions, allowing future emails to be sent to it. use with consent or bypass filters for one-off emails. |
| `SENDGRID_DELETE_A_LIST` | Delete a list | **this endpoint allows you to delete a specific recipient list with the given id.** |
| `SENDGRID_DELETE_AN_ACCOUNT` | Delete an account | To delete an organization's account by id: it revokes api keys/sso, removes sendgrid resources like dedicated ips, and stops billing immediately. this action is irreversible. |
| `SENDGRID_DELETE_AN_ALERT` | Delete an alert | **this endpoint allows you to delete an alert.** |
| `SENDGRID_DELETE_AN_AUTHENTICATED_DOMAIN` | Delete an authenticated domain | **this endpoint allows you to delete an authenticated domain.** |
| `SENDGRID_DELETE_AN_IP_POOL` | Delete an ip pool | **this endpoint allows you to delete an ip pool.** |
| `SENDGRID_DELETE_AN_SSO_CERTIFICATE` | Delete an sso certificate | **this endpoint allows you to delete an sso certificate.** you can retrieve a certificate's id from the response provided by the "get all sso integrations" endpoint. |
| `SENDGRID_DELETE_AN_SSO_INTEGRATION` | Delete an sso integration | **this endpoint allows you to delete an idp configuration by id.** you can retrieve the ids for your configurations from the response provided by the "get all sso integrations" endpoint. |
| `SENDGRID_DELETE_A_PARSE_SETTING` | Delete a parse setting | **this endpoint allows you to delete a specific inbound parse setting by hostname.** you can retrieve all your inbound parse settings and their associated host names with the "retrieve all parse settings" endpoint. |
| `SENDGRID_DELETE_API_KEYS` | Delete api keys | **this endpoint allows you to revoke an existing api key using an `api key id`** authentications using a revoked api key will fail after after some small propogation delay. if the api key id does not exist, a `404` status will be returned. |
| `SENDGRID_DELETE_A_RECIPIENT` | Delete a recipient | **this endpoint allows you to delete a single recipient with the given id from your contact database.** > use this to permanently delete your recipients from all of your contact lists and all segments if required by applicable law. |
| `SENDGRID_DELETE_A_REVERSE_DNS_RECORD` | Delete a reverse dns record | This endpoint deletes a reverse dns record, returning a 204 code on success. retrieve record ids using the "retrieve all reverse dns records" endpoint. |
| `SENDGRID_DELETE_A_SEGMENT` | Delete a segment | **this endpoint allows you to delete a segment from your recipients database.** you also have the option to delete all the contacts from your marketing campaigns recipient database who were in this segment. |
| `SENDGRID_DELETE_A_SENDER` | Delete a sender | **this endpoint allows you to delete an existing sender.** |
| `SENDGRID_DELETE_A_SENDER_IDENTITY` | Delete a sender identity | **this endpoint allows you to delete one of your sender identities.** |
| `SENDGRID_DELETE_A_SINGLE_EVENT_WEBHOOK_BY_ID` | Delete a single event webhook by id | Delete a specific event webhook by id with this endpoint. unlike other endpoints which default to the oldest webhook, this requires an id, else it errors to prevent accidental deletions. to disable, not delete, use `enabled` property to `false`. |
| `SENDGRID_DELETE_A_SINGLE_RECIPIENT_FROM_A_SINGLE_LIST` | Delete a single recipient from a single list | **this endpoint allows you to delete a single recipient from a list.** |
| `SENDGRID_DELETE_A_SPECIFIC_BLOCK` | Delete a specific block | **this endpoint allows you to delete a specific email address from your blocks list.** |
| `SENDGRID_DELETE_A_SPECIFIC_INVALID_EMAIL` | Delete a specific invalid email | **this endpoint allows you to remove a specific email address from the invalid email address list.** |
| `SENDGRID_DELETE_A_SPECIFIC_SPAM_REPORT` | Delete a specific spam report | This endpoint removes a spam report for an email, lifting suppression and allowing email to be sent to that address. use with caution and recipient consent, or use bypass filters for exceptions. |
| `SENDGRID_DELETE_A_SUBUSER` | Delete a subuser | **this endpoint allows you to delete a subuser.** this is a permanent action. once deleted, a subuser cannot be retrieved. |
| `SENDGRID_DELETE_A_SUPPRESSION_FROM_A_SUPPRESSION_GROUP` | Delete a suppression from a suppression group | This endpoint removes an email from a suppression group, re-enabling email delivery unless specified otherwise, and should only be used when recipients opt back in. |
| `SENDGRID_DELETE_A_SUPPRESSION_GROUP` | Delete a suppression group | This api endpoint deletes email suppression groups. deleted group members get globally suppressed if they unsubscribe. use with caution, only if recipients want to resubscribe. bypass filters available for exceptions. |
| `SENDGRID_DELETE_A_TEMPLATE` | Delete a template | **this endpoint allows you to delete a transactional template.** |
| `SENDGRID_DELETE_A_TRANSACTIONAL_TEMPLATE_VERSION` | Delete a transactional template version | **this endpoint allows you to delete a transactional template version.** |
| `SENDGRID_DELETE_BLOCKS` | Delete blocks | This endpoint enables clearing blocked emails either by deleting all with `delete all`=true or by specifying addresses in the `emails` array. |
| `SENDGRID_DELETE_BOUNCES` | Delete bounces | This api endpoint lets users delete bounced emails: either all by setting `delete all` to true, or specific ones by listing them in `emails`. do not use both options together. |
| `SENDGRID_DELETE_BULK_INTEGRATION` | Deletebulkintegration | This endpoint deletes integrations. |
| `SENDGRID_DELETE_CONTACTS` | Delete contacts | Use this endpoint to bulk delete contacts with `ids` as a list of ids or `delete all contacts` set to `"true"` for all. deletions are asynchronous. regularly export contacts as a backup. |
| `SENDGRID_DELETE_CUSTOM_FIELD_DEFINITION` | Delete custom field definition | **this endpoint deletes a defined custom field.** you can delete only custom fields; reserved fields cannot be deleted. |
| `SENDGRID_DELETE_DESIGN` | Delete design | **this endpoint allows you to delete a single design**. be sure to check the id of the design you intend to delete before making this request; deleting a design is a permanent action. |
| `SENDGRID_DELETE_INVALID_EMAILS` | Delete invalid emails | This endpoint lets you delete email addresses from your invalid list; delete all by setting `delete all` to true, or specify individual addresses to remove. |
| `SENDGRID_DELETE_IP_POOL` | Delete ip pool | This operation deletes an ip pool and unassigns all ip addresses associated with the pool. ip addresses associated with the deleted pool will remain in your account. |
| `SENDGRID_DELETE_PENDING_TEAMMATE` | Delete pending teammate | **this endpoint allows you to delete a pending teammate invite.** |
| `SENDGRID_DELETE_SEGMENT` | Delete segment | **this endpoint allows you to delete a segment by id.** |
| `SENDGRID_DELETE_SINGLE_SEND_BY_ID` | Delete single send by id | This endpoint lets you delete a single send with its id, which you can obtain by a get request to `/marketing/singlensends`. note: deletion is irreversible. |
| `SENDGRID_DELETE_SINGLE_SEND_SCHEDULE` | Delete single send schedule | Cancel a scheduled single send by making a delete request with its id to the endpoint. this action doesn't delete the single send content, only stops the send-out. |
| `SENDGRID_DELETE_SPAM_REPORTS` | Delete spam reports | This endpoint lets users delete spam reports, lifting email suppression for specified addresses. it's advised only when recipients want to resume emails. two deletion methods: 'delete all' or listing emails. use 'bypass filters' for exceptions. |
| `SENDGRID_DELETE_TEAMMATE` | Delete teammate | **this endpoint allows you to delete a teammate.** **only the parent user or an admin teammate can delete another teammate.** |
| `SENDGRID_DELETE_VERIFIED_SENDER` | Delete verified sender | Use this endpoint with a sender identity's `id` to remove it from your account. find sender identity ids through the "get all verified senders" endpoint. |
| `SENDGRID_DENY_ACCESS_REQUEST` | Deny access request | **this endpoint allows you to deny an attempt to access your account.** **note:** only teammate admins may delete a teammate's access request. |
| `SENDGRID_DISASSOCIATE_A_BRANDED_LINK_FROM_A_SUBUSER` | Disassociate a branded link from a subuser | The endpoint permits parent accounts to remove a branded link from a subuser, with successful disassociations confirmed by a 204 status code response. |
| `SENDGRID_DISASSOCIATE_AN_AUTHENTICATED_DOMAIN_FROM_A_GIVEN_USER` | Disassociate an authenticated domain from a given user | Disassociate an authenticated domain from a given user. |
| `SENDGRID_DOMAIN_WARN_LIST` | Domain warn list | The endpoint provides a list of domains with dmarc, divided by how they fail (hard or soft). hard failures prevent mail delivery using those domains as sender identities. for more on dmarc, visit sendgrid's guide. |
| `SENDGRID_DOWNLOAD_CSV` | Download csv | **this endpoint will return a presigned url that can be used to download the csv that was requested from the "request a csv" endpoint.** |
| `SENDGRID_DUPLICATE_A_TRANSACTIONAL_TEMPLATE` | Duplicate a transactional template | **this endpoint allows you to duplicate a transactional template.** |
| `SENDGRID_DUPLICATE_DESIGN` | Duplicate design | This endpoint duplicates existing designs without requiring data in the request body. if you don't specify a `name`, it's labeled "duplicate:" plus the original's name, but you can set a new name upon creation. each copy gets a unique id. |
| `SENDGRID_DUPLICATE_SEND_GRID_PRE_BUILT_DESIGN` | Duplicate sendgrid pre built design | The endpoint lets you duplicate twilio sendgrid pre-built designs without data. if unnamed, "duplicate:" precedes the original name. the copy gets a unique id, modifiable upon creation. use "list sendgrid pre-built designs" for ids. |
| `SENDGRID_DUPLICATE_SINGLE_SEND` | Duplicate single send | This endpoint duplicates single sends using an id for easy creation, allowing edits via patch. duplicates are named as "copy of" the original, with a 100-character limit for names. |
| `SENDGRID_EDIT_AN_SSO_TEAMMATE` | Edit an sso teammate | This endpoint allows admin or parent users to adjust sso teammate permissions using 'is admin', 'scopes', or 'persona', and to control subuser access, including restrictions. |
| `SENDGRID_EDIT_A_TRANSACTIONAL_TEMPLATE` | Edit a transactional template | This endpoint lets you change the name of a transactional template. for template modifications, create a new version using the provided link. |
| `SENDGRID_EDIT_A_TRANSACTIONAL_TEMPLATE_VERSION` | Edit a transactional template version | **this endpoint allows you to edit the content of your template version.** |
| `SENDGRID_EDIT_VERIFIED_SENDER` | Edit verified sender | Update a sender identity by sending a `patch` request with the `id` and json-formatted changes. unchanged fields will stay the same. retrieve ids via `get` to `/verified senders`. |
| `SENDGRID_EMAIL_DNS_RECORDS_TO_A_CO_WORKER` | Email dns records to a co worker | Use sendgrid for domain validation and branding by sharing dns records—cname for automated security, or txt/mx otherwise. include `link id` for link branding and `domain id` for domain auth. |
| `SENDGRID_ENABLE_DISABLE_A_SUBUSER` | Enable disable a subuser | **this endpoint allows you to enable or disable a subuser.** |
| `SENDGRID_ENABLE_DISABLE_WEBSITE_ACCESS_FOR_A_SUBUSER` | Enable disable website access for a subuser | Enable/disable website access for a subuser, while still preserving email send functionality. |
| `SENDGRID_ERASE_RECIPIENTS_EMAIL_DATA` | Erase recipients email data | Sendgrid's delete recipients' email data operation removes personal data of up to 5,000 unique email recipients or a 256kb payload per request. invalid emails return an error, and deletions are account-specific, not affecting subusers. |
| `SENDGRID_EXPORT_CONTACTS` | Export contacts | Use the endpoint to export contact lists or segments by email, with notifications, or download as csvs using an 'id'. specify the data by id and choose json or csv output with a max file size option. |
| `SENDGRID_EXPORT_CONTACTS_STATUS` | Export contacts status | Use this endpoint with an `id` from "export contacts" to check the status and get `urls` for downloading your csv contact export files. regular exports are recommended for backups. |
| `SENDGRID_EXPORT_SINGLE_SEND_STATS` | Export single send stats | This endpoint exports single send stats in .csv format, allowing specification of multiple single sends by separating their ids with commas in the `ids` parameter. |
| `SENDGRID_FILTER_ALL_MESSAGES` | Filter all messages | Summarize email activity filtering: use url-encoded queries in the format `query={type}="{content}"` to search email activity. example: filter by email with `query=to email%3d"example@example.com"`. reference more at sendgrid query reference. |
| `SENDGRID_FILTER_MESSAGES_BY_MESSAGE_ID` | Filter messages by message id | Get all of the details about the specified message. |
| `SENDGRID_FILTER_SEGMENTS_BY_PARENT_IDS` | Filtersegmentsbyparentids | Retrieve segments using `parent list ids` as a filter. an empty or unmatched query returns an empty result with a 200 code. filters combine `parent list ids` and the absence or presence of `no parent list id` with segment ids. |
| `SENDGRID_GET_ACCOUNT_OFFERINGS` | Get account offerings | Retrieves offering information about the specified account. |
| `SENDGRID_GET_A_CONTACT_BY_ID` | Get a contact by id | **this endpoint returns the full details and all fields for the specified contact**. the "get contacts by identifier" endpoint can be used to get the id of a contact. |
| `SENDGRID_GET_A_LIST_BY_ID` | Get a list by id | This endpoint fetches detailed information on a list. using `contact sample=true` includes up to 50 recent contacts and the total contact count in the response. |
| `SENDGRID_GET_A_LIST_OF_ALL_IP_ADDRESSES_ON_YOUR_ACCOUNT` | Get a list of all ip addresses on your account | Fetches your account's ip addresses with details such as pool association and warm-up status. 'is parent assigned' and 'pool' must be exclusive. pagination needs 'limit' and 'before key' or 'after key'. |
| `SENDGRID_GET_A_LIST_OF_ALL_SENDERS` | Get a list of all senders | **this endpoint allows you to get a list of all your senders.** |
| `SENDGRID_GET_A_LIST_OF_SUBUSERS_ASSIGNED_TO_AN_IP` | Get a list of subusers assigned to an ip | The api lists subuser ids with a specific ip, retrieves up to 100 per request, and iterates with `after key` for more. use [subusers api](https://docs.sendgrid.com/api-reference/subusers-api/list-all-subusers) for details. |
| `SENDGRID_GET_ALL_ACCOUNTS` | Get all accounts | Retrieves all accounts under the organization. |
| `SENDGRID_GET_ALL_AUTOMATION_STATS` | Get all automation stats | Retrieve all your automation stats by default or specify with 'automation ids'. results are paginated with customizable 'page size' (1-50, default 25) and 'page token' for specific pages. |
| `SENDGRID_GET_ALL_AVAILABLE_OFFERINGS` | Get all available offerings | Retrieves offerings available under the organization. |
| `SENDGRID_GET_ALL_CATEGORIES` | Get all categories | **this endpoint allows you to retrieve all the categories associated with your single sends.** this endpoint will return your latest 1,000 categories. |
| `SENDGRID_GET_ALL_EXISTING_EXPORTS` | Get all existing exports | This endpoint provides an array with details on active or completed export jobs. each object includes `export type`, `status`, and downloadable `urls` for ready exports. useful when export ids are unknown. |
| `SENDGRID_GET_ALL_FIELD_DEFINITIONS` | Get all field definitions | **this endpoint retrieves all defined custom fields and reserved fields.** |
| `SENDGRID_GET_ALL_IP_POOLS_THAT_HAVE_ASSOCIATED_IPS` | Get all ip pools that have associated ips | The function lists your ip pools and samples up to 10 ips from each. for more ips per pool, use "get ips assigned to an ip pool." max of 100 ip pools per user. |
| `SENDGRID_GET_ALL_LISTS` | Get all lists | **this endpoint returns an array of all of your contact lists.** |
| `SENDGRID_GET_ALL_SENDER_IDENTITIES` | Get all sender identities | **this endpoint allows you to retrieve a list of all sender identities that have been created for your account.** |
| `SENDGRID_GET_ALL_SINGLE_SENDS` | Get all single sends | Retrieve a list of your single sends with brief details, including their ids. for in-depth information on a specific single send, use its id at the `/marketing/singlesends/{id}` endpoint. |
| `SENDGRID_GET_ALL_SINGLE_SENDS_STATS` | Get all single sends stats | Retrieve single sends stats with options for filtering by ids, pagination, and custom page sizes from 1-50. default response batch is 25. |
| `SENDGRID_GET_ALL_SSO_CERTIFICATES_BY_INTEGRATION` | Get all sso certificates by integration | **this endpoint allows you to retrieve all your idp configurations by configuration id.** the `integration id` expected by this endpoint is the `id` returned in the response by the "get all sso integrations" endpoint. |
| `SENDGRID_GET_ALL_SSO_INTEGRATIONS` | Get all sso integrations | **this endpoint allows you to retrieve all sso integrations tied to your twilio sendgrid account.** the ids returned by this endpoint can be used by the apis additional endpoints to modify your sso integrations. |
| `SENDGRID_GET_ALL_VERIFIED_SENDERS` | Get all verified senders | Retrieve all sender identities (verified/unverified) for an account via an endpoint. customize results using `limit`, `lastseenid`, and `id` parameters to define the results scope. |
| `SENDGRID_GET_AN_ACCOUNT_S_STATE` | Get an account s state | Retrieve the state of the specified account. |
| `SENDGRID_GET_AN_SSO_CERTIFICATE` | Get an sso certificate | **this endpoint allows you to retrieve an individual sso certificate.** |
| `SENDGRID_GET_AN_SSO_INTEGRATION` | Get an sso integration | **this endpoint allows you to retrieve an sso integration by id.** you can retrieve the ids for your configurations from the response provided by the "get all sso integrations" endpoint. |
| `SENDGRID_GET_A_SPECIFIC_SENDER` | Get a specific sender | **this endpoint allows you to get the details for a specific sender by `id`.** |
| `SENDGRID_GET_A_USER_S_ACCOUNT_INFORMATION` | Get a user s account information | **this endpoint allows you to retrieve your user account details.** your user's account information includes the user's account type and reputation. |
| `SENDGRID_GET_A_USER_S_PROFILE` | Get a user s profile | **this endpoint allows you to retrieve your current profile details.** |
| `SENDGRID_GET_AUTOMATION_CLICK_TRACKING_STATS_BY_ID` | Get automation click tracking stats by id | **this endpoint lets you retrieve click-tracking stats for a single automation**. the stats returned list the urls embedded in your automation and the number of clicks each one received. |
| `SENDGRID_GET_AUTOMATION_STATS_BY_ID` | Get automation stats by id | Retrieve detailed stats for a specific automation by id, with optional date and aggregation filters, or use another endpoint to get stats for multiple automations. |
| `SENDGRID_GET_BATCHED_CONTACTS_BY_IDS` | Get batched contacts by ids | This endpoint fetches multiple contacts using their ids, allowing up to 100 ids per request for efficiency over single `get` requests. regular export of contacts is advised for backup. |
| `SENDGRID_GET_BOUNCE_CLASS_STATS` | Get bounce class stats | This endpoint will return the number of bounces for the classification specified in descending order for each day. you can retrieve the bounce classification totals in csv format by specifying `"text/csv"` in the accept header. |
| `SENDGRID_GET_CONTACTS_BY_EMAILS` | Get contacts by emails | Endpoint retrieves up to 100 contacts by email, ignoring case/space; simpler than sgql's search. success returns `200`, `404` for no match, `400` for invalid emails. regular contact backups recommended. |
| `SENDGRID_GET_CONTACTS_BY_IDENTIFIERS` | Get contacts by identifiers | Use the endpoint to fetch up to 100 contacts by identifiers (email, phone number, etc.). successful queries return 200, no results return 404, and errors return 400. regular backups are advised. |
| `SENDGRID_GET_DESIGN` | Get design | Access a specific design's details in your design library with a get request to `/designs/{id}`. this endpoint is useful for obtaining info to update via patch request. |
| `SENDGRID_GET_DETAILS_FOR_AN_IP_ADDRESS` | Get details for an ip address | The operation provides details for an ip address, such as its parent account status, warm-up settings, associated pools, add/modify dates, lease status, and enablement, excluding subuser info, which requires a different endpoint. |
| `SENDGRID_GET_DETAILS_FOR_AN_IP_POOL` | Get details for an ip pool | This operation retrieves details of an ip pool, such as name, id, some sample ips (up to 10), and the total ip count. for more ips, use "get ips assigned to an ip pool." |
| `SENDGRID_GET_ENGAGEMENT_QUALITY_SCORES` | Get engagement quality scores | Retrieve your sendgrid engagement quality (seq) scores via api for a chosen date range. get a `200` response for available scores, or a `202` if scores haven't been calculated yet. scores range from 1 to 5, higher indicating better engagement. |
| `SENDGRID_GET_INFORMATION_ON_A_SINGLE_SUPPRESSION_GROUP` | Get information on a single suppression group | **this endpoint allows you to retrieve a single suppression group.** |
| `SENDGRID_GET_INTEGRATION` | Getintegration | This endpoint returns the data for a specific integration. |
| `SENDGRID_GET_IPS_ASSIGNED_TO_AN_IP_POOL` | Get ips assigned to an ip pool | This operation returns the ip addresses that are assigned to the specified ip pool. |
| `SENDGRID_GET_LIST_CONTACT_COUNT` | Get list contact count | **this endpoint returns the number of contacts on a specific list.** |
| `SENDGRID_GET_LIST_OF_SEGMENTS` | Get list of segments | The api endpoint retrieves segments, using `parent list ids` to filter results. if no matches are found, a 200 code with an empty array is returned. filters include list ids, absence of parent ids, or specific segment ids. |
| `SENDGRID_GET_OPEN_TRACKING_SETTINGS` | Get open tracking settings | The endpoint retrieves settings for tracking email opens using an invisible image. it logs open events when images load, with data available in sendgrid's statistics portal and event webhook. |
| `SENDGRID_GET_RECIPIENT_UPLOAD_STATUS` | Get recipient upload status | **this endpoint allows you to check the upload status of a marketing campaigns recipient.** |
| `SENDGRID_GET_REMAINING_IPS_COUNT` | Get remaining ips count | **this endpoint gets amount of ip addresses that can still be created during a given period and the price of those ips.** |
| `SENDGRID_GET_SAMPLE_CONTACTS` | Get sample contacts | The endpoint returns the latest 50 contacts, sorted by email, with the total count included. pagination is deprecated; regular export of contacts is advised. |
| `SENDGRID_GET_SEGMENT_BY_ID` | Get segment by id | Get marketing campaigns segment by id |
| `SENDGRID_GET_SEND_GRID_PRE_BUILT_DESIGN` | Get sendgrid pre built design | The endpoint `/designs/pre-builts/{id}` is used to fetch details about a particular pre-built design for duplication and modification. |
| `SENDGRID_GET_SIGNED_EVENT_WEBHOOK_S_PUBLIC_KEY` | Get signed event webhook s public key | Retrieve a webhook's public key using its id via this endpoint; if no id is given, the oldest key is returned. useful for signature verification and toggling signature settings. multiple ids can be found using the "get all event webhooks" endpoint. |
| `SENDGRID_GET_SINGLE_SEND_BY_ID` | Get single send by id | **this endpoint allows you to retrieve details about one single send using a single send id.** you can retrieve all of your single sends by making a get request to the `/marketing/singlesends` endpoint. |
| `SENDGRID_GET_SINGLE_SEND_CLICK_TRACKING_STATS_BY_ID` | Get single send click tracking stats by id | **this endpoint lets you retrieve click-tracking stats for one single send**. the stats returned list the urls embedded in the specified single send and the number of clicks each one received. |
| `SENDGRID_GET_SINGLE_SENDS_SEARCH` | Get single sends search | Search for single sends by specifying `name`, `status`, and `categories` in the request body. example provided for drafts or scheduled items related to "shoes". |
| `SENDGRID_GET_SINGLE_SEND_STATS_BY_ID` | Get single send stats by id | Retrieve individual single send stats using its id. for multiple ids, use "get all single sends stats". filter results by date or refine with `group by` and `aggregated by` parameters. |
| `SENDGRID_GET_SUBUSER_MONTHLY_STATS` | Get subuser monthly stats | Retrieve monthly email stats for subusers with `sort by metric`, excluding sorts by `bounce drops`, `deferred`, `invalid emails`, `processed`, `spam report drops`, `spam reports`, `unsubscribe drops`. |
| `SENDGRID_GET_SUBUSERS_ENGAGEMENT_QUALITY_SCORES` | Get subusers engagement quality scores | Retrieve seq scores for sendgrid subusers/accounts on a specific date; expect ‘200’ with scores or ‘202’ if unavailable yet, possibly accessible later. scores range from 1-5, with higher numbers indicating better engagement. |
| `SENDGRID_GET_SUPPRESSION_GROUPS` | Get suppression groups | This endpoint provides a list of user-created suppression groups and can return info for multiple groups when their ids are added to the request with `?id=123456`. |
| `SENDGRID_GET_TEAMMATE_SUBUSER_ACCESS` | Get teammate subuser access | Retrieve subusers accessible to a specified teammate, with available scopes. admin teammates get access to all subusers. |
| `SENDGRID_GET_THE_CREDITS_FOR_A_SUBUSER` | Get the credits for a subuser | **this endpoint allows you to retrieve a credits overview for a subuser.** |
| `SENDGRID_GET_THE_DEFAULT_AUTHENTICATION` | Get the default authentication | This endpoint fetches the default domain authentication, used for sending all mail unless overridden by a 'from' address match. it provides domain details if a default is set; otherwise, it gives general authentication info. |
| `SENDGRID_GET_THE_SETTINGS_FOR_A_SINGLE_EVENT_WEBHOOK` | Get the settings for a single event webhook | Retrieve an event webhook by id to get settings, event types, and url details. without id, the oldest is returned. signatures and oauth webhooks have extra properties. use another endpoint for multiple webhook ids. |
| `SENDGRID_GET_TOTAL_CONTACT_COUNT` | Get total contact count | **this endpoint returns the total number of contacts you have stored.** twilio sendgrid recommends exporting your contacts regularly as a backup to avoid issues or lost data. |
| `SENDGRID_GET_USER_SCOPES` | Retrieve a list of scopes for which this user has access | Retrieve a list of scopes for which this user has access |
| `SENDGRID_IMPORT_CONTACTS` | Import contacts | The endpoint permits async csv uploads for up to 1m contacts or 5gb with specified identifiers and file type, supports gzip, field mappings, uses job id for tracking, and recommends regular backups. |
| `SENDGRID_IMPORT_CONTACTS_STATUS` | Import contacts status | Check the status of contact import jobs using `job id` via this endpoint. it shows if the job is pending, completed, errored, or failed. for errors, download the `errors url` file. regular contact exports are advised for backup. |
| `SENDGRID_INVITE_TEAMMATE` | Invite teammate | Invite teammates to your account through email with this endpoint, assigning initial permissions via the `scopes` array. invites expire after 7 days but can be resent. |
| `SENDGRID_LIST_ALL_AUTHENTICATED_DOMAINS` | List all authenticated domains | Retrieve authenticated domain lists in pages using the `limit` parameter for page size and `offset` to start from specific list positions. multiple requests handle large lists. |
| `SENDGRID_LIST_ALL_SUBUSERS` | List all subusers | Retrieve a paginated list of subusers with filtering options. use `username` to filter, `limit` to set page size, and `offset` to navigate through the list. |
| `SENDGRID_LIST_API_KEYS` | List api keys | Retrieve user's api key names and ids with this endpoint; keys themself cannot be retrieved for security. lost keys require recreation. use 'api key id' to manage keys. |
| `SENDGRID_LIST_BULK_EMAIL_VALIDATION_JOBS` | List Bulk Email Validation Jobs | **this endpoint returns a list of all of a user's bulk email validation jobs.** |
| `SENDGRID_LIST_DESIGNS` | List designs | The `/designs` endpoint fetches a list of user's stored designs, restricted to 100 per request by default but adjustable with `page size`. pre-built designs are at `/designs/pre-builts`. |
| `SENDGRID_LIST_INTEGRATION` | Listintegration | This endpoint returns all the integrations for the user making this call. |
| `SENDGRID_LIST_SEND_GRID_PRE_BUILT_DESIGNS` | List sendgrid pre built designs | The `designs/pre-builts` endpoint fetches a list of twilio sendgrid's ready-made designs, not user-specific ones, with 100 results per request by default, adjustable with `page size`. useful for duplicating and editing design ids. |
| `SENDGRID_LIST_USER_AUTH_DOMAINS` | List the authenticated domain associated with the given user | Parent accounts can link validated domains to subusers through an endpoint, allowing subusers to email from those domains. the api supports multiple domain associations and listings. |
| `SENDGRID_MANUALLY_REFRESH_A_SEGMENT` | Manually refresh a segment | Manually refresh a segment by segment id. |
| `SENDGRID_PRESIGNED_URL_HEADERS_FOR_BULK_EMAIL_VALIDATION` | Presigned url headers for bulk email validation | Get a presigned url and headers to upload an email list for verification. ensure the 'content-type' matches 'file type' in the 'put' request. visit the bulk validation overview page for format and sample request. |
| `SENDGRID_REMOVE_AN_IP_ADDRESS_FROM_A_POOL` | Remove an ip address from a pool | **this endpoint allows you to remove an ip address from an ip pool.** |
| `SENDGRID_REMOVE_AN_IP_FROM_AN_AUTHENTICATED_DOMAIN` | Remove an ip from an authenticated domain | **this endpoint allows you to remove an ip address from that domain's authentication.** |
| `SENDGRID_REMOVE_A_SPECIFIC_IP_FROM_THE_ALLOWED_LIST` | Remove a specific ip from the allowed list | This endpoint lets you delete an allowed ip address using its id, obtainable via the "retrieve allowed ips" endpoint. |
| `SENDGRID_REMOVE_CONTACTS_FROM_A_LIST` | Remove contacts from a list | **this endpoint allows you to remove contacts from a given list.** the contacts will not be deleted. only their list membership will be changed. |
| `SENDGRID_REMOVE_LIST_AND_OPTIONAL_CONTACTS` | Remove list and optional contacts | **this endpoint allows you to deletes a specific list.** optionally, you can also delete contacts associated to the list. the query parameter, `delete contacts=true`, will delete the list and start an asynchronous job to delete associated contacts. |
| `SENDGRID_REMOVE_ONE_OR_MORE_IPS_FROM_THE_ALLOW_LIST` | Remove one or more ips from the allow list | This endpoint lets you remove ips from your allowed list by sending an array of their ids, obtained from another endpoint. carefully select ips to avoid blocking your account access. if blocked, submit a support ticket. |
| `SENDGRID_REMOVE_SEGMENT_WITHOUT_AFFECTING_CONTACTS` | Remove segment without affecting contacts | This endpoint permits the deletion of a segment using `segment id`, but associated contacts remain in the overall list and any other segments they're part of. |
| `SENDGRID_RENAME_AN_IP_POOL` | Rename an ip pool | **this endpoint allows you to update the name of an ip pool.** |
| `SENDGRID_REQUEST_CSV` | Request csv | Initiating a backend process creates a csv file of up to 1 million events from the last 30 days, emailed to the user with a 3-day expiry link. limited to one request per 12 hours, it's similar to the get single message but for csv downloads. |
| `SENDGRID_RESEND_A_SENDER_VERIFICATION` | Resend a sender verification | **this endpoint allows you to resend the verification request for a specific sender.** |
| `SENDGRID_RESEND_SENDER_IDENTITY_VERIFICATION` | Resend sender identity verification | **this endpoint allows you to resend a sender identity verification email.** |
| `SENDGRID_RESEND_TEAMMATE_INVITE` | Resend teammate invite | **this endpoint allows you to resend a teammate invitation.** teammate invitations will expire after 7 days. resending an invitation will reset the expiration date. |
| `SENDGRID_RESEND_VERIFIED_SENDER_REQUEST` | Resend verified sender request | This endpoint resends a verification email to a sender identity's 'from address' by using the 'id' of the sender. useful if the original email is lost or needs to be resent. retrieve ids via "get all verified senders" endpoint. |
| `SENDGRID_RETRIEVE_A_BOUNCE` | Retrieve a bounce | **this endpoint allows you to retrieve a specific bounce by email address.** |
| `SENDGRID_RETRIEVE_A_BRANDED_LINK` | Retrieve a branded link | **this endpoint allows you to retrieve a specific branded link by providing its id.** you can submit this request as one of your subusers if you include their id in the `on-behalf-of` header in the request. |
| `SENDGRID_RETRIEVE_ACCESS_REQUESTS` | Retrieve access requests | Retrieve a list of recent access requests using pagination with `limit` for page size and `offset` to control the start position for additional items. |
| `SENDGRID_RETRIEVE_A_COUNT_OF_RECIPIENTS` | Retrieve a count of recipients | **this endpoint allows you to retrieve the total number of marketing campaigns recipients.** |
| `SENDGRID_RETRIEVE_A_CUSTOM_FIELD` | Retrieve a custom field | **this endpoint allows you to retrieve a custom field by id.** |
| `SENDGRID_RETRIEVE_ADDRESS_WHITELIST_MAIL_SETTINGS` | Retrieve address whitelist mail settings | This endpoint lets you access settings for whitelisting specific emails or domains to prevent email suppression due to bounces, blocks, or unsubscribes. |
| `SENDGRID_RETRIEVE_A_GLOBAL_SUPPRESSION` | Retrieve a global suppression | This endpoint retrieves global email suppressions and confirms if an email is suppressed. if suppressed, the email is returned in the response; if not, an empty json object is returned. |
| `SENDGRID_RETRIEVE_A_LIST_OF_CURRENTLY_ALLOWED_IPS` | Retrieve a list of currently allowed ips | This endpoint provides a list of authorized ip addresses for your account, each with creation, update dates, and a unique id for potential removal. |
| `SENDGRID_RETRIEVE_ALL_ALERTS` | Retrieve all alerts | **this endpoint allows you to retrieve all of your alerts.** |
| `SENDGRID_RETRIEVE_ALL_ASSIGNED_IPS` | Retrieve all assigned ips | This api endpoint retrieves assigned ip addresses used to send emails for various domains, where the ip's reputation is influenced by the collective performance of all sending users. |
| `SENDGRID_RETRIEVE_ALL_BLOCKS` | Retrieve all blocks | Retrieve a paginated list of blocked emails using this endpoint, with adjustable page sizes via the 'limit' parameter and starting points with 'offset' for multiple requests. |
| `SENDGRID_RETRIEVE_ALL_BOUNCES` | Retrieve all bounces | This endpoint retrieves a paginated list of all your bounces, allowing customization of page size with `limit` and starting position with `offset` for multiple requests. |
| `SENDGRID_RETRIEVE_ALL_BRANDED_LINKS` | Retrieve all branded links | **this endpoint allows you to retrieve all branded links**. you can submit this request as one of your subusers if you include their id in the `on-behalf-of` header in the request. |
| `SENDGRID_RETRIEVE_ALL_CAMPAIGNS` | Retrieve all campaigns | Retrieve a paginated list of campaigns in reverse creation order with the api endpoint. if none exist, get an empty array. adjust page size with `limit`, and fetch more with `offset`. |
| `SENDGRID_RETRIEVE_ALL_CATEGORIES` | Retrieve all categories | This endpoint provides a paginated list of user categories, with adjustable page size using the `limit` and pagination control using `offset`. multiple requests are needed for large lists. |
| `SENDGRID_RETRIEVE_ALL_CUSTOM_FIELDS` | Retrieve all custom fields | **this endpoint allows you to retrieve all custom fields.** |
| `SENDGRID_RETRIEVE_ALL_GLOBAL_SUPPRESSIONS` | Retrieve all global suppressions | Retrieve paginated lists of globally suppressed emails using `limit` for page size and `offset` to start from a specific list position. multiple requests may be needed for large lists. |
| `SENDGRID_RETRIEVE_ALL_INVALID_EMAILS` | Retrieve all invalid emails | Retrieve paginated lists of invalid emails with 'limit' for page size and 'offset' to start from a specific position for lists exceeding the limit. |
| `SENDGRID_RETRIEVE_ALL_IP_ADDRESSES` | Retrieve all ip addresses | Retrieve a paginated list of assigned/unassigned ips with warmup status, pools, subusers, and dns info. ip reputation is based on email traffic. use `limit` and `offset` parameters to control pagination. |
| `SENDGRID_RETRIEVE_ALL_IP_POOLS` | Retrieve all ip pools | **this endpoint allows you to get all of your ip pools.** |
| `SENDGRID_RETRIEVE_ALL_IP_POOLS_AN_IP_ADDRESS_BELONGS_TO` | Retrieve all ip pools an ip address belongs to | This endpoint checks which ip pools contain a specific ip, which may be shared across multiple ip pools and affect the ip's reputation based on collective usage for email sending. |
| `SENDGRID_RETRIEVE_ALL_IPS_CURRENTLY_IN_WARMUP` | Retrieve all ips currently in warmup | **this endpoint allows you to retrieve all of your ip addresses that are currently warming up.** |
| `SENDGRID_RETRIEVE_ALL_LISTS` | Retrieve all lists | **this endpoint allows you to retrieve all of your recipient lists. if you don't have any lists, an empty array will be returned.** |
| `SENDGRID_RETRIEVE_ALL_MAIL_SETTINGS` | Retrieve all mail settings | Retrieve a paginated list of mail settings with their `enabled` status and descriptions. control page size with `limit` and list position with `offset` for multiple requests. |
| `SENDGRID_RETRIEVE_ALL_OF_YOUR_EVENT_WEBHOOKS` | Retrieve all of your event webhooks | The endpoint fetches all event webhooks as objects in an array, showing each webhook's configuration and id, used to update, delete, or manage signature verification and oauth settings. |
| `SENDGRID_RETRIEVE_ALL_PARSE_SETTINGS` | Retrieve all parse settings | **this endpoint allows you to retrieve all of your current inbound parse settings.** |
| `SENDGRID_RETRIEVE_ALL_PENDING_TEAMMATES` | Retrieve all pending teammates | **this endpoint allows you to retrieve a list of all pending teammate invitations.** each teammate invitation is valid for 7 days. users may resend the invitation to refresh the expiration date. |
| `SENDGRID_RETRIEVE_ALL_RECENT_ACCESS_ATTEMPTS` | Retrieve all recent access attempts | **this endpoint allows you to retrieve a list of all of the ip addresses that recently attempted to access your account either through the user interface or the api.** |
| `SENDGRID_RETRIEVE_ALL_RECIPIENTS_ON_A_LIST` | Retrieve all recipients on a list | **this endpoint allows you to retrieve all recipients on the list with the given id.** |
| `SENDGRID_RETRIEVE_ALL_REVERSE_DNS_RECORDS` | Retrieve all reverse dns records | The endpoint provides a paginated list of reverse dns records, with optional ip prefix search and adjustable page size using 'limit' and 'offset' parameters. |
| `SENDGRID_RETRIEVE_ALL_SCHEDULED_SENDS` | Retrieve all scheduled sends | The endpoint provides details of cancelled or paused scheduled sends but only if they have a `batch id`. sends scheduled without a `batch id` via `/mail/send` won't be listed and can't be paused or cancelled later through this endpoint. |
| `SENDGRID_RETRIEVE_ALL_SEGMENTS` | Retrieve all segments | **this endpoint allows you to retrieve all of your segments.** |
| `SENDGRID_RETRIEVE_ALL_SPAM_REPORTS` | Retrieve all spam reports | Retrieve spam reports in pages using `limit` for page size and `offset` to continue from a specific list position. multiple requests handle larger lists. |
| `SENDGRID_RETRIEVE_ALL_SUPPRESSION_GROUPS_FOR_AN_EMAIL_ADDRESS` | Retrieve all suppression groups for an email address | Retrieve all suppression groups for an email address |
| `SENDGRID_RETRIEVE_ALL_SUPPRESSIONS` | Retrieve all suppressions | **this endpoint allows you to retrieve a list of all suppressions.** |
| `SENDGRID_RETRIEVE_ALL_SUPPRESSIONS_FOR_A_SUPPRESSION_GROUP` | Retrieve all suppressions for a suppression group | **this endpoint allows you to retrieve all suppressed email addresses belonging to the given group.** |
| `SENDGRID_RETRIEVE_ALL_TEAMMATES` | Retrieve all teammates | Retrieve a paginated list of teammates with the `limit` parameter to set page size and `offset` to specify the starting point for additional items. make multiple requests if needed. |
| `SENDGRID_RETRIEVE_ALL_THE_IPS_IN_A_SPECIFIED_POOL` | Retrieve all the ips in a specified pool | **this endpoint allows you to get all of the ip addresses that are in a specific ip pool.** |
| `SENDGRID_RETRIEVE_AN_AUTHENTICATED_DOMAIN` | Retrieve an authenticated domain | **this endpoint allows you to retrieve a specific authenticated domain.** |
| `SENDGRID_RETRIEVE_AN_EXISTING_API_KEY` | Retrieve an existing api key | Retrieve an api key's details with its id via this endpoint. nonexistent keys yield a 404 error. key scopes can be modified later. refer to the documentation for scope details. |
| `SENDGRID_RETRIEVE_A_REVERSE_DNS_RECORD` | Retrieve a reverse dns record | **this endpoint allows you to retrieve a reverse dns record.** you can retrieve the ids associated with all your reverse dns records using the "retrieve all reverse dns records" endpoint. |
| `SENDGRID_RETRIEVE_A_SEGMENT` | Retrieve a segment | **this endpoint allows you to retrieve a single segment with the given id.** |
| `SENDGRID_RETRIEVE_A_SINGLE_CAMPAIGN` | Retrieve a single campaign | **this endpoint allows you to retrieve a specific campaign.** |
| `SENDGRID_RETRIEVE_A_SINGLE_LIST` | Retrieve a single list | **this endpoint allows you to retrieve a single recipient list.** |
| `SENDGRID_RETRIEVE_A_SINGLE_RECIPIENT` | Retrieve a single recipient | **this endpoint allows you to retrieve a single recipient by id from your contact database.** |
| `SENDGRID_RETRIEVE_A_SINGLE_TRANSACTIONAL_TEMPLATE` | Retrieve a single transactional template | **this endpoint allows you to retrieve a single transactional template.** |
| `SENDGRID_RETRIEVE_A_SPECIFIC_ALERT` | Retrieve a specific alert | **this endpoint allows you to retrieve a specific alert.** |
| `SENDGRID_RETRIEVE_A_SPECIFIC_ALLOWED_IP` | Retrieve a specific allowed ip | This endpoint retrieves an allowed ip for your account using its id, with ids obtainable from the endpoint listing currently allowed ips. |
| `SENDGRID_RETRIEVE_A_SPECIFIC_BLOCK` | Retrieve a specific block | **this endpoint allows you to retrieve a specific email address from your blocks list.** |
| `SENDGRID_RETRIEVE_A_SPECIFIC_INVALID_EMAIL` | Retrieve a specific invalid email | **this endpoint allows you to retrieve a specific invalid email addresses.** |
| `SENDGRID_RETRIEVE_A_SPECIFIC_PARSE_SETTING` | Retrieve a specific parse setting | **this endpoint allows you to retrieve a specific inbound parse setting by hostname.** you can retrieve all your inbound parse settings and their associated host names with the "retrieve all parse settings" endpoint. |
| `SENDGRID_RETRIEVE_A_SPECIFIC_SPAM_REPORT` | Retrieve a specific spam report | **this endpoint allows you to retrieve a specific spam report by email address.** |
| `SENDGRID_RETRIEVE_A_SPECIFIC_TRANSACTIONAL_TEMPLATE_VERSION` | Retrieve a specific transactional template version | **this endpoint allows you to retrieve a specific version of a template.** |
| `SENDGRID_RETRIEVE_A_SUBUSER_S_BRANDED_LINK` | Retrieve a subuser s branded link | Retrieve a subuser's branded link, created and validated by the parent account, available through the api or twilio sendgrid's subuser management page. |
| `SENDGRID_RETRIEVE_BOUNCE_CLASSIFICATION_TOTALS` | Retrieve bounce classification totals | This endpoint will return the total number of bounces by classification in descending order for each day. you can retrieve the bounce classification totals in csv format by specifying `"text/csv"` in the accept header. |
| `SENDGRID_RETRIEVE_BOUNCE_PURGE_MAIL_SETTINGS` | Retrieve bounce purge mail settings | Retrieve and manage your bounce/purge settings for soft/hard bounce suppression lists with twilio sendgrid, either automatically or manually via the app/api. |
| `SENDGRID_RETRIEVE_CLICK_TRACK_SETTINGS` | Retrieve click track settings | This endpoint retrieves your click tracking settings in sendgrid which tracks user engagement by redirecting and monitoring clicks on up to 1000 links per email. |
| `SENDGRID_RETRIEVE_CURRENT_ENFORCED_TLS_SETTINGS` | Retrieve current enforced tls settings | This endpoint retrieves enforced tls settings that mandate recipients to support tls 1.1+ or have a valid certificate. if not met, messages are dropped with a "tls required but not supported" block event. |
| `SENDGRID_RETRIEVE_EMAIL_STATISTICS_BY_BROWSER` | Retrieve email statistics by browser | Retrieve email stats by browser with advanced stats api, storing 7 days of data, and defaulting to 500 items per request. segment by location, device, and more. visit provided link for details. |
| `SENDGRID_RETRIEVE_EMAIL_STATISTICS_BY_CLIENT_TYPE` | Retrieve email statistics by client type | Retrieve email stats by client type with endpoint; stats stored for 7 days, 500 items per request. advanced stats offer detailed insights, segmentable by location, device, and more. visit the provided link for details. |
| `SENDGRID_RETRIEVE_EMAIL_STATISTICS_BY_COUNTRY_AND_STATE_PROVINCE` | Retrieve email statistics by country and state province | Retrieve email statistics by country and state/province. |
| `SENDGRID_RETRIEVE_EMAIL_STATISTICS_BY_DEVICE_TYPE` | Retrieve email statistics by device type | Retrieve email stats by device type with a 7-day data retention limit. the advanced stats api returns 500 items per request. device types include desktop, webmail, phone, tablet, and other. more analytics available at sendgrid's statistics overview. |
| `SENDGRID_RETRIEVE_EMAIL_STATISTICS_BY_MAILBOX_PROVIDER` | Retrieve email statistics by mailbox provider | Retrieve email stats by provider with advanced stats api, displaying details like location and device. only 7 days of data stored, 500 items per request. more info at sendgrid's statistics overview. |
| `SENDGRID_RETRIEVE_EMAIL_STATISTICS_FOR_CATEGORIES` | Retrieve email statistics for categories | **this endpoint allows you to retrieve all of your email statistics for each of your categories.** if you do not define any query parameters, this endpoint will return a sum for each category in groups of 10. |
| `SENDGRID_RETRIEVE_EMAIL_STATISTICS_FOR_YOUR_SUBUSERS` | Retrieve email statistics for your subusers | **this endpoint allows you to retrieve the email statistics for the given subusers.** you may retrieve statistics for up to 10 different subusers by including an additional subusers parameter for each additional subuser. |
| `SENDGRID_RETRIEVE_FOOTER_MAIL_SETTINGS` | Retrieve footer mail settings | Retrieve and customize your footer settings for email bodies via this endpoint, directly or through twilio sendgrid's mail settings menu. |
| `SENDGRID_RETRIEVE_FORWARD_BOUNCE_MAIL_SETTINGS` | Retrieve forward bounce mail settings | This endpoint fetches the current email forwarding settings for bounce messages, including the recipient email and whether the feature is active. |
| `SENDGRID_RETRIEVE_FORWARD_SPAM_MAIL_SETTINGS` | Retrieve forward spam mail settings | This endpoint retrieves current forward spam settings, listing specified email addresses receiving spam reports and showing if the feature is active. |
| `SENDGRID_RETRIEVE_GLOBAL_EMAIL_STATISTICS` | Retrieve global email statistics | Retrieve your global email stats within a specific date range, with parent accounts viewing their own or a subuser's aggregated data via the `on-behalf-of` header, while subusers see only their stats. |
| `SENDGRID_RETRIEVE_GOOGLE_ANALYTICS_SETTINGS` | Retrieve google analytics settings | Retrieve your google analytics settings, which are set to google's recommended defaults, to understand user site activity. for details, use google's guides and best practices links. |
| `SENDGRID_RETRIEVE_LEGACY_TEMPLATE_MAIL_SETTINGS` | Retrieve legacy template mail settings | The endpoint retrieves settings for original email templates, with a guide for using and migrating from legacy to newer dynamic transactional templates. |
| `SENDGRID_RETRIEVE_MONTHLY_STATS_FOR_ALL_SUBUSERS` | Retrieve monthly stats for all subusers | Retrieve monthly subuser email stats for a date range but can't sort by metrics like bounce drops, deferred, invalid emails, processed, spam reports, or unsubscribe drops. |
| `SENDGRID_RETRIEVE_PAGED_TRANSACTIONAL_TEMPLATES` | Retrieve paged transactional templates | **this endpoint allows you to retrieve all transactional templates.** |
| `SENDGRID_RETRIEVE_RECIPIENTS` | Retrieve recipients | Retrieve all marketing campaign recipients via this endpoint. use batch deletion carefully, as it may lead to empty pages. continue iterating pages until a 404 error occurs to ensure complete retrieval. |
| `SENDGRID_RETRIEVE_RECIPIENTS_ON_A_SEGMENT` | Retrieve recipients on a segment | **this endpoint allows you to retrieve all of the recipients in a segment with the given id.** |
| `SENDGRID_RETRIEVE_RESERVED_FIELDS` | Retrieve reserved fields | **this endpoint allows you to list all fields that are reserved and can't be used for custom field names.** |
| `SENDGRID_RETRIEVE_SCHEDULED_SEND` | Retrieve scheduled send | **this endpoint allows you to retrieve the cancel/paused scheduled send information for a specific `batch id`.** |
| `SENDGRID_RETRIEVES_INBOUND_PARSE_WEBHOOK_STATISTICS` | Retrieves inbound parse webhook statistics | Sendgrid's inbound parse webhook parses incoming emails, up to 30mb, and posts to a specified url, with available integrations listed in their library index. |
| `SENDGRID_RETRIEVE_SINGLE_SEGMENT_ENDPOINT` | Retrieve single segment endpoint | **this endpoint allows you to retrieve a single segment by id.** |
| `SENDGRID_RETRIEVE_SPECIFIC_TEAMMATE` | Retrieve specific teammate | **this endpoint allows you to retrieve a specific teammate by username.** you can retrieve the username's for each of your teammates using the "retrieve all teammates" endpoint. |
| `SENDGRID_RETRIEVE_STATS_BY_A_SPECIFIC_CLIENT_TYPE` | Retrieve stats by a specific client type | Use advanced stats api to get email statistics by client type (e.g., phone, desktop), offering location and device details. data storage is limited to 7 days with up to 500 items per request. see statistics overview for further information. |
| `SENDGRID_RETRIEVE_SUBSCRIPTION_TRACKING_SETTINGS` | Retrieve subscription tracking settings | **this endpoint allows you to retrieve your current settings for subscription tracking.** subscription tracking adds links to the bottom of your emails that allows your recipients to subscribe to, or unsubscribe from, your emails. |
| `SENDGRID_RETRIEVE_SUBUSER_REPUTATIONS` | Retrieve subuser reputations | This endpoint provides sender reputation scores for subusers, reflecting their email performance based on recipient responses and negative actions like bounces or spam reports. |
| `SENDGRID_RETRIEVE_SUMS_OF_EMAIL_STATS_FOR_EACH_CATEGORY` | Retrieve sums of email stats for each category | **this endpoint allows you to retrieve the total sum of each email statistic for every category over the given date range.** if you do not define any query parameters, this endpoint will return a sum for each category in groups of 10. |
| `SENDGRID_RETRIEVE_THE_COUNT_OF_BILLABLE_RECIPIENTS` | Retrieve the count of billable recipients | This endpoint provides the billable count of recipients for marketing campaigns, based on the highest number reached in your account. |
| `SENDGRID_RETRIEVE_THE_DEFAULT_BRANDED_LINK` | Retrieve the default branded link | The endpoint retrieves the default branded link for message sending, prioritizing user-set default, legacy, or sendgrid's default links. subuser requests are possible with id in the header. |
| `SENDGRID_RETRIEVE_THE_LISTS_THAT_A_RECIPIENT_IS_ON` | Retrieve the lists that a recipient is on | **this endpoint allows you to retrieve the lists that a given recipient belongs to.** each recipient can be on many lists. this endpoint gives you all of the lists that any one recipient has been added to. |
| `SENDGRID_RETRIEVE_THE_WARMUP_STATUS_FOR_A_SPECIFIC_IP_ADDRESS` | Retrieve the warmup status for a specific ip address | Retrieve the warmup status for a specific ip address |
| `SENDGRID_RETRIEVE_TRACKING_SETTINGS` | Retrieve tracking settings | **this endpoint allows you to retrieve a list of all tracking settings on your account.** |
| `SENDGRID_RETRIEVE_USER_S_AUTHENTICATED_DOMAINS` | Retrieve user s authenticated domains | The api endpoint allows subusers to fetch up to five domains verified by the main account for sending emails, with a defined order of domain selection. |
| `SENDGRID_RETRIEVE_YOUR_ACCOUNT_EMAIL_ADDRESS` | Retrieve your account email address | **this endpoint allows you to retrieve the email address currently on file for your account.** |
| `SENDGRID_RETRIEVE_YOUR_CREDIT_BALANCE` | Retrieve your credit balance | This endpoint checks an account's base email sending credit balance, which affects per-email charges. more details at sendgrid's billing documentation. |
| `SENDGRID_RETRIEVE_YOUR_USERNAME` | Retrieve your username | **this endpoint allows you to retrieve your current account username.** |
| `SENDGRID_RETURNS_A_LIST_OF_ALL_PARTNER_SETTINGS` | Returns a list of all partner settings | Retrieve a paginated list of partner settings using the `limit` to set page size and `offset` to specify the starting point for additional items. multiple requests may be needed for long lists. |
| `SENDGRID_SCHEDULE_A_CAMPAIGN` | Schedule a campaign | This endpoint schedules campaign emails for a specific time, recommending off-peak times like 10:53 instead of on the hour to minimize server deferrals and enhance delivery rates. |
| `SENDGRID_SCHEDULE_SINGLE_SEND` | Schedule single send | Use this endpoint to send a message right away by setting `send at` to `now`, or schedule it by specifying a future time in iso 8601 format (`yyyy-mm-ddthh:mm:ssz`). |
| `SENDGRID_SEARCH_CONTACTS` | Search contacts | Find contacts using this endpoint with a body containing a `query` in sgql. searches must use lowercase, and only the first 50 matches are returned. queries over 20s will timeout. dates are in iso format, not unix timestamps. |
| `SENDGRID_SEARCH_FOR_SUPPRESSIONS_WITHIN_A_GROUP` | Search for suppressions within a group | **this endpoint allows you to search a suppression group for multiple suppressions.** when given a list of email addresses and a group id, this endpoint will only return the email addresses that have been unsubscribed from the given group. |
| `SENDGRID_SEARCH_RECIPIENTS` | Search recipients | This endpoint searches marketing campaigns recipients. variable 'field name' represents custom text fields (url-encoded) or date fields (by unix timestamp) and auto-converts epoch time for 'reserved' date fields to a full day range. |
| `SENDGRID_SEGMENT_JSON_DATA_BY_SPECIFIC_CRITERIA` | Segment json data by specific criteria | Search json data for segments by specifying criteria for dates, text, and campaign ids using operators and boolean logic. optional list ids can refine results. used for email metrics. |
| `SENDGRID_SEND_A_CAMPAIGN` | Send a campaign | **this endpoint allows you to immediately send an existing campaign.** normally a post request would have a body, but since this endpoint is telling us to send a resource that is already created, a request body is not needed. |
| `SENDGRID_SEND_A_TEST_CAMPAIGN` | Send a test campaign | **this endpoint allows you to send a test campaign.** to send to multiple addresses, use an array for the json "to" value ["one@address","two@address"] |
| `SENDGRID_SEND_A_TEST_MARKETING_EMAIL` | Send a test marketing email | Use the endpoint to test marketing emails with a `template id` and up to 10 contacts. requires a `from address` or `sender id`. supports only dynamic transactional templates. manage with sendgrid app or api. |
| `SENDGRID_SEND_EMAIL_WITH_TWILIO_SEND_GRID` | Send email with twilio sendgrid | The mail send operation uses sendgrid's v3 api to send emails. visit the provided link for an overview, features, limitations, quickstarts, and helper libraries. |
| `SENDGRID_SET_UP_REVERSE_DNS` | Set up reverse dns | **this endpoint allows you to set up reverse dns.** |
| `SENDGRID_SINGLE_SEND_CSV_STATS_RETRIEVAL` | Singlesend csv stats retrieval | Export single send stats in .csv format by specifying one or multiple single send ids in the `ids` query string, separated by commas. data is returned as plain text in .csv for flexible use or saving. |
| `SENDGRID_START_WARMING_UP_AN_IP_ADDRESS` | Start warming up an ip address | **this endpoint allows you to put an ip address into warmup mode.** |
| `SENDGRID_STOP_WARMING_UP_AN_IP_ADDRESS` | Stop warming up an ip address | This endpoint removes an ip from warmup mode, returning a 204 code if successful. for warmup status details prior to removal, use the "retrieve warmup status" endpoint. |
| `SENDGRID_SUM_EMAIL_STATS_FOR_SUBUSERS` | Sumemailstatsforsubusers | **this endpoint allows you to retrieve the total sums of each email statistic metric for all subusers over the given date range.** |
| `SENDGRID_TEST_AN_EVENT_WEBHOOK_S_SETTINGS` | Test an event webhook s settings | The endpoint tests event webhooks by sending a fake event to your url. it has unique retry logic and requires specific oauth properties to test oauth configurations. saved credentials can be retrieved except for `oauth client secret`. |
| `SENDGRID_THIS_REQUEST_RETURNS_A_SINGLE_BULK_EMAIL_VALIDATION_JOB` | This request returns a single bulk email validation job | This request returns a single bulk email validation job |
| `SENDGRID_TOGGLE_WEBHOOK_SIGNATURE` | Toggle signature verification for a single event webhook by id | Toggle signature verification for a single event webhook by id |
| `SENDGRID_UNLINK_SUBUSER_DOMAIN` | Unlink subuser domain | The endpoint enables removal of an authenticated domain from subusers, each limited to five domains, to allow mail sending under a parent domain. |
| `SENDGRID_UNSCHEDULE_A_SCHEDULED_CAMPAIGN` | Unschedule a scheduled campaign | **this endpoint allows you to unschedule a campaign that has already been scheduled to be sent.** a successful unschedule will return a 204. if the specified campaign is in the process of being sent, the only option is to cancel (a different method). |
| `SENDGRID_UPDATE_A_BRANDED_LINK` | Update a branded link | **this endpoint allows you to update a specific branded link. you can use this endpoint to change a branded link's default status.** you can submit this request as one of your subusers if you include their id in the `on-behalf-of` header in the request. |
| `SENDGRID_UPDATE_A_CAMPAIGN` | Update a campaign | **this endpoint allows you to update a specific campaign.** this is especially useful if you only set up the campaign using post /campaigns, but didn't set many of the parameters. |
| `SENDGRID_UPDATE_ACCOUNT_OFFERINGS` | Update account offerings | Updates an account's package and attaches optional add-ons like marketing campaigns, dedicated ips, and expert services. note: accounts are limited to one package. |
| `SENDGRID_UPDATE_ADDRESS_WHITELIST_MAIL_SETTINGS` | Update address whitelist mail settings | Update email whitelist settings by toggling `enabled`. use `list` to replace entries - include all desired. exclude generic domains for can-spam compliance; whitelist bypasses bounces/unsubscribes for included contacts. |
| `SENDGRID_UPDATE_A_LIST` | Update a list | **this endpoint allows you to update the name of one of your recipient lists.** |
| `SENDGRID_UPDATE_AN_ACCOUNT_S_STATE` | Update an account s state | Update the state of the specified account. |
| `SENDGRID_UPDATE_AN_ALERT` | Update an alert | **this endpoint allows you to update an alert.** |
| `SENDGRID_UPDATE_AN_AUTHENTICATED_DOMAIN` | Update an authenticated domain | **this endpoint allows you to update the settings for an authenticated domain.** |
| `SENDGRID_UPDATE_AN_IP_POOL_NAME` | Update an ip pool name | This operation will rename an ip pool. an ip pool name cannot start with a dot/period (.) or space. |
| `SENDGRID_UPDATE_AN_SSO_INTEGRATION` | Update an sso integration | **this endpoint allows you to modify an exisiting sso integration.** you can retrieve the ids for your configurations from the response provided by the "get all sso integrations" endpoint. |
| `SENDGRID_UPDATE_A_PARSE_SETTING` | Update a parse setting | **this endpoint allows you to update a specific inbound parse setting by hostname.** you can retrieve all your inbound parse settings and their associated host names with the "retrieve all parse settings" endpoint. |
| `SENDGRID_UPDATE_API_KEY_NAME` | Update api key name | **this endpoint allows you to update the name of an existing api key.** you must pass this endpoint a json request body with a `name` property, which will be used to rename the key associated with the `api key id` passed in the url. |
| `SENDGRID_UPDATE_API_KEY_NAME_AND_SCOPES` | Update api key name and scopes | Update an api key's name and/or scopes using json with a `name` field and `scopes` array. to change only scopes, reuse the existing name. for just a name update, use another endpoint. see the permissions list for scope options. (https://docs.sendgrid.com) |
| `SENDGRID_UPDATE_A_SCHEDULED_CAMPAIGN` | Update a scheduled campaign | **this endpoint allows to you change the scheduled time and date for a campaign to be sent.** |
| `SENDGRID_UPDATE_A_SCHEDULED_SEND` | Update a scheduled send | Use this endpoint to change the status of a scheduled send by batch id. status updates fail with a 400 error if previously set with the cancel/pause endpoint. |
| `SENDGRID_UPDATE_A_SEGMENT` | Update a segment | **this endpoint allows you to update a segment.** |
| `SENDGRID_UPDATE_A_SENDER` | Update a sender | This endpoint updates an existing sender. changes to `from.email` need re-verification. if domain authenticated, new senders auto verify; else, verification email sent. partial updates can be made, but "required" fields in a `patch` must not be empty. |
| `SENDGRID_UPDATE_A_SENDER_IDENTITY` | Update a sender identity | This api endpoint enables updates to sender identities. changing `from.email` necessitates re-verification. partial updates are valid, but "required" fields must not be empty in patch requests. |
| `SENDGRID_UPDATE_A_SINGLE_EVENT_WEBHOOK_BY_ID` | Update a single event webhook by id | Update event webhooks by id with this endpoint or without id to update the oldest one. enable or disable, set url, choose event types, give friendly names, and configure oauth. for signature verification, use a different endpoint. |
| `SENDGRID_UPDATE_A_SUPPRESSION_GROUP` | Update a suppression group | **this endpoint allows you to update or change a suppression group.** |
| `SENDGRID_UPDATE_A_USER_S_PROFILE` | Update a user s profile | **this endpoint allows you to update your current profile details.** any one or more of the parameters can be updated via the patch `/user/profile` endpoint. you must include at least one when you patch. |
| `SENDGRID_UPDATE_BOUNCE_PURGE_MAIL_SETTINGS` | Update bounce purge mail settings | Update your bounce settings with twilio sendgrid to automatically delete contacts from suppression lists based on a set schedule in full days for both soft and hard email bounces. manage settings via their app or api. |
| `SENDGRID_UPDATE_CLICK_TRACKING_SETTINGS` | Update click tracking settings | This endpoint configures click tracking for emails, redirecting links through sendgrid or branded domains for engagement analysis, with a limit of 1000 links per email. |
| `SENDGRID_UPDATE_CUSTOM_FIELD_DEFINITION` | Update custom field definition | **this endpoint allows you to update a defined custom field.** only your custom fields can be modified; reserved fields cannot be updated. |
| `SENDGRID_UPDATE_DESIGN` | Update design | The design api enables partial design updates using patch requests, changing only specified fields, like the 'name' field, with no impact on other data. |
| `SENDGRID_UPDATE_DETAILS_FOR_AN_IP_ADDRESS` | Update details for an ip address | The operation modifies an ip address's settings, such as auto warm-up status, parent account assignment, and active status. the request must have one of `is auto warmup`, `is parent assigned`, or `is enabled`. |
| `SENDGRID_UPDATE_ENFORCED_TLS_SETTINGS` | Update enforced tls settings | Update tls settings through the endpoint by setting 'require tls' to 'true' for compulsory tls 1.1+ and valid certificates with recipients. messages without tls are blocked with a specific event notice. |
| `SENDGRID_UPDATE_FOOTER_MAIL_SETTINGS` | Update footer mail settings | This endpoint updates your email footer settings, enabling a custom footer addition in text/html emails. edit directly or via the twilio sendgrid app. |
| `SENDGRID_UPDATE_FORWARD_BOUNCE_MAIL_SETTINGS` | Update forward bounce mail settings | This endpoint updates bounce forwarding mail settings, allowing users to set an email for bounce report forwards and configure spam mail forwarding in twilio sendgrid app. |
| `SENDGRID_UPDATE_FORWARD_SPAM_MAIL_SETTINGS` | Update forward spam mail settings | Activate forward spam to send spam reports to specified emails; supports multiple addresses and authenticating domains to receive abuse/postmaster mails. configure via twilio sendgrid app. |
| `SENDGRID_UPDATE_GOOGLE_ANALYTICS_SETTINGS` | Update google analytics settings | Update your google analytics settings to track user activity on your site more effectively; defaults follow google's recommendations. for guidance, visit google's url builder and campaign building best practices. |
| `SENDGRID_UPDATE_INTEGRATION` | Updateintegration | This endpoint updates an existing integration. |
| `SENDGRID_UPDATE_LIST` | Update list | **this endpoint updates the name of a list.** |
| `SENDGRID_UPDATE_OPEN_TRACKING_SETTINGS` | Update open tracking settings | Update your email settings to enable open tracking with sendgrid, which uses an invisible image to log email opens in various reports if the recipient allows images. |
| `SENDGRID_UPDATE_SEGMENT` | Update segment | Segment `name` has to be unique. a user can not create a new segment with an existing segment name. |
| `SENDGRID_UPDATE_SINGLE_SEND` | Update single send | Update single send drafts using its id via this endpoint; only changed properties are affected. the 'send at' property sets a date but doesn't schedule it; use schedule single send endpoint or ui to schedule. |
| `SENDGRID_UPDATE_SSO_CERTIFICATE` | Update sso certificate | **this endpoint allows you to update an existing certificate by id.** you can retrieve a certificate's id from the response provided by the "get all sso integrations" endpoint. |
| `SENDGRID_UPDATE_SUBSCRIPTION_TRACKING_SETTINGS` | Update subscription tracking settings | **this endpoint allows you to update your current settings for subscription tracking.** subscription tracking adds links to the bottom of your emails that allows your recipients to subscribe to, or unsubscribe from, your emails. |
| `SENDGRID_UPDATE_TEAMMATE_S_PERMISSIONS` | Update teammate s permissions | This endpoint updates teammate permissions: set `is admin` to `true` for admin rights, otherwise to `false` with relevant scopes. only parent users or admins can modify these settings, and admin users are limited to permission changes. |
| `SENDGRID_UPDATE_TEMPLATE_MAIL_SETTINGS` | Update template mail settings | The endpoint updates legacy email templates, replaced by more advanced dynamic transactional templates. legacy templates are html-wrapped email content useful for marketing. guidance is available for using and migrating from legacy templates. |
| `SENDGRID_UPDATE_THE_CREDITS_FOR_A_SUBUSER` | Update the credits for a subuser | **this endpoint allows you to update the credits for a subuser.** |
| `SENDGRID_UPDATE_THE_REMAINING_CREDITS_FOR_A_SUBUSER` | Update the remaining credits for a subuser | **this endpoint allows you to update the remaining credits for a subuser.** |
| `SENDGRID_UPDATE_YOUR_ACCOUNT_EMAIL_ADDRESS` | Update your account email address | **this endpoint allows you to update the email address currently on file for your account.** |
| `SENDGRID_UPDATE_YOUR_PASSWORD` | Update your password | **this endpoint allows you to update your password.** |
| `SENDGRID_UPDATE_YOUR_USERNAME` | Update your username | **this endpoint allows you to update the username for your account.** |
| `SENDGRID_VALIDATE_A_BATCH_ID` | Validate a batch id | Validate a mail batch id to get a `200` status code for a valid one, or a `400` code for an invalid. a valid id simply means it's created, not necessarily assigned to a send. |
| `SENDGRID_VALIDATE_A_BRANDED_LINK` | Validate a branded link | **this endpoint allows you to validate a branded link.** you can submit this request as one of your subusers if you include their id in the `on-behalf-of` header in the request. |
| `SENDGRID_VALIDATE_A_DOMAIN_AUTHENTICATION` | Validate a domain authentication | **this endpoint allows you to validate an authenticated domain. if it fails, it will return an error message describing why the domain could not be validated.** |
| `SENDGRID_VALIDATE_AN_EMAIL` | Validate an email | **this endpoint allows you to validate an email address.** |
| `SENDGRID_VALIDATE_A_REVERSE_DNS_RECORD` | Validate a reverse dns record | Endpoint checks reverse dns record validity via `valid` in `validation results.a record`. if `false`, it's undetermined, not necessarily invalid. check `reason` for explanation. retrieve ids with "retrieve all reverse dns records" endpoint. |
| `SENDGRID_VERIFY_SENDER_REQUEST` | Verify sender request | **this endpoint allows you to verify a sender requests.** the token is generated by sendgrid and included in a verification email delivered to the address that's pending verification. |
| `SENDGRID_VIEW_A_SENDER_IDENTITY` | View a sender identity | **this endpoint allows you to retrieve a specific sender identity.** |
| `SENDGRID_VIEW_SCHEDULED_TIME_OF_A_CAMPAIGN` | View scheduled time of a campaign | **this endpoint allows you to retrieve the date and time that a campaign has been scheduled to be sent.** |

## Supported Triggers

None listed.

## Creating MCP Server - Stand-alone vs Composio SDK

The Sendgrid MCP server provides comprehensive access to Sendgrid operations through Composio. Once connected, Hermes can perform all major Sendgrid actions on your behalf using natural language commands.

## Complete Code

None listed.

## Conclusion

### Way Forward
With Sendgrid connected, Hermes can now act on your behalf whenever it detects a relevant task or you ask it to.
From here, you can extend Hermes further:
- Connect more apps: Calendar, Slack, Notion, Linear, and hundreds of others are available through the same Composio Connect setup. Each new integration compounds what Hermes can do for you.
- Build workflows across tools: Once multiple apps are connected, Hermes can chain actions together — turn an email into a calendar invite, a Slack message into a Linear ticket, or a meeting note into a follow-up draft.
- Let it learn your patterns: The more you use Hermes, the better it gets at anticipating how you'd handle recurring tasks. Give it feedback on drafts and decisions, and it will adapt.
If you run into trouble or want to share what you've built, join the [community](https://discord.com/invite/composio) or check out the [Docs](https://docs.composio.dev?utm_source=toolkits&utm_medium=framework_template&utm_campaign=hermes&utm_content=docs) for deeper configuration options.

## How to build Sendgrid MCP Agent with another framework

- [OpenAI Agents SDK](https://composio.dev/toolkits/sendgrid/framework/open-ai-agents-sdk)
- [Claude Agent SDK](https://composio.dev/toolkits/sendgrid/framework/claude-agents-sdk)
- [Claude Code](https://composio.dev/toolkits/sendgrid/framework/claude-code)
- [Claude Cowork](https://composio.dev/toolkits/sendgrid/framework/claude-cowork)
- [Codex](https://composio.dev/toolkits/sendgrid/framework/codex)
- [OpenClaw](https://composio.dev/toolkits/sendgrid/framework/openclaw)
- [CLI](https://composio.dev/toolkits/sendgrid/framework/cli)
- [Google ADK](https://composio.dev/toolkits/sendgrid/framework/google-adk)
- [LangChain](https://composio.dev/toolkits/sendgrid/framework/langchain)
- [Vercel AI SDK](https://composio.dev/toolkits/sendgrid/framework/ai-sdk)
- [Mastra AI](https://composio.dev/toolkits/sendgrid/framework/mastra-ai)
- [LlamaIndex](https://composio.dev/toolkits/sendgrid/framework/llama-index)
- [CrewAI](https://composio.dev/toolkits/sendgrid/framework/crew-ai)

## Related Toolkits

- [Reddit](https://composio.dev/toolkits/reddit) - Reddit is a social news platform with thriving user-driven communities (subreddits). It's the go-to place for discussion, content sharing, and viral marketing.
- [Facebook](https://composio.dev/toolkits/facebook) - Facebook is a social media and advertising platform for businesses and creators. It helps you connect, share, and manage content across your public Facebook Pages.
- [Linkedin](https://composio.dev/toolkits/linkedin) - LinkedIn is a professional networking platform for connecting, sharing content, and engaging with business opportunities. It's the go-to place for building your professional brand and unlocking new career connections.
- [Active campaign](https://composio.dev/toolkits/active_campaign) - ActiveCampaign is a marketing automation and CRM platform for managing email campaigns, sales pipelines, and customer segmentation. It helps businesses engage customers and drive growth through smart automation and targeted outreach.
- [ActiveTrail](https://composio.dev/toolkits/active_trail) - ActiveTrail is a user-friendly email marketing and automation platform. It helps you reach subscribers and automate campaigns with ease.
- [Ahrefs](https://composio.dev/toolkits/ahrefs) - Ahrefs is an SEO and marketing platform for site audits, keyword research, and competitor insights. It helps you improve search rankings and drive organic traffic.
- [Amcards](https://composio.dev/toolkits/amcards) - AMCards lets you create and mail personalized greeting cards online. Build stronger customer relationships with easy, automated card campaigns.
- [Beamer](https://composio.dev/toolkits/beamer) - Beamer is a news and changelog platform for in-app announcements and feature updates. It helps companies boost user engagement by sharing news where users are most active.
- [Benchmark email](https://composio.dev/toolkits/benchmark_email) - Benchmark Email is a platform for creating, sending, and tracking email campaigns. It's built to help you engage audiences and analyze results—all in one place.
- [Bigmailer](https://composio.dev/toolkits/bigmailer) - BigMailer is an email marketing platform for managing multiple brands with white-labeling and automation. It helps teams streamline campaigns and simplify integration with Amazon SES.
- [Brandfetch](https://composio.dev/toolkits/brandfetch) - Brandfetch is an API that delivers company logos, colors, and visual branding assets. It helps marketers and developers keep brand visuals consistent everywhere.
- [Brevo](https://composio.dev/toolkits/brevo) - Brevo is an all-in-one email and SMS marketing platform for transactional messaging, automation, and CRM. It helps businesses engage customers and streamline communications through powerful campaign tools.
- [Campayn](https://composio.dev/toolkits/campayn) - Campayn is an email marketing platform for creating, sending, and managing campaigns. It helps businesses engage contacts and grow audiences with easy-to-use tools.
- [Cardly](https://composio.dev/toolkits/cardly) - Cardly is a platform for creating and sending personalized direct mail to customers. It helps businesses break through the digital clutter by getting real engagement via physical mailboxes.
- [ClickSend](https://composio.dev/toolkits/clicksend) - ClickSend is a cloud-based SMS and email marketing platform for businesses. It streamlines communication by enabling quick message delivery and contact management.
- [Crustdata](https://composio.dev/toolkits/crustdata) - CrustData is an AI-powered data intelligence platform for real-time company and people data. It helps B2B sales teams, AI SDRs, and investors react to live business signals.
- [Curated](https://composio.dev/toolkits/curated) - Curated is a platform for collecting, curating, and publishing newsletters. It streamlines content aggregation and distribution for creators and teams.
- [Customerio](https://composio.dev/toolkits/customerio) - Customer.io is a customer engagement platform for targeted messaging across email, SMS, and push. Easily automate, segment, and track communications with your audience.
- [Cutt ly](https://composio.dev/toolkits/cutt_ly) - Cutt.ly is a URL shortening service for managing and analyzing links. Streamline your workflows with quick, trackable, and branded short URLs.
- [Demio](https://composio.dev/toolkits/demio) - Demio is webinar software built for marketers, offering both live and automated sessions with interactive features. It helps teams engage audiences and optimize lead generation through detailed analytics.

## Frequently Asked Questions

### What are the differences in Tool Router MCP and Sendgrid MCP?

With a standalone Sendgrid MCP server, the agents and LLMs can only access a fixed set of Sendgrid tools tied to that server. However, with the Composio Tool Router, agents can dynamically load tools from Sendgrid and many other apps based on the task at hand, all through a single MCP endpoint.

### Can I use Tool Router MCP with Hermes?

Yes, you can. Hermes fully supports MCP integration. You get structured tool calling, message history handling, and model orchestration while Tool Router takes care of discovering and serving the right Sendgrid tools.

### Can I manage the permissions and scopes for Sendgrid while using Tool Router?

Yes, absolutely. You can configure which Sendgrid scopes and actions are allowed when connecting your account to Composio. You can also bring your own OAuth credentials or API configuration so you keep full control over what the agent can do.

### How safe is my data with Composio Tool Router?

All sensitive data such as tokens, keys, and configuration is fully encrypted at rest and in transit. Composio is SOC 2 Type 2 compliant and follows strict security practices so your Sendgrid data and credentials are handled as safely as possible.

---
[See all toolkits](https://composio.dev/toolkits) · [Composio docs](https://docs.composio.dev/llms.txt)