> ## Documentation Index > Fetch the complete documentation index at: https://docs.boxd.sh/llms.txt > Use this file to discover all available pages before exploring further. # SendGrid > SendGrid is a cloud-based email delivery platform providing transactional and marketing email services, with APIs for integration, analytics, and scalability SendGrid is a cloud-based email delivery platform providing transactional and marketing email services, with APIs for integration, analytics, and scalability `sendgrid` · **364 tools** · no triggers ## Connect it ```bash theme={"theme":"github-dark"} run auth sendgrid run auth sendgrid --scope team # shared with the organization ``` Or from the [Integrations page](https://app.boxd.sh/integrations) in the console. See [Connections](/guides/integrations/connections) for personal versus shared, and who may remove one. ## Use it ```bash theme={"theme":"github-dark"} run sendgrid # common commands run sendgrid --all # every command ``` ```ts theme={"theme":"github-dark"} import { sendgrid } from "@boxd/run"; ``` ## Common tools | Tool | What it does | | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `add-ip-address-to-pool` | Adds a dedicated IP address to an IP pool in your SendGrid account. **Prerequisites:** - You must have a SendGrid Pro or Premier plan with dedicated... | | `retrieve-all-lists` | Retrieve all contact lists from your SendGrid account. Lists are static collections of Marketing Campaigns contacts. | | `activate-template-version` | Activates a specific version of a transactional template, making it the default version used when sending emails. | | `add-batch-of-ips-to-ip-pool` | Adds a batch of IP addresses to a specified IP Pool in SendGrid. | | `add-ip-to-authenticated-domain` | Add an IP address to an authenticated domain for custom SPF configuration. | | Tool | What it does | | -------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `activate-template-version` | Activates a specific version of a transactional template, making it the default version used when sending emails. | | `add-batch-of-ips-to-ip-pool` | Adds a batch of IP addresses to a specified IP Pool in SendGrid. | | `add-ip-address-to-pool` | Adds a dedicated IP address to an IP pool in your SendGrid account. **Prerequisites:** - You must have a SendGrid Pro or Premier plan with dedicated... | | `add-ip-to-authenticated-domain` | Add an IP address to an authenticated domain for custom SPF configuration. | | `add-single-recipient-to-list` | Adds a single recipient to a contact list in SendGrid's Legacy Contact Database. | | `add-twilio-send-grid-ip-address` | Provisions a new Twilio SendGrid IP address to your account. | | `add-ips` | Add dedicated IP addresses to your SendGrid account. This endpoint provisions new dedicated IP addresses for sending emails. | | `add-one-or-more-ips-to-allow-list` | Adds one or more IPv4 addresses to your SendGrid account's IP access management allow list. | | `add-or-update-contact` | Adds or updates contacts in SendGrid Marketing Campaigns. This is an asynchronous operation that queues contacts for processing. | | `add-suppressions-to-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... | | `add-to-global-suppressions-group` | Adds one or more email addresses to the global suppression group. | | `approve-access-request` | **This endpoint allows you to approve an access attempt.** **Note:** Only teammate admins may approve another teammate’s access request. | | `assign-batch-of-subusers-to-ip` | Assigns multiple subusers to a specified IP address in a single operation. | | `associate-branded-link-with-subuser` | Associate a branded link with a subuser account for email link tracking. | | `associate-authenticated-domain-with-given-user` | Associate an authenticated domain with a subuser, allowing the subuser to send emails using the parent account's domain authentication. | | `authenticate-domain` | The endpoint enables domain authentication for users or subusers, offering two methods - 'username' parameter for visibility and modification, or the... | | `authenticate-account-with-single-sign-on` | Generates a one-time SSO authentication URL for logging into a customer's Twilio SendGrid account. | | `bind-authenticated-domains-to-user` | Associates an additional authenticated domain with a subuser. | | `bulk-delete-single-sends` | Permanently deletes multiple Single Sends in a single operation by providing their IDs. | | `cancel-or-pause-scheduled-send` | Cancel or pause a group of scheduled email sends by their batch\_id. | | `completed-steps` | Retrieves the verification status of a SendGrid account, checking if Domain Authentication and Single Sender Verification have been completed. | | `create-batch-id` | Generate a new mail batch ID to group multiple email sends together. | | `create-branded-link` | Create a new branded link by specifying the root domain, which must align with your FROM email, and an optional unique subdomain. | | `create-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... | | `create-custom-field` | Creates a custom field for storing additional contact information in SendGrid. | | `create-list` | Create a new contact list in SendGrid Marketing Campaigns. Lists are static collections of contacts used for organizing and targeting email campaigns. | | `create-account` | Creates a new customer account under your organization using the Account Provisioning API. | | `create-new-alert` | Create a new SendGrid alert. Supports two alert types: - **usage\_limit**: Notifies when email usage reaches a percentage threshold (requires... | | `create-new-event-webhook` | Set up an Event Webhook by providing a URL, choosing events for POST requests, and receive a unique ID. | | `create-new-suppression-group` | Create a new suppression group (unsubscribe group) to allow recipients to opt out of specific types of emails. | | `create-new-transactional-template-version` | **This endpoint allows you to create a new version of a template.** | | `create-ip-pool` | Creates a new IP pool in your SendGrid account. IP pools allow you to group your dedicated SendGrid IP addresses together. | | `create-ip-pool-with-name-and-ip-assignments` | Creates a new IP Pool in your SendGrid account using the IP Address Management API. | | `create-sso-certificate` | Create an SSO certificate for SAML 2.0 Single Sign-On authentication. | | `create-sso-integration` | Create a new Single Sign-On (SSO) integration for your SendGrid account. | | `create-sso-teammate` | Creates a Single Sign-On (SSO) Teammate in SendGrid. SSO Teammates authenticate via your Identity Provider (IdP) instead of username/password. | | `create-parse-setting` | Creates a new Inbound Parse Webhook setting to receive and parse incoming emails. **Prerequisites:** 1. | | `create-api-keys` | Creates a new SendGrid API key with specified permissions. The first API key must be created in the SendGrid App UI; subsequent keys can be created via this endpoint. | | `create-segment` | Creates a new contact segment using SendGrid's Marketing Campaigns Segmentation V2 API. | | `create-sender` | Creates a new Sender identity for use in SendGrid Marketing Campaigns. | | `create-sender-identity` | **Create a new sender identity in SendGrid.** A sender identity is required to send email through SendGrid. | | `create-transactional-template` | Create a new transactional email template in SendGrid. Transactional templates allow you to create reusable email templates for sending transactional emails. | | `create-custom-field-definition` | Create unique case-insensitive custom fields with alphanumeric/underscore names starting with a letter/underscore. | | `create-design` | Creates a new email design in the SendGrid Design Library. The design can be used for Single Sends, Automations, and Dynamic Templates. | | `create-integration` | Create a SendGrid Marketing Integration for email event forwarding to Segment. | | `create-single-send` | The endpoint lets you create a Single Send draft without needing a template ID; it now uses `email_config`. | | `create-subuser` | **This endpoint allows you to create a new subuser.** Subusers allow you to segment your email sending and API activity. | | `create-verified-sender-request` | This endpoint creates a new sender identity via `POST`, sends a verification email to `from_email`, and requires email verification. | | `delete-batch-of-ips-from-ip-pool` | Removes a batch of IP addresses from a specified IP Pool in SendGrid. | | `delete-batch-of-subusers-from-ip` | Removes multiple subusers from a specified IP address in a single batch operation. | | `delete-bounce` | Removes an email address from your SendGrid bounce suppression list. | | `delete-branded-link` | Permanently delete a branded link from your SendGrid account. | | `delete-campaign` | Permanently deletes a specific marketing campaign from your SendGrid account. **Note**: This endpoint is part of the Legacy Marketing Campaigns API. | | `delete-contact-identifier` | Removes a specific identifier (EMAIL, PHONENUMBERID, EXTERNALID, or ANONYMOUSID) from a contact without deleting the entire contact. | | `delete-custom-field` | Permanently deletes a custom field from your SendGrid contact database. **Important:** - This uses the Legacy Marketing Campaigns Contacts API - Only... | | `delete-global-suppression` | This endpoint removes an email from suppressions, allowing future emails to be sent to it. | | `delete-account` | Permanently deletes a customer account under your organization using the Account Provisioning API. **WARNING:** This action is IRREVERSIBLE and will... | | `delete-alert` | Delete a SendGrid alert by its ID. Permanently removes an alert from your account. | | `delete-authenticated-domain` | Delete an authenticated domain (formerly known as domain whitelabel) by its ID. | | `delete-ip-pool` | Delete an IP Pool from your SendGrid account using the IP Address Management API. | | `delete-sso-certificate` | Delete an SSO certificate by its unique identifier. This endpoint permanently removes an SSO (Single Sign-On) certificate from your SendGrid account. | | `delete-sso-integration` | Delete an SSO (Single Sign-On) integration by ID. This endpoint permanently removes an IdP (Identity Provider) configuration from your SendGrid account. | | `delete-parse-setting` | Deletes a specific inbound parse webhook setting by hostname. **Use Case:** Remove an inbound parse configuration when you no longer want SendGrid to... | | `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... | | `delete-recipient` | **\[LEGACY API - DEPRECATED]** Deletes a single recipient from the Legacy Marketing Campaigns contact database. | | `delete-reverse-dns-record` | This endpoint deletes a reverse DNS record, returning a 204 code on success. | | `delete-segment` | Permanently deletes a segment from the SendGrid Contact Database (Legacy Marketing Campaigns). | | `delete-sender` | Permanently delete an existing Marketing Campaigns Sender identity from your SendGrid account. | | `delete-sender-identity` | Permanently deletes a sender identity from your SendGrid account. **Important:** This action is irreversible. | | `delete-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... | | `delete-single-recipient-from-single-list` | Remove a single recipient from a SendGrid contact list. This endpoint is part of the Legacy Marketing Campaigns API (contactdb). | | `delete-specific-block` | Deletes a specific email address from your SendGrid blocks list. | | `delete-specific-invalid-email` | Removes a specific email address from SendGrid's invalid emails suppression list. | | `delete-specific-spam-report` | Removes a specific spam report from SendGrid's suppression list by email address. | | `delete-subuser` | Permanently delete a subuser from your SendGrid account. **WARNING**: This is a permanent, irreversible action. | | `delete-suppression-from-suppression-group` | Remove an email address from a suppression group (unsubscribe group). | | `delete-suppression-group` | This API endpoint deletes email suppression groups. Deleted group members get globally suppressed if they unsubscribe. | | `delete-template` | Permanently deletes a transactional template from your SendGrid account. **Important:** This action is irreversible. | | `delete-transactional-template-version` | **Delete a specific version of a transactional template.** This endpoint permanently removes a template version. | | `delete-blocks` | Delete blocked email addresses from your SendGrid suppression list. | | `delete-bounces` | Delete bounced email addresses from your SendGrid bounce suppression list. | | `delete-bulk-integration` | Bulk delete multiple Integrations by providing their IDs as a query parameter. | | `delete-cancellation-or-pause-from-scheduled-send` | Resume a paused or cancelled scheduled send by removing its pause/cancel status. | | `delete-contacts` | Deletes contacts from your SendGrid Marketing Campaigns account. | | `delete-custom-field-definition` | Permanently deletes a custom field definition from SendGrid Marketing Campaigns. **Important notes:** - Only custom fields can be deleted; reserved... | | `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... | | `delete-invalid-emails` | Delete email addresses from your SendGrid invalid emails suppression list. | | `delete-pending-teammate` | Delete a pending teammate invitation that hasn't yet been accepted. | | `delete-single-send-by-id` | Permanently deletes a Single Send by its unique ID. You can obtain the Single Send ID from the GET `/v3/marketing/singlesends` endpoint or the... | | `delete-single-send-schedule` | Cancel a scheduled Single Send by deleting its scheduled send time. | | `delete-spam-reports` | Delete spam reports from your SendGrid spam report suppression list. | | `delete-teammate` | Permanently delete a teammate from your SendGrid account. This endpoint removes a teammate's access to your account. | | `delete-verified-sender` | Deletes a Verified Sender Identity from your SendGrid account. | | `deny-access-request` | Denies a teammate's pending access request. This action removes the request without granting the requested permissions. | | `disassociate-branded-link-from-subuser` | Remove a branded link association from a subuser account. This endpoint allows parent accounts to disassociate a branded link from a subuser. | | `domain-warn-list` | Retrieves a list of domains known to implement DMARC (Domain-based Message Authentication, Reporting & Conformance) policies, categorized by failure type. | | `download-csv` | Retrieves a presigned S3 URL to download a CSV file of email activity data (up to 1M events, last 30 days). **Workflow:** 1. | | `duplicate-transactional-template` | Duplicate an existing transactional template to create a new template with the same content. | | `duplicate-design` | Duplicates an existing email design in the SendGrid Design Library. | | `duplicate-send-grid-pre-built-design` | Duplicates a pre-built SendGrid email design template from the SendGrid Design Library. | | `duplicate-single-send` | Duplicates an existing Single Send by its ID, creating a new draft that can be edited via the Update Single Send endpoint (PATCH). | | `edit-sso-teammate` | Updates an existing SSO Teammate's permissions and profile in SendGrid. **Requirements**: Enterprise SendGrid account with SSO integration enabled. | | `edit-transactional-template` | Updates the name of an existing transactional template. This endpoint allows you to rename a transactional template without affecting its content or versions. | | `edit-transactional-template-version` | Edit a transactional template version in SendGrid. This endpoint allows you to update the content, subject, name, and other properties of an existing template version. | | `edit-verified-sender` | Updates an existing verified sender identity in SendGrid. This action allows partial updates - only the fields you specify will be modified, while... | | `email-dns-records-to-co-worker` | Email DNS records to a co-worker for domain authentication or link branding setup. | | `enable-disable-subuser` | Enable or disable a SendGrid subuser account. Use this endpoint to control whether a subuser can send emails: - Set `disabled=true` to disable the... | | `enable-disable-website-access-for-subuser` | Enable or disable website portal access for a SendGrid subuser while preserving their email sending capabilities. | | `erase-recipients-email-data` | Permanently erases recipients' personal email data from SendGrid for GDPR/privacy compliance. | | `export-contacts` | Initiates an asynchronous job to export Marketing Campaigns contacts to CSV or JSON. **Use Cases:** - Export all contacts from your SendGrid... | | `export-contacts-status` | Retrieves the status of a contact export job and provides download URLs when ready. | | `export-single-send-stats` | Exports Single Send campaign statistics in CSV format. This endpoint allows you to export stats for one or more Single Sends from SendGrid Marketing Campaigns. | | `filter-all-messages` | Filter and retrieve email activity from the SendGrid Email Activity Feed API. | | `filter-messages-by-message-id` | Retrieve detailed information about a specific email message by its unique message ID. | | `get-account-offerings` | Retrieves the offerings (email packages and add-ons) assigned to a specific customer account. | | `get-contact-by-id` | Retrieves the full details of a single contact by their unique ID from SendGrid Marketing Campaigns. | | `get-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. | | `get-list-of-all-senders` | Retrieves a list of all Sender identities associated with your SendGrid account. | | `get-list-of-subusers-assigned-to-ip` | Retrieves a list of Subuser IDs assigned to a specific IP address in your SendGrid account. | | `get-all-accounts` | Retrieves all accounts under the organization. | | `get-all-automation-stats` | Retrieve email statistics for SendGrid Marketing Automations (automated email workflows). | | `get-all-available-offerings` | Retrieves all available SendGrid offerings for account provisioning. | | `get-all-categories` | Retrieve all categories associated with your Marketing Campaigns Single Sends. | | `get-all-existing-exports` | Retrieves all existing contact export jobs from SendGrid Marketing Campaigns. | | `get-all-field-definitions` | Retrieve all field definitions including custom and reserved fields from Marketing Campaigns. | | `get-all-ip-pools-that-have-associated-ips` | The function lists your IP Pools and samples up to 10 IPs from each. | | `get-all-sender-identities` | **This endpoint allows you to retrieve a list of all sender identities that have been created for your account.** | | `get-all-single-sends` | Retrieve a list of your Single Sends with brief details, including their IDs. | | `get-all-single-sends-stats` | Retrieve email statistics for SendGrid Single Sends (one-time marketing email campaigns). | | `get-all-sso-certificates-by-integration` | Retrieves all SSO (Single Sign-On) certificates associated with a specific IdP integration. | | `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... | | `get-all-verified-senders` | Retrieve all Sender Identities (verified/unverified) for an account via an endpoint. | | `get-account-s-state` | Retrieve the current state of a customer account using the Account Provisioning API. | | `get-sso-certificate` | Retrieve an individual SSO certificate by its ID. SSO (Single Sign-On) certificates are X509 certificates used by SendGrid to verify that SAML... | | `get-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-specific-sender` | Retrieves the details of a specific Marketing Sender by its unique ID. | | `get-user-s-account-information` | Retrieves the authenticated user's SendGrid account details including account type (e.g., 'free', 'paid') and sender reputation score (0-100). | | `get-user-s-profile` | Retrieve the authenticated user's profile details. This endpoint returns the current user's profile information including their name, contact... | | `get-automation-click-tracking-stats-by-id` | Retrieve click-tracking statistics for a specific SendGrid Marketing Automation. | | `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. | | `get-batched-contacts-by-ids` | Retrieves multiple SendGrid Marketing Contacts by their IDs in a single batch request. | | `get-bounce-class-stats` | Retrieve daily bounce statistics filtered by a specific classification type. | | `get-bulk-validation-job` | Retrieves the details of a specific Bulk Email Address Validation Job by its ID. | | `get-contacts-by-emails` | Search for Marketing Campaigns contacts by their email addresses. | | `get-contacts-by-identifiers` | Retrieves up to 100 Marketing Campaigns contacts by searching for specific identifier values. | | `get-design` | Retrieves a specific design's details from your Design Library by its ID. | | `get-details-for-ip-address` | Retrieves detailed information about a specific IP address on your SendGrid account. | | `get-details-for-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. | | `get-email-suppression-groups` | **Retrieve all suppression groups for a specific email address.** This endpoint returns a list of all suppression groups in your SendGrid account... | | `get-engagement-quality-scores` | Retrieve SendGrid Engagement Quality (SEQ) scores for a specified date range. | | `get-geo-stats` | Retrieves email engagement statistics (opens, clicks) segmented by geographic location (country and state/province). | | `get-information-on-single-suppression-group` | Retrieves details for a single suppression group (also known as an unsubscribe group). | | `get-integration` | Retrieve a specific Marketing Integration by its unique ID. An Integration is a connection from SendGrid Marketing Campaigns to a supported... | | `get-ips-assigned-to-ip-pool` | Retrieves IP addresses assigned to a specific IP Pool. This endpoint is part of the IP Address Management API (beta) and requires dedicated IP... | | `get-ip-warmup-status` | Retrieve the warmup status for a specific dedicated IP address. | | `get-list-contact-count` | Retrieve the contact count and billable contact count for a specific marketing list. | | `get-list-of-segments` | Retrieves a filtered list of contact segments from SendGrid Marketing Campaigns V2. | | `get-open-tracking-settings` | Retrieves the current open tracking settings for your SendGrid account. | | `get-recipient-upload-status` | Retrieves the upload status for recipients in the Legacy Marketing Campaigns contacts database (contactdb). | | `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.** | | `get-sample-contacts` | Retrieves a sample of up to 50 contacts from your Marketing Contacts database, sorted by email address. | | `get-send-grid-pre-built-design` | Retrieves details of a specific SendGrid pre-built design template by ID. | | `get-signed-event-webhook-s-public-key` | Retrieves the public key for a specific Event Webhook 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-single-send-click-tracking-stats-by-id` | **This endpoint lets you retrieve click-tracking stats for one Single Send**. | | `get-single-sends-search` | Search for Single Sends (marketing email campaigns) by name, status, and/or categories. | | `get-single-send-stats-by-id` | Retrieve individual Single Send stats using its ID. For multiple IDs, use "Get All Single Sends Stats". | | `get-subuser-monthly-stats` | Retrieves monthly email statistics for a specific subuser. Returns metrics such as blocks, bounces, clicks, delivered emails, opens, requests, unique... | | `get-subusers-engagement-quality-scores` | Retrieve SendGrid Engagement Quality (SEQ) scores for all subusers on a specific date. | | `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`. | | `get-teammate-subuser-access` | Retrieve Subusers accessible to a specified Teammate, including their permission levels and scopes. | | `get-credits-for-subuser` | Retrieves credit information for a specific Subuser account, including the credit type (unlimited, recurring, or nonrecurring), reset frequency... | | `get-default-authentication` | Retrieves the default domain authentication configuration for your SendGrid account. | | `get-settings-for-single-event-webhook` | Retrieves the configuration and settings for a single Event Webhook by its ID. | | `get-total-contact-count` | Retrieve the total number of contacts stored in your SendGrid Marketing Campaigns account. | | `get-user-scopes` | Retrieve a list of scopes for which this user has access | | `import-contacts` | Initiates a bulk contact import by requesting an upload URL for a CSV file. | | `import-contacts-status` | Check the status of a contact import, update, or delete job in SendGrid Marketing Campaigns. | | `invite-teammate` | Invite teammates to your account through email with this endpoint, assigning initial permissions via the `scopes` array. | | `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. | | `list-all-subusers` | Retrieve a paginated list of subusers with filtering options. | | `list-api-keys` | Retrieve user's API key names and IDs with this endpoint; keys themself cannot be retrieved for security. | | `list-bulk-email-validation-jobs` | Retrieves a list of all Bulk Email Address Validation Jobs for the account. | | `list-designs` | List designs from the Design Library. Fetches user-created designs stored in the SendGrid Design Library (part of Marketing Campaigns). | | `list-integration` | This endpoint returns all the Integrations for the user making this call. | | `list-send-grid-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... | | `list-user-auth-domains` | Retrieves all authenticated domains that have been assigned to a specific subuser. | | `manually-refresh-segment` | Manually refresh a Marketing Campaigns V2 segment to update its contact membership. | | `presigned-url-headers-for-bulk-email-validation` | Request a presigned URL and headers to upload a file containing email addresses for bulk validation. | | `remove-ip-address-from-pool` | Remove an IP address from an IP pool in your SendGrid account. | | `remove-ip-from-authenticated-domain` | Remove an IP address from an authenticated domain's custom SPF configuration. | | `remove-specific-ip-from-allowed-list` | Removes a specific IP address from your SendGrid account's allow list. | | `remove-contacts-from-list` | Remove contacts from a marketing list without deleting them from your account. | | `remove-list-and-optional-contacts` | Delete a marketing list from your SendGrid account. This endpoint permanently removes a specific list from your Marketing Campaigns. | | `remove-one-or-more-ips-from-allow-list` | Removes one or more IP addresses from your SendGrid IP Access Management allow list. | | `remove-segment-without-affecting-contacts` | Permanently deletes a segment from SendGrid's Marketing Campaigns without affecting contacts. | | `remove-user-domain` | Disassociate ALL authenticated domains from a subuser. This endpoint removes any authenticated domain associations that have been assigned to the specified subuser. | | `rename-ip-pool` | Renames an existing IP pool in your SendGrid account. IP pools allow you to group your dedicated SendGrid IP addresses together. | | `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. | | `resend-sender-verification` | Resends the verification email for a Marketing Campaigns Sender identity. | | `resend-sender-identity-verification` | Resends the verification email to a sender identity's 'from' email address. | | `resend-teammate-invite` | Resend a pending teammate invitation to refresh its expiration date. | | `resend-verified-sender-request` | Resends the verification email to a Sender Identity's 'from\_email' address. | | `retrieve-bounce` | Retrieves details about a specific bounced email address from the SendGrid suppression list. | | `retrieve-branded-link` | Retrieves a specific branded link by its ID. Branded links (formerly 'Link Whitelabel') allow click-tracked links, opens, and images in your emails... | | `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. | | `retrieve-count-of-recipients` | Retrieve the total count of recipients in the Legacy Marketing Campaigns contact database. **IMPORTANT: This is a Legacy API endpoint.** The... | | `retrieve-custom-field` | Retrieves a single custom field definition by its ID from SendGrid Marketing Campaigns. | | `retrieve-address-whitelist-mail-settings` | Retrieves your current address whitelist mail settings from SendGrid. | | `retrieve-global-suppression` | Checks if an email address is in the global suppression list. | | `retrieve-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. | | `retrieve-all-alerts` | Retrieve all SendGrid alerts configured for your account. Returns a list of alert configurations including: - **usage\_limit alerts**: Notify when... | | `retrieve-all-assigned-ips` | Retrieves all IP addresses that are currently assigned to your account. | | `retrieve-all-blocks` | Retrieves a paginated list of all blocked email addresses from your SendGrid account. | | `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. | | `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... | | `retrieve-all-campaigns` | Retrieve a paginated list of campaigns in reverse creation order with the API endpoint. | | `retrieve-all-categories` | Retrieve all email categories used for tracking and organizing email statistics. | | `retrieve-all-custom-fields` | Retrieve all custom field definitions for contacts. Returns a list of all custom fields that have been created for your contacts. | | `retrieve-all-global-suppressions` | Retrieves a paginated list of all email addresses that are globally suppressed from receiving any emails from your SendGrid account. | | `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. | | `retrieve-all-ip-addresses` | Retrieve a paginated list of assigned/unassigned IPs with warmup status, pools, subusers, and DNS info. | | `retrieve-all-ip-pools` | **This endpoint allows you to get all of your IP pools.** | | `retrieve-all-ip-pools-ip-address-belongs-to` | Retrieves details for a specific IP address including all IP pools it belongs to, subusers that can use it, warmup status, and reverse DNS record. | | `retrieve-all-ips-currently-in-warmup` | Retrieve all IP addresses currently in the warmup process. IP warmup is the process of gradually increasing sending volume through a new IP address... | | `retrieve-all-lists` | Retrieve all contact lists from your SendGrid account. Lists are static collections of Marketing Campaigns contacts. | | `retrieve-all-mail-settings` | Retrieve a paginated list of mail settings with their `enabled` status and descriptions. | | `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... | | `retrieve-all-parse-settings` | **This endpoint allows you to retrieve all of your current inbound parse settings.** | | `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. | | `retrieve-all-recent-access-attempts` | Retrieves a list of all IP addresses that have recently attempted to access your SendGrid account, either through the User Interface or the API. | | `retrieve-all-recipients-on-list` | Retrieves all recipients (contacts) belonging to a specific list in SendGrid's Legacy Marketing Campaigns. **IMPORTANT**: This endpoint is part of... | | `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. | | `retrieve-all-scheduled-sends` | The endpoint provides details of cancelled or paused scheduled sends but only if they have a `batch_id`. | | `retrieve-all-spam-reports` | Retrieve spam reports in pages using `limit` for page size and `offset` to continue from a specific list position. | | `retrieve-all-suppressions` | Retrieve a list of all suppressions across all suppression groups. | | `retrieve-all-suppressions-for-suppression-group` | **This endpoint allows you to retrieve all suppressed email addresses belonging to the given group.** | | `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. | | `retrieve-all-ips-in-specified-pool` | Retrieves all IP addresses that are assigned to a specific IP pool. | | `retrieve-authenticated-domain` | Retrieves details of a specific authenticated domain by its unique ID. | | `retrieve-existing-api-key` | Retrieves the details of an existing SendGrid API key by its unique identifier. | | `retrieve-reverse-dns-record` | Retrieves a specific reverse DNS (formerly IP Whitelabel) record by its ID. | | `retrieve-single-campaign` | Retrieves a specific campaign from SendGrid's Legacy Marketing Campaigns by its ID. | | `retrieve-single-list` | Retrieve detailed information about a specific marketing list by its unique ID. | | `retrieve-single-recipient` | Retrieve a single recipient by ID from the Legacy Marketing Campaigns contact database. **IMPORTANT**: This is a Legacy Marketing Campaigns API endpoint (/v3/contactdb/). | | `retrieve-single-transactional-template` | Retrieves a single transactional template by its ID, including all associated template versions. | | `retrieve-specific-alert` | Retrieve details for a specific SendGrid alert by its ID. Alerts notify you about email usage limits or provide periodic email statistics. | | `retrieve-specific-allowed-ip` | Retrieves details of a specific IP address from your SendGrid account's IP Access Management allow list using its unique rule ID. | | `retrieve-specific-block` | Retrieves details for a specific email address from your SendGrid blocks list. | | `retrieve-specific-invalid-email` | Retrieves details about a specific email address from SendGrid's invalid email suppression list. | | `retrieve-specific-parse-setting` | Retrieves a specific inbound parse webhook setting by hostname. | | `retrieve-specific-spam-report` | Retrieves a specific spam report by email address from SendGrid's suppression list. | | `retrieve-specific-transactional-template-version` | Retrieves a specific version of a transactional template by its template ID and version ID. | | `retrieve-subuser-s-branded-link` | Retrieve the branded link associated with a specific subuser. | | `retrieve-bounce-classification-totals` | This endpoint will return the total number of bounces by classification in descending order for each day. | | `retrieve-bounce-purge-mail-settings` | Retrieve your current Bounce Purge mail settings. This setting configures the maximum age (in days) of contacts in your hard and soft bounce... | | `retrieve-click-track-settings` | Retrieves your current click tracking settings from SendGrid. | | `retrieve-current-enforced-tls-settings` | Retrieve the current Enforced TLS settings for your SendGrid account. | | `retrieve-email-statistics-by-browser` | Retrieve email statistics segmented by browser type (Chrome, Firefox, Safari, etc.). | | `retrieve-email-statistics-by-client-type` | Retrieve email statistics segmented by client type (Webmail, Desktop, Phone, Tablet, Other). | | `retrieve-email-statistics-by-device-type` | Retrieve email statistics segmented by device type (Desktop, Webmail, Phone, Tablet, Other). | | `retrieve-email-statistics-by-mailbox-provider` | Retrieve email statistics segmented by recipient mailbox provider (e.g., Gmail, Yahoo, Microsoft Outlook). | | `retrieve-email-statistics-for-categories` | Retrieve email statistics for specific categories within a date range. | | `retrieve-email-statistics-for-your-subusers` | Retrieves email statistics for specified subusers over a date range. | | `retrieve-footer-mail-settings` | Retrieve your current Footer mail settings from SendGrid. The Footer setting allows you to insert a custom footer at the bottom of all text and HTML... | | `retrieve-forward-bounce-mail-settings` | Retrieves the current forward bounce mail settings for your SendGrid account. | | `retrieve-forward-spam-mail-settings` | Retrieves the current forward spam mail settings for your SendGrid account. | | `retrieve-global-email-statistics` | Retrieve global email statistics for your SendGrid account within a specific date range. | | `retrieve-google-analytics-settings` | Retrieves the current Google Analytics tracking settings for your SendGrid account. | | `retrieve-legacy-template-mail-settings` | Retrieves your current legacy email template mail settings. The legacy template setting wraps an HTML template around your email content, useful for... | | `retrieve-monthly-stats-for-all-subusers` | Retrieves monthly email statistics for all subusers. Returns metrics such as blocks, bounces, clicks, delivered emails, opens, requests, unique... | | `retrieve-paged-transactional-templates` | **This endpoint allows you to retrieve all transactional templates.** | | `retrieve-recipients` | Retrieve all marketing campaign recipients via this endpoint. | | `retrieve-recipients-on-segment` | Retrieves all recipients (contacts) in a specified segment from SendGrid's Legacy Marketing Campaigns Contact Database. | | `retrieve-reserved-fields` | **Retrieve all reserved fields from the Legacy Marketing Campaigns Contact Database.** This endpoint returns a list of fields that are reserved by... | | `retrieve-scheduled-send` | Retrieve the cancel/pause status of a scheduled email batch by its batch\_id. | | `retrieves-inbound-parse-webhook-statistics` | Retrieve statistics for emails processed by SendGrid's Inbound Parse Webhook. | | `retrieve-single-segment-endpoint` | Retrieves detailed information about a specific Marketing Campaigns segment by its unique ID. | | `retrieve-specific-teammate` | Retrieves details of a specific SendGrid teammate by username. | | `retrieve-stats-by-specific-client-type` | Retrieve email statistics for a specific client type (phone, tablet, webmail, or desktop). | | `retrieve-subscription-tracking-settings` | Retrieves the current subscription tracking settings for your SendGrid account. | | `retrieve-subuser-reputations` | Retrieves sender reputation scores (0-100) for subusers. Reputation reflects email delivery performance based on recipient engagement, bounces, spam... | | `retrieve-sums-of-email-stats-for-each-category` | Retrieve aggregated email statistics sums for each category over a date range. | | `retrieve-count-of-billable-recipients` | Retrieves the count of billable recipients for SendGrid Legacy Marketing Campaigns. | | `retrieve-default-branded-link` | Retrieves the default branded link for message sending. Branded links (formerly 'Link Whitelabel') allow click-tracked links, opens, and images in... | | `retrieve-lists-that-recipient-is-on` | Retrieves all marketing campaign lists that a specific recipient belongs to. | | `retrieve-tracking-settings` | **This endpoint allows you to retrieve a list of all tracking settings on your account.** | | `retrieve-user-s-authenticated-domains` | Retrieve authenticated domains (up to five) assigned to a specific subuser. | | `retrieve-your-account-email-address` | Retrieves the email address currently on file for your SendGrid account. | | `retrieve-your-credit-balance` | Retrieves the current email credit balance for your SendGrid account. | | `retrieve-your-username` | Retrieve your current SendGrid account username and user ID. | | `returns-list-of-all-partner-settings` | Retrieve a paginated list of all partner settings that can be enabled for your SendGrid account. | | `schedule-campaign` | Schedules a Legacy Marketing Campaigns email for delivery at a specific time. | | `schedule-single-send` | Schedule a Single Send for immediate or future delivery. Use `send_at: 'now'` to send immediately, or provide an ISO 8601 date-time for scheduled delivery. | | `search-contacts` | Find contacts using this endpoint with a body containing a `query` in SGQL. | | `search-for-suppressions-within-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... | | `search-recipients` | Search for recipients in the Legacy Marketing Campaigns contact database by field value. | | `send-campaign` | Immediately sends an existing marketing campaign to its configured recipients. **IMPORTANT**: This is a Legacy Marketing Campaigns API endpoint. | | `send-test-campaign` | Sends a test version of a marketing campaign to specified email addresses for review before sending to your full recipient list. **IMPORTANT:** This... | | `send-test-marketing-email` | Send a test marketing email before launching a campaign. This endpoint allows you to test your marketing email by sending it to up to 10 email addresses. | | `send-email-with-twilio-send-grid` | The Mail Send operation uses SendGrid's v3 API to send emails. | | `set-up-reverse-dns` | Set up reverse DNS (rDNS) for a dedicated IP address. Reverse DNS allows mailbox providers to verify the sender by performing a reverse DNS lookup when receiving emails. | | `start-warming-up-ip-address` | Put a dedicated IP address into warmup mode. IP warmup gradually increases the sending volume from an IP address to build a positive sending reputation. | | `stop-warming-up-ip-address` | Stop warming up a dedicated IP address and remove automatic sending limits. | | `sum-email-stats-for-subusers` | Retrieves summed email statistics for all subusers over a date range. | | `test-event-webhook-s-settings` | Sends a test event notification to a specified URL to verify your webhook endpoint is properly configured to receive SendGrid events. | | `toggle-webhook-signature` | Enable or disable signature verification for a single Event Webhook by its ID. | | `unlink-subuser-domain` | Disassociate an authenticated domain from a subuser. This removes the link between a domain authentication and a specific subuser, preventing the... | | `unschedule-scheduled-campaign` | Unschedule a campaign that has already been scheduled to be sent. **Note**: This endpoint is part of the Legacy Marketing Campaigns API. | | `update-branded-link` | Update a specific branded link's default status. Link branding (formerly 'Link Whitelabel') allows all click-tracked links in your emails to be... | | `update-campaign` | Updates an existing marketing campaign. You can modify the campaign's title, subject line, HTML content, plain text content, and categories. | | `update-account-offerings` | Updates the offerings (email packages and add-ons) assigned to a customer account. | | `update-address-whitelist-mail-settings` | Updates the address whitelist mail settings for your SendGrid account. | | `update-list` | Update the name of an existing contact list in SendGrid Marketing Campaigns. | | `update-account-s-state` | Update the state of a customer account using the Account Provisioning API. | | `update-alert` | Update an existing SendGrid alert's settings. Supports updating two types of alerts: - **usage\_limit**: Update the percentage threshold (0-100) or... | | `update-authenticated-domain` | Updates the settings for an authenticated domain in SendGrid. | | `update-ip-pool-name` | Updates the name of an existing IP Pool in your SendGrid account. | | `update-sso-integration` | Update an existing Single Sign-On (SSO) integration for your SendGrid account. | | `update-parse-setting` | Updates an existing Inbound Parse Webhook setting by hostname. **Prerequisites:** 1. | | `update-api-key-name` | Updates the name of an existing SendGrid API key. This endpoint only modifies the key's display name and does not change its permissions/scopes. | | `update-api-key-name-and-scopes` | Updates both the name and permission scopes of an existing SendGrid API key. | | `update-scheduled-campaign` | Updates the scheduled send time for a Legacy Marketing Campaigns email. | | `update-scheduled-send` | Update the status of a scheduled send batch that already has a pause or cancel status. | | `update-segment` | Updates an existing segment in SendGrid's Marketing Campaigns using the Segmentation V2 API. | | `update-sender` | Updates an existing Sender identity for use in SendGrid Marketing Campaigns. **Important Notes:** - Partial updates are supported - only include... | | `update-sender-identity` | Updates an existing sender identity in SendGrid. This action allows partial updates - only the fields you provide will be modified, while all other... | | `update-single-event-webhook-by-id` | Updates the configuration of a specific Event Webhook by its ID. | | `update-suppression-group` | Updates an existing suppression group (also known as an unsubscribe group). | | `update-user-s-profile` | Updates the authenticated user's profile information in SendGrid. **Important:** At least one parameter must be provided. | | `update-bounce-purge-mail-settings` | Update your Bounce Purge mail settings in SendGrid. This setting configures automatic purging of contacts from your hard and soft bounce suppression... | | `update-click-tracking-settings` | Updates click tracking settings for your SendGrid account. Click tracking monitors email engagement by redirecting links through SendGrid's servers... | | `update-custom-field-definition` | Updates the name of an existing custom field in SendGrid Marketing Contacts. | | `update-design` | Updates an existing email design in the SendGrid Design Library using PATCH. | | `update-details-for-ip-address` | Updates settings for a dedicated IP address in your SendGrid account. | | `update-enforced-tls-settings` | Update the Enforced TLS settings for your SendGrid account. Enforced TLS controls whether recipients must support TLS encryption and have valid... | | `update-footer-mail-settings` | Update your Footer mail settings in SendGrid. This endpoint allows you to configure a custom footer that will be appended to the bottom of all... | | `update-forward-bounce-mail-settings` | Updates the forward bounce mail settings for your SendGrid account. | | `update-forward-spam-mail-settings` | Updates the Forward Spam mail settings for your SendGrid account. | | `update-google-analytics-settings` | Updates Google Analytics tracking settings for your SendGrid account. | | `update-integration` | Update an existing Marketing Integration by its unique ID. An Integration is a connection from SendGrid Marketing Campaigns to a supported... | | `update-open-tracking-settings` | Updates open tracking settings for your SendGrid account. Open tracking monitors email engagement by inserting an invisible 1x1 pixel image (tracking... | | `update-single-send` | Update a Single Send draft by its ID. This endpoint allows you to modify specific properties of a Single Send without affecting other fields. | | `update-sso-certificate` | Update an existing SSO (Single Sign-On) certificate by its ID. | | `update-subscription-tracking-settings` | Updates subscription tracking settings for your SendGrid account. | | `update-teammate-s-permissions` | Updates a teammate's permissions in your SendGrid account. To grant full admin access: set `is_admin` to True and `scopes` to an empty array \[]. | | `update-template-mail-settings` | Updates the legacy email template mail settings for your SendGrid account. | | `update-credits-for-subuser` | Update the credit allocation settings for a SendGrid Subuser. | | `update-remaining-credits-for-subuser` | Updates the remaining credits for a specific Subuser account by adding or subtracting from the current credit balance. | | `update-your-account-email-address` | Updates the email address currently on file for your SendGrid account. | | `update-your-password` | Update the password for your SendGrid account. **Important**: This endpoint requires username/password authentication and cannot be accessed using API key authentication. | | `update-your-username` | Update the username for your SendGrid account. This endpoint allows you to change the username associated with your account. | | `validate-batch-id` | Validate whether a mail batch ID exists in SendGrid's system. | | `validate-branded-link` | **This endpoint allows you to validate a branded link.** It checks that the required DNS CNAME records are correctly configured for your branded link domain. | | `validate-domain-authentication` | **This endpoint allows you to validate an authenticated domain.** It checks that the required DNS records are correctly configured for your sending domain. | | `validate-email` | Validates an email address and returns a verdict on its validity. | | `validate-reverse-dns-record` | Validate a reverse DNS (rDNS) record to check if DNS is properly configured. | | `verify-sender-request` | Verifies a sender identity using a token from the verification email. | | `view-sender-identity` | Retrieves the details of a specific Legacy Sender Identity by its unique ID. | | `view-scheduled-time-of-campaign` | Retrieves the scheduled send date and time for a Legacy Marketing Campaign. | [Open SendGrid in the console →](https://app.boxd.sh/integrations/detail/sendgrid)