Reference

Create api keys

Generate a new SendGrid API key with specific permissions to enable secure integration with your email sending systems and third-party applications. Store the returned key securely as it's only displayed once.

Delete api keys

Revoke an API key to immediately stop it from being used for authentication, securing your account if a key is compromised or no longer needed.

List api keys

View all your SendGrid API keys and their IDs to manage your email sending integrations and monitor which applications have access to your account.

Retrieve an existing api key

Look up the details of an existing SendGrid API key to verify its name and permissions without exposing the actual key string. Useful for auditing which integrations have access to your email account and what they can do.

Update API Key Name

Rename your SendGrid API keys to improve organization and make it easier to identify which key is used for which purpose in your email infrastructure.

Update api key name and scopes

Modify an existing SendGrid API key's name and access permissions to control what actions it can perform. Use this when you need to rename a key for better organization or adjust its capabilities for security or functional reasons.

Approve access request

Authorize a team member's request to access your SendGrid account, enabling them to manage email campaigns and settings once approved by an admin.

Deny access request

Reject a teammate's request for additional access permissions to your SendGrid account without granting the requested privileges.

Retrieve a list of scopes for which this user has access

Checks which SendGrid features and capabilities your account has access to, helping you understand what actions you're able to perform.

Retrieve access requests

View a list of recent access requests to your SendGrid account with pagination controls to manage large volumes of data. This helps you monitor who has requested access to your account resources.

Retrieve all recent access attempts

Monitor recent login attempts and access activity on your SendGrid account to track who is accessing your email sending platform. This helps you identify unauthorized access attempts and maintain security oversight.

Create an account

Set up a new customer email account within your SendGrid organization, enabling you to manage multiple client accounts from a single reseller platform. This is essential for email service providers and agencies managing email infrastructure for their customers.

Delete an account

Permanently removes a SendGrid customer account and all associated resources, including API keys, dedicated IPs, and billing access. This action is irreversible and immediately cancels all service for the specified account.

Get a User's Account Information

Retrieve your SendGrid account details including subscription level and email sender reputation score to monitor your email deliverability health and account status.

Get account offerings

Check which email packages and features are currently included in your SendGrid account to understand your available sending capabilities and add-ons.

Get Account State

Check whether a customer's SendGrid account is active and able to send emails, helping you understand account status at a glance. This is useful for reseller partners managing multiple customer accounts.

Get all accounts

Retrieves a complete list of all email accounts under your organization, helping you manage and monitor multiple sending accounts from one place.

Get all available offerings

Retrieve all available SendGrid product offerings and packages that can be assigned to customer accounts, including email plans, dedicated IPs, and add-on features. Use this to see what products and services you can offer or provision for your clients.

Get User Profile

Retrieve your SendGrid account profile details including your name, contact information, company, and address to verify your account setup and configuration.

Retrieve your account email address

Fetches the primary email address associated with your SendGrid account, which is used for important account notifications and billing communications. This helps you verify or update contact information linked to your sending service.

Retrieve your username

Fetch your SendGrid account username and user ID to verify your account identity and access key information. Useful for confirming account details or troubleshooting authentication issues.

Update a User's Profile

Keeps your SendGrid account profile current by updating your personal and business details like name, company, address, and website. This ensures your account information stays accurate and reflects your current business identity.

Update account offerings

Modify the email packages and add-ons assigned to your SendGrid account, such as upgrading to a higher tier plan or adding dedicated IP addresses. This operation replaces your entire offerings configuration, so you must specify all packages and add-ons you want to keep.

Update Account State

Activate or deactivate a customer email account to control whether they can send emails through your SendGrid reseller service. This is useful for managing account access and billing periods for your customers.

Update your account email address

Updates the primary email address associated with your SendGrid account to ensure you receive important account notifications and communications at the correct contact address.

Update your password

Securely update your SendGrid account password to maintain access control and protect your email marketing platform. Use this when you need to change your credentials due to security concerns or account management requirements.

Update your username

Change the username associated with your SendGrid account to better match your brand or personal preference. This helps you maintain consistent identity across your email marketing platform.

Create a new alert

Set up automated notifications to monitor your email sending activity and receive alerts when usage reaches specific thresholds or get periodic reports on your email performance.

Delete an alert

Remove an email alert from your SendGrid account that you no longer need to monitor. This permanently deletes the alert configuration so you won't receive those notifications anymore.

Retrieve a specific alert

Fetch detailed information about a specific SendGrid alert to review its configuration, recipient settings, and threshold details. This helps you monitor your email delivery notifications and ensure critical alerts are properly set up.

Retrieve all alerts

Fetches all email alerts you've set up in SendGrid, including usage notifications and statistics reports, so you can monitor your email sending activity and delivery metrics at a glance.

Update an alert

Modify existing SendGrid alerts to change notification thresholds, frequency, or recipient email addresses based on your alert type. Use this to keep your email sending notifications aligned with your business needs as they change.

Authenticate an account with single sign on

Generates a one-time authentication URL that allows seamless single sign-on access to a SendGrid account without requiring the user to enter credentials.

Create an sso certificate

Set up SAML authentication security for your SendGrid account, enabling single sign-on through your company's identity provider to streamline team access control.

Create an sso integration

Set up Single Sign-On authentication for your SendGrid account using your organization's identity provider, allowing your team to log in securely through your existing credentials.

Delete an SSO Certificate

Permanently removes an SSO certificate from your SendGrid account to manage single sign-on authentication for your team. Use this when you need to retire old certificates or revoke access methods.

Delete an SSO Integration

Removes an SSO (Single Sign-On) authentication integration from your SendGrid account, preventing further logins through that identity provider.

Get All SSO Certificates by Integration

Retrieves all SSO security certificates linked to your identity provider integration, allowing you to manage authentication credentials for single sign-on access to your SendGrid account.

Get all sso integrations

Retrieve all single sign-on integrations connected to your SendGrid account to manage and audit your authentication setup. This helps you understand which SSO systems are currently active and get their IDs for further configuration.

Get an SSO Certificate

Retrieve a specific SSO certificate from your SendGrid account to view certificate details needed for managing single sign-on authentication with your identity provider.

Get an sso integration

Retrieves the details and configuration of a specific single sign-on integration for your SendGrid account. Use this to view authentication settings, status, and metadata for a particular SSO setup.

Update an SSO Integration

Modify your SendGrid Single Sign-On configuration to update identity provider settings, enable or disable SSO access, and adjust integration details. Use this to keep your authentication setup current as your team or security requirements change.

Update SSO Certificate

Modify an existing SSO certificate to update its public certificate, enable or disable authentication, or change integration settings for your SendGrid account. This ensures your team's secure login credentials stay current and properly configured.

Retrieve your credit balance

Check your SendGrid account's current email sending credits and usage to monitor your email capacity and plan sending campaigns accordingly.

Associate a branded link with a subuser

Link a branded domain to a subuser account so their outgoing emails display tracked links from your custom domain instead of SendGrid's. This maintains brand consistency across all emails sent by team members or client accounts.

Create a branded link

Create a custom branded link using your domain that replaces generic SendGrid tracking URLs in your emails, making your communications appear more professional and trustworthy to recipients.

Delete a branded link

Permanently remove a branded link from your SendGrid account when it's no longer needed for email campaigns. This irreversible action helps keep your link management clean and organized.

Disassociate a branded link from a subuser

Remove a branded link from a subuser account so they can no longer use the parent account's branded domain for email tracking. This helps manage which team members or client accounts have access to your branded email links.

Retrieve a branded link

Fetch the configuration details of a specific branded link to verify its setup and status, ensuring your email clicks and images are properly branded with your domain instead of SendGrid's infrastructure.

Retrieve a subuser's branded link

Retrieves the branded link configuration associated with a specific subuser, allowing you to verify which custom domain is being used for tracking email clicks and opens from that subuser's account.

Retrieve all branded links

View all the custom branded links you've created for your email campaigns, allowing you to manage and track which links are active across your sending domains.

Retrieve the default branded link

Retrieves your default branded link configuration to see which domain is currently being used for tracking email clicks and images in your messages. This helps you verify that your emails display your branded domain instead of SendGrid's default domain.

Update a branded link

Change which of your branded domains is used as the default for click tracking in emails, allowing you to control which domain appears in your email links.

Validate a branded link

Checks whether your branded link domain is properly configured with the correct DNS records so your email clicks are tracked through your own domain. This ensures your branded link is ready to use in your email campaigns.

Create a campaign

Set up a new email campaign by defining the subject, sender details, and content, then assign it to your audience list or segment for distribution. This lets you organize and manage bulk email communications before sending or scheduling them out.

Send a campaign

Instantly deliver a prepared marketing campaign to your configured audience lists or segments. This sends your campaign immediately to all recipients and cannot be reversed once executed.

Bulk delete single sends

Permanently remove multiple email campaigns at once to clean up your SendGrid account and free up clutter. Use this when you need to delete old, duplicate, or failed campaigns in bulk without processing them individually.

Cancel or pause a scheduled send

Stop or temporarily hold scheduled email campaigns before they're sent, giving you the flexibility to fix content, adjust timing, or cancel entirely without losing the draft.

Create single send

Create a draft email campaign that you can customize and refine before sending to your audience, without needing to use a pre-made template.

Delete a campaign

Permanently removes a marketing campaign from your SendGrid account. Use this when you need to clean up old campaigns or remove campaigns that are no longer relevant to your business.

Delete a cancellation or pause from a scheduled send

Resume a paused or cancelled scheduled email campaign by removing its pause or cancel status, allowing the emails to be sent at their originally scheduled time. Use this to recover from accidental pauses or cancellations before the emails are discarded.

Delete single send by id

Permanently removes a specific Single Send campaign from your SendGrid account. Use this when you need to clean up failed, duplicate, or no longer needed email campaigns.

Delete single send schedule

Cancel a scheduled email campaign while keeping all content and settings intact for future use. This allows you to pause or reschedule a Single Send without losing your work.

Duplicate Single Send

Creates a copy of an existing email campaign that you can edit independently, letting you quickly build variations without starting over.

Get all single sends

Retrieve a list of all your Single Sends campaigns with their IDs and basic details, allowing you to view and manage your email marketing campaigns at a glance.

Get single send by id

Retrieve detailed information about a specific email campaign you've created, including its content, settings, and performance status. This helps you review campaign details and track what you've sent to your contacts.

Get single sends search

Search and filter your marketing email campaigns by name, status, or category to quickly locate specific Single Sends when managing multiple campaigns.

Retrieve a single campaign

Fetch detailed information about a specific email campaign including its content, recipients, and current status to review campaign performance and settings.

Retrieve all campaigns

Retrieve a list of all your email campaigns from SendGrid so you can review their performance, status, and details. This helps you manage and organize your marketing communications in one place.

Retrieve all scheduled sends

View all your scheduled email sends to monitor pending campaigns and their status, helping you manage your email marketing timeline effectively. This operation is useful for tracking batch email campaigns that were scheduled in advance.

Retrieve scheduled send

Check whether a scheduled email batch has been paused or cancelled so you can verify the status of your bulk email campaigns. This helps you track which scheduled sends are still active or have been stopped.

Schedule a campaign

Schedules an email campaign for automatic delivery at a specific time, allowing you to reach your audience when it's most convenient for you rather than sending immediately.

Schedule single send

Schedule an email campaign to send immediately or at a specific future date and time, allowing you to reach your audience when you want without manual intervention.

Send a test campaign

Send a test version of your marketing campaign to specific email addresses before launching it to your full audience, allowing you to review content and design.

Send a test marketing email

Preview your marketing email template and formatting by sending test versions to a small group of recipients before launching to your full audience. This helps catch design issues, copy errors, or delivery problems early.

Unschedule a scheduled campaign

Cancel a campaign that you've scheduled to send at a future time, allowing you to stop it before it reaches your audience. Use this when your message needs to be revised, delayed, or sent at a different time.

Update a campaign

Modify the details of a draft marketing campaign including its title, subject line, content, and categories before sending it out. This lets you refine your messaging and targeting before committing to a send.

Update a scheduled campaign

Modify the scheduled send time for an email campaign that's already been queued for delivery. This lets you adjust when your marketing message goes out to your audience without losing any of the campaign content or settings.

Update a scheduled send

Modify the status of a scheduled email batch between paused and cancelled states, allowing you to adjust your send strategy without losing the scheduled message entirely.

Update single send

Modify draft email campaigns in your SendGrid account by updating specific fields like subject line, content, or recipients. This lets you refine campaign details before sending without recreating the entire draft.

View scheduled time of a campaign

Check when a scheduled email campaign is set to send so you can coordinate timing and ensure campaigns go out as planned.

Get All Single Sends Categories

Retrieves all categories you've created to organize your marketing campaign emails, helping you manage and track your single sends by topic or campaign type.

Retrieve all categories

Retrieve all email categories you've created in SendGrid to organize and track your email campaigns and communications. This helps you pull together all your category labels so you can see how your emails are organized across different initiatives.

Add or update a contact

Add new contacts to your SendGrid email list or update existing contact information like preferences and custom fields. This helps you keep your subscriber database current for targeted email campaigns.

Create a list

Create a new contact list in SendGrid to organize and segment your email contacts for targeted marketing campaigns.

Import contacts

Initiates a bulk upload of contacts to your SendGrid account by providing an upload URL and headers for your CSV file, supporting up to 1 million contacts in a single import. Existing contacts are automatically updated while new ones are created, enabling you to quickly synchronize your customer database.

Retrieve all lists

Fetch all your contact lists from SendGrid to see what audience segments you've created and how many contacts are in each list. This helps you organize and manage your email marketing campaigns effectively.

Add a single recipient to a list

Add an individual contact to a specific mailing list in SendGrid so you can organize and segment your subscribers for targeted email campaigns.

Create list

Creates a new contact list in SendGrid for organizing and segmenting your email subscribers by group or campaign. Use this to build targeted audiences that you can manage and email separately.

Delete a contact identifier

Remove a specific identifier (like an email address or phone number) from a contact while keeping the contact record intact. This is useful when you need to update contact information without losing their communication history and preferences.

Delete a recipient

Permanently removes a recipient from SendGrid's legacy contact database, ensuring they no longer receive any campaigns or communications. This is useful for honoring unsubscribe requests and maintaining contact list accuracy.

Delete a single recipient from a single list

Remove a contact from a specific SendGrid mailing list to keep your subscriber lists clean and up-to-date. This is useful when contacts unsubscribe, become inactive, or request removal from your communications.

Delete contacts

Remove contacts from your SendGrid Marketing Campaigns account either individually by ID or in bulk. This irreversible action processes asynchronously and is useful for maintaining a clean contact list.

Erase recipients email data

Permanently removes customer email data and associated personal information from SendGrid to meet privacy regulations and data protection requirements. Use this when customers request their data be deleted or when cleaning up outdated contact information.

Get a contact by id

Retrieves complete contact details including email, name, custom fields, and other information for a specific contact in your SendGrid audience by their unique ID.

Get batched contacts by ids

Retrieve multiple SendGrid contacts in a single request by providing their IDs, making it efficient to fetch up to 100 contact details at once instead of querying them individually.

Get Contacts by Emails

Look up your marketing contacts by their email addresses to retrieve their profile information and engagement data. This is useful when you need to quickly find specific contacts without writing complex queries.

Get contacts by identifiers

Retrieve detailed contact information for up to 100 people by searching with email addresses, phone numbers, external IDs, or anonymous identifiers. This helps you quickly fetch contact data you already have references for without manually looking through your entire contact list.

Get list contact count

Retrieve the total and billable contact counts for a specific marketing list to monitor list size and understand your billing impact. This helps you track how your subscriber base is growing and validate that contacts are being added correctly.

Get Recipient Upload Status (Legacy)

Check the progress of bulk contact uploads to your SendGrid email list to determine when newly added recipients are ready for campaigns. This helps you understand if your contact data has finished processing after a batch upload.

Get sample contacts

Quickly preview up to 50 contacts from your marketing database sorted by email address to get an overview of your audience without needing to load your entire contact list.

Get total contact count

Retrieve the total number of contacts in your SendGrid Marketing Campaigns account, including billable contact counts for the current billing period. Use this to monitor your contact database size and understand your email marketing costs.

Import contacts status

Check the progress and results of contact imports, updates, or deletions in your SendGrid email list to ensure your data changes were processed successfully.

Remove contacts from a list

Remove specific contacts from a marketing list while keeping them in your SendGrid account for other campaigns. Use this when you need to manage list membership without permanently deleting contact data.

Remove list and optional contacts

Permanently delete a marketing list from your SendGrid account, with the option to also remove all contacts on that list. Use this when you no longer need a specific audience segment or want to clean up outdated contact groups.

Retrieve a count of recipients

Get the total number of recipients stored in your SendGrid Legacy Marketing Campaigns contact database to understand your audience size and manage your contact list effectively.

Retrieve a single list

Retrieve detailed information about a specific marketing list including its name, contact count, and optionally a sample of recent contacts to verify list quality and contents.

Retrieve a single recipient

Look up a specific contact's profile and engagement history from your SendGrid contact database, including their email, name, and interaction timestamps. This helps you understand customer engagement patterns and verify contact information.

Retrieve all recipients on a list

Fetches all contacts stored in a specific SendGrid mailing list, allowing you to see who's included in that audience. This helps you manage your subscriber base and understand your list composition before launching campaigns.

Retrieve recipients

Fetch all recipients from your marketing campaigns to view your complete contact list and manage your email audience. This helps you understand who's receiving your marketing messages and maintain accurate subscriber records.

Retrieve recipients on a segment

Retrieves all contacts within a specific SendGrid segment, including their email, engagement history, and custom field data to help you understand and analyze your audience groups.

Retrieve the lists that a recipient is on

Check which email lists a contact belongs to in your marketing database so you can understand their engagement history and segment communications accordingly.

Search contacts

Find specific contacts in your SendGrid database using search filters to locate customers by name, email, or other properties. This helps you quickly identify and segment contacts for targeted communications.

Search recipients

Search your email contact database to find specific recipients by email, name, or custom field values, helping you quickly locate customer information and manage your audience.

Update a list

Rename an existing contact list in your SendGrid Marketing Campaigns to keep your audience segments organized and clearly labeled. This helps you maintain a logical structure as your contact database grows.

Update list

Rename an existing contact list in your SendGrid Marketing Campaigns account to better organize and identify your audience segments.

Create a custom field

Creates a custom field in SendGrid to store additional contact information beyond standard fields like name and email. This lets you organize and segment your audience based on data that's unique to your business.

Create custom field definition

Create custom fields to store and organize subscriber-specific information like purchase history, preferences, or company details within your SendGrid contact lists. This lets you segment and personalize email campaigns based on unique data attributes.

Delete a custom field

Permanently removes a custom field from your SendGrid contact database, deleting all associated data for all contacts. Use this when you no longer need to track specific information about your subscribers.

Delete custom field definition

Permanently removes a custom field from your SendGrid contact database, allowing you to clean up unused data fields and restructure your contact schema. This action cannot be undone and will delete all data stored in that field.

Get all field definitions

Retrieve all field definitions (both custom and system fields) from your SendGrid Marketing Campaigns account to understand what contact data you can work with. This helps you identify the exact field IDs and types needed for managing your email contacts and segments.

Retrieve a custom field

Retrieves the details of a specific custom field you've created in SendGrid, including its name and data type, so you can verify field configurations or reference field information in your automation workflows.

Retrieve all custom fields

View all custom fields you've set up for your contacts, including their names and data types. This helps you understand what additional contact information you're currently tracking beyond basic details like email and name.

Retrieve reserved fields

Retrieve a list of reserved field names in your SendGrid contact database that cannot be used for custom fields, helping you avoid naming conflicts when organizing your subscriber data.

Update custom field definition

Modify the name of an existing custom field in your SendGrid contact database to keep your customer data structure organized and relevant to your business needs.

Create design

Build and save reusable email templates in your SendGrid account that you can quickly apply to campaigns, automations, and transactional emails. This eliminates the need to recreate the same design across multiple marketing initiatives.

Delete design

Permanently remove an email design template from your SendGrid account to clean up unused designs and manage your template library. This action cannot be undone, so ensure you're deleting the correct design.

Duplicate design

Creates a copy of an existing email design in your SendGrid library so you can reuse and modify proven templates without starting from scratch.

Duplicate sendgrid pre built design

Creates a personalized copy of a professional SendGrid email template that you can customize for your campaigns. This lets you quickly start with polished designs instead of building from scratch.

Get design

Retrieve the complete details and content of a saved email design from your Design Library, including its HTML, formatting, and visual preview. This lets you review design specifications before reusing or modifying templates.

Get SendGrid Pre-built Design

Retrieve the details of a SendGrid pre-built email template to inspect its design, content, and structure before customizing it for your campaigns.

List designs

Retrieve your saved email designs from SendGrid's Design Library to reuse or modify existing templates for future campaigns. This helps you maintain consistent branding while saving time on design recreation.

List sendgrid pre built designs

Browse SendGrid's collection of professionally designed email templates that you can use as a starting point for your campaigns. This helps you quickly create polished emails without starting from scratch.

Update design

Modify an existing email design template by updating its name, HTML content, subject line, categories, or plain text version. Perfect for refining and reusing email designs across your campaigns.

Add an ip to an authenticated domain

Associates a dedicated IP address with an authenticated domain to enhance email deliverability and maintain a professional sending reputation. This helps ensure your emails pass authentication checks and appear as coming directly from your domain.

Associate an authenticated domain with a given user

Link a verified email domain to a team member's account so they can send emails on behalf of your business domain without needing their own domain authentication. This streamlines email setup for subusers while maintaining centralized domain control.

Authenticate a domain

Verify ownership of your email domain with SendGrid to enable professional email sending and ensure deliverability. This process authenticates your domain so recipients trust emails coming from your business address.

Bind authenticated domains to user

Link additional verified email domains to a team member's SendGrid account so they can send emails from multiple branded domains. This allows you to expand sending capabilities for subusers up to 5 authenticated domains.

Delete a reverse dns record

Remove a reverse DNS record from your SendGrid account to stop email authentication on a specific domain or IP address.

Delete an authenticated domain

Remove domain authentication from SendGrid so emails from that domain no longer show SendGrid branding in recipient inboxes. Use this when you're no longer sending from a specific domain or want to clean up unused sending domains.

Disassociate an authenticated domain from a given user

Removes all authenticated domain associations from a subuser account, preventing them from sending emails through your parent account's verified domains. This is useful when offboarding team members or revoking their email sending privileges.

Domain warn list

Get a list of domains with DMARC authentication policies that could affect your email deliverability, categorized by whether they'll completely block emails or potentially reduce their effectiveness.

Email dns records to a co worker

Send DNS configuration records via email to a team member for setting up domain authentication or link branding in SendGrid. This simplifies the handoff process when delegating DNS setup to colleagues or technical staff.

Get the default authentication

Retrieves your SendGrid account's default domain authentication settings, showing which domain will be used to send emails unless a specific authenticated domain is configured for a particular sender address.

List all authenticated domains

Check which of your email domains are authenticated with SendGrid so you can verify you're sending from legitimate, trusted domains. This helps ensure your emails reach customer inboxes and aren't marked as spam.

List the authenticated domain associated with the given user

Retrieve all authenticated domains that have been set up for a specific user account, allowing you to see which domains are authorized to send emails through your SendGrid account.

Remove an ip from an authenticated domain

Unlink a dedicated IP address from your authenticated email domain's SPF configuration, allowing you to reassign or stop using that IP for email sending through that domain.

Retrieve a reverse DNS record

Retrieves the details of a specific reverse DNS record you've set up for your SendGrid account, including its validation status and configuration details. This helps you monitor whether your email authentication is properly configured.

Retrieve all reverse dns records

View all your reverse DNS records to verify your email sending domain authenticity and identify which IP addresses are properly configured for email delivery. This helps ensure your emails reach customers' inboxes by confirming your sending infrastructure is properly set up.

Retrieve an authenticated domain

Fetch the detailed configuration and verification status of a specific authenticated domain, including its DNS records and security settings. This lets you verify your sending domain is properly set up and troubleshoot any delivery issues.

Retrieve User's Authenticated Domains

View the authenticated email domains associated with a specific subuser account, allowing you to manage which domains your team members can use for sending emails.

Set up reverse dns

Configure reverse DNS (rDNS) for a dedicated IP address to improve email deliverability and establish trust with email providers through domain verification. This helps ensure your marketing and transactional emails reach inbox instead of spam folders.

Update an authenticated domain

Modify the settings of an authenticated domain in SendGrid, such as switching between automatic and manual SPF configuration or designating it as your default sending domain.

Validate a domain authentication

Verify that your domain's DNS records are properly configured for sending emails through SendGrid. This ensures your domain is authenticated and ready to send messages with proper security verification.

Validate a reverse dns record

Verifies that your reverse DNS (rDNS) A record has been properly configured in your DNS provider, confirming your email sending infrastructure is correctly set up. This ensures emails sent from your domain are properly authenticated for better deliverability.

Send email with twilio sendgrid

Sends emails to customers and contacts through SendGrid's reliable delivery infrastructure, ensuring your messages reach inboxes with professional formatting and tracking capabilities.

Create a batch id

Generate a unique batch ID to organize and control multiple email sends as a group, enabling you to pause or cancel all related emails together.

Add a batch of ips to an ip pool

Add multiple IP addresses to an IP pool in SendGrid to organize and manage your dedicated sending IPs for different campaigns or client accounts. This helps you maintain separate IP reputations and control which IPs are used for specific types of emails.

Add a twilio sendgrid ip address

Add a dedicated IP address to your SendGrid account for improved email deliverability and sender reputation. This is useful when you need to separate sending traffic or maintain isolated email channels for different business purposes.

Add an ip address to a pool

Assigns a dedicated IP address to a specific pool in SendGrid, allowing you to organize and manage your email sending infrastructure by grouping IPs for different purposes or audiences.

Add ips

Add dedicated IP addresses to your SendGrid account for improved email deliverability and sender reputation control, ideal when scaling your email volume.

Add one or more ips to the allow list

Restrict SendGrid access to specific IP addresses by adding them to an allow list, ensuring only authorized networks can connect to your email service. This protects your account from unauthorized access and potential abuse.

Create an ip pool

Creates a new IP pool to organize and group your dedicated SendGrid IP addresses for managing email reputation across different sending categories.

Create an ip pool with a name and ip assignments

Organize your dedicated SendGrid IP addresses into separate pools to maintain distinct sender reputations for different email campaigns. This lets you group transactional emails separately from marketing emails so each type builds its own delivery reputation.

Delete a batch of ips from an ip pool

Remove multiple IP addresses from a specific IP Pool to reorganize your sending infrastructure and reallocate IPs to different pools based on your current email sending needs.

Delete an IP Pool

Permanently remove an IP pool from your SendGrid account when you no longer need to group dedicated IP addresses together. This is useful when consolidating your email infrastructure or eliminating unused sender pools.

Delete ip pool

Permanently removes an IP pool from your SendGrid account and automatically frees up the associated IP addresses for reassignment to other pools. Use this when you no longer need a dedicated IP pool or want to consolidate your sending infrastructure.

Get a list of all ip addresses on your account

Retrieve all IP addresses associated with your SendGrid account along with their configuration details like pool assignments and warm-up status. This helps you manage and monitor your sending infrastructure.

Get all ip pools that have associated ips

Retrieve a summary of all your IP pools and view a sample of IP addresses assigned to each pool, helping you understand your email sending infrastructure at a glance.

Get details for an ip address

Retrieves detailed information about a specific IP address on your SendGrid account, including its assignment status, warmup settings, IP pools, and billing details. Use this to monitor and manage your email infrastructure.

Get details for an ip pool

Retrieve detailed information about a specific IP pool including its name, ID, sample IP addresses, and total IP count to understand your email sending infrastructure.

Get ips assigned to an ip pool

Retrieve all IP addresses assigned to a specific email sending pool, helping you manage and monitor which dedicated IPs are being used for your email campaigns. This is useful when you need to verify your sending infrastructure or troubleshoot delivery issues across different sending channels.

Get remaining ips count

Check how many additional IP addresses you can provision and understand the associated costs for expanding your email sending infrastructure. This helps you plan your email deliverability strategy and budget for additional sending capacity.

Remove a specific ip from the allowed list

Removes an IP address from your SendGrid allow list to revoke its sending permissions and improve account security. Use this when you need to block a specific IP from accessing your email sending capabilities.

Remove an ip address from a pool

Remove a dedicated IP address from an IP pool to stop using it for that specific pool's email sends. This is useful when reorganizing your sending infrastructure or consolidating IP usage across different pools.

Remove one or more ips from the allow list

Remove IP addresses from your SendGrid account's allow list to revoke email sending access from specific devices or locations. This helps maintain security by controlling which IPs can access your email account.

Rename an ip pool

Update the name of an existing IP pool to better reflect its purpose or sending category. This helps you organize and manage different email sending patterns under meaningful identifiers.

Retrieve a list of currently allowed ips

View all IP addresses that are authorized to send emails through your SendGrid account, including when they were added and last updated.

Retrieve a specific allowed ip

Fetch the details of a specific whitelisted IP address from your SendGrid account's security allow list to verify its settings and status.

Retrieve all assigned ips

View all IP addresses currently assigned to your SendGrid account, including their status, assigned pools, and warmup information to monitor your sending infrastructure.

Retrieve all ip addresses

View all IP addresses associated with your SendGrid account along with their warmup status, reputation metrics, and assignment details to manage your email sending infrastructure.

Retrieve all ip pools

View all the IP pools you've set up in your SendGrid account, which helps you manage and organize your sending infrastructure across different campaigns or business needs.

Retrieve all ip pools an ip address belongs to

Check which IP pools your dedicated email sending address is assigned to and monitor its configuration across your email infrastructure.

Retrieve All IPs Currently in Warmup

Check which IP addresses are currently being warmed up to establish sending reputation with email providers. This helps you monitor the status of new IPs you've added to your account.

Retrieve all the ips in a specified pool

Retrieve all IP addresses assigned to a specific pool in your SendGrid account to manage and monitor your dedicated sending infrastructure. This helps you organize and track IPs grouped by email type or campaign.

Retrieve the warmup status for a specific ip address

Check the warmup status and progression of a dedicated email sending IP address to understand its reputation-building timeline. This helps you track when your IP will be ready for full sending capacity.

Start warming up an ip address

Activate warmup mode for a dedicated IP address to gradually build sending reputation and improve email deliverability. This automatically limits your sending volume to safe levels while establishing trust with email providers.

Stop warming up an ip address

Removes automatic sending limits from a dedicated IP address that has completed its warmup period, allowing you to send at full capacity again. Use this when your IP has built sufficient sender reputation and is ready for production email volume.

Update an IP Pool Name

Rename an existing IP pool in your SendGrid account to better organize and manage your dedicated email sending addresses. This helps you maintain separate reputations for different types of emails by clearly labeling your IP pools.

Update details for an ip address

Modify the settings of a dedicated IP address, including auto warmup status, parent account access, and enabled state to optimize your email deliverability and sender reputation.

Bulk Delete Integrations

Remove multiple email integrations at once from your SendGrid account, allowing you to clean up unused event forwarding connections to third-party applications like analytics or CRM platforms. This is useful when consolidating tools or discontinuing services that are no longer needed.

Create Marketing Integration

Connect SendGrid Marketing Campaigns to Segment to automatically forward email events like opens, clicks, and bounces for unified customer analytics and engagement tracking.

Get Marketing Integration

Retrieve the details and configuration of a specific marketing integration connected to your SendGrid account, such as email event forwarding settings to third-party platforms. This helps you verify integration status and manage how your customer data flows to other business tools.

Listintegration

Retrieve a list of all integrations connected to your SendGrid account, allowing you to see which third-party services are currently set up for email delivery and management.

Returns a list of all partner settings

Retrieve all available partner integrations that can be connected to your SendGrid account, allowing you to see which third-party services you can enable for enhanced email capabilities.

Update Marketing Integration

Modify the settings of an existing SendGrid Marketing integration to adjust how email events are forwarded to connected platforms like Segment. Update integration labels, filter which email events to track, and map custom destination properties without affecting other configuration details.

Retrieve address whitelist mail settings

Check which email addresses or domains are currently whitelisted in your SendGrid account to ensure they receive all messages without suppression. This helps you verify that critical contacts and partners always receive your emails regardless of bounce or unsubscribe history.

Retrieve all mail settings

Get a complete view of all your email sending settings and configurations to understand which features are currently enabled or disabled. This helps you verify your account setup and troubleshoot email delivery issues.

Retrieve bounce purge mail settings

Check your current bounce purge settings to understand when bounced email addresses are automatically removed from your suppression lists. This helps you manage how long invalid contacts are kept before being purged from your system.

Retrieve Current Enforced TLS Settings

Check your SendGrid account's TLS encryption requirements to understand whether emails are enforced to use secure connections or allowed to fall back to unencrypted delivery. This helps you verify your security settings and understand how strictly your emails handle encryption standards.

Retrieve footer mail settings

Retrieve your current email footer settings from SendGrid, including whether footers are enabled and what HTML and plain text content is configured. This helps you verify and audit the footer that appears on all outgoing emails.

Retrieve forward bounce mail settings

Check where bounce notifications are being sent for your SendGrid account so you can stay informed about permanent email delivery failures.

Retrieve forward spam mail settings

Check your current spam notification settings to see which email addresses are configured to receive spam reports and abuse notifications from SendGrid.

Update address whitelist mail settings

Manage your SendGrid address whitelist to ensure critical email addresses and domains are never suppressed due to bounces, blocks, or unsubscribes. This lets you maintain delivery to important contacts regardless of engagement issues.

Update bounce purge mail settings

Configure automatic removal of bounced email addresses from your suppression lists after a specified number of days, helping you maintain a clean contact database and re-engage contacts that may have become valid again.

Update enforced tls settings

Configure encryption requirements for emails sent through your SendGrid account, ensuring recipients must support TLS encryption and valid certificates before messages are delivered.

Update footer mail settings

Customize the footer content that automatically appears at the bottom of all your outgoing emails, including HTML and plain text versions. This helps maintain consistent branding and compliance messaging across your email communications.

Update forward bounce mail settings

Configure an email address to automatically receive notifications when messages bounce from recipient mailboxes, helping you monitor delivery problems and keep your mailing list clean.

Update forward spam mail settings

Configure automatic forwarding of spam reports and abuse notifications to specific email addresses, ensuring you stay informed about email deliverability issues affecting your account.

Update template mail settings

Apply a default email template with branding and styling that wraps around all emails sent through your SendGrid account. This ensures consistent visual presentation and messaging across your transactional emails.

Completed steps

Check whether your SendGrid account has completed domain authentication and single sender verification setup. This helps you understand if your email infrastructure is ready to send campaigns.

Export contacts

Initiates an asynchronous export of your SendGrid email contacts to CSV or JSON format, allowing you to backup, analyze, or migrate your contact database. You can export all contacts or filter by specific lists and segments.

Export contacts status

Check the progress of a contact export job and retrieve download links once the export is ready. This lets you monitor batch contact exports and download your contact data as CSV files when processing completes.

Export single send stats

Exports detailed engagement metrics for your SendGrid email campaigns into a CSV file, including opens, clicks, bounces, and other performance data. This helps you analyze campaign effectiveness and understand subscriber behavior.

Filter all messages

Search and retrieve detailed email activity records from your SendGrid account, allowing you to track delivery status, engagement, and performance metrics for emails you've sent.

Filter messages by message id

Look up comprehensive details about a specific email message using its message ID, including sender, recipient, subject, delivery status, and associated events. This helps you track individual email performance and troubleshoot delivery issues.

Get all automation stats

Retrieve comprehensive performance metrics for your automated email campaigns, including delivery rates, opens, clicks, bounces, and unsubscribes to measure campaign effectiveness.

Get all existing exports

Retrieve a list of all contact export jobs from SendGrid to check their status and access download links for completed exports. This helps you track ongoing data exports and retrieve ready files without needing specific export IDs.

Get all single sends stats

Retrieve performance metrics for your SendGrid marketing email campaigns, including delivery rates, opens, clicks, bounces, and unsubscribes to measure campaign effectiveness.

Get Automation Click Tracking Stats

View detailed click performance metrics for links in your automated email campaigns, showing which links received the most engagement from subscribers. This helps you understand what content resonates with your audience and optimize future messaging.

Get automation stats by id

Retrieve detailed performance metrics for a specific automation workflow, including open rates, click rates, and engagement data to measure campaign effectiveness.

Get bounce statistics by classification

Track daily bounce statistics for a specific bounce type (like invalid addresses or reputation issues) to identify patterns affecting your email deliverability. This helps you understand why emails are bouncing and take targeted action to improve sender reputation.

Get Email Activity CSV Download URL

Generates a downloadable S3 link for your email activity data in CSV format, allowing you to access up to one million email events from the last 30 days for analysis and reporting.

Get engagement quality scores

Retrieve your email engagement quality scores from SendGrid to understand how well your messages are performing with mailbox providers. This composite score (1-5) helps you assess whether your emails are reaching inboxes and engaging recipients effectively.

Get single send click tracking stats by id

Retrieve detailed click-tracking data for a specific email campaign, showing which links received the most engagement from your recipients.

Get single send stats by id

Retrieve detailed performance metrics for a specific email campaign, including open rates, click rates, and delivery statistics to measure campaign effectiveness.

Get subuser monthly stats

Retrieve detailed monthly email performance metrics for a SendGrid subuser account, including delivery rates, engagement, and bounces to monitor sending performance over time.

Get subusers engagement quality scores

Monitor your team's email sending health by retrieving engagement quality scores that indicate how recipients are responding to your emails. These scores help you identify which team members are sending emails that generate positive recipient engagement.

Request csv

Export up to 1 million email events from the past 30 days into a CSV file that's delivered to your inbox, allowing you to analyze your SendGrid activity offline.

Retrieve bounce classification totals

Get a breakdown of email bounces categorized by type (hard bounces, soft bounces, etc.) to understand why messages aren't reaching recipients. This helps you identify delivery problems and maintain a healthy email list.

Retrieve email statistics by browser

See how many people clicked links in your emails broken down by their browser type (Chrome, Firefox, Safari, etc.), helping you understand which browsers drive the most engagement with your campaigns.

Retrieve email statistics by client type

View how your emails are opened across different devices and email clients (webmail, desktop, phone, tablet) to understand where your audience engages with your messages.

Retrieve email statistics by country and state province

Analyze how your emails are being received and engaged with across different countries and regions, helping you understand which geographic areas drive the most opens and clicks. Use this data to optimize your email campaigns for better performance in key markets.

Retrieve email statistics by device type

See how your emails perform across different devices like phones, tablets, and desktops so you can optimize your email designs for better engagement. This helps you understand which devices your audience uses most when reading your messages.

Retrieve email statistics by mailbox provider

Track how your emails perform across different email providers like Gmail, Yahoo, and Outlook to identify delivery issues and optimize sending strategies. Understand which providers have high engagement or delivery problems so you can refine your email approach.

Retrieve email statistics for categories

Retrieve detailed email performance metrics (delivery, opens, clicks, bounces) for specific categories over a date range to understand how different types of emails are performing. This helps you identify which campaign categories are most effective and where to optimize your email strategy.

Retrieve email statistics for your subusers

View detailed email performance metrics for your subuser accounts, including delivery rates, opens, clicks, and bounces over any date range. Use this to monitor how your team members or client accounts are performing with email campaigns.

Retrieve global email statistics

Fetch aggregated email performance metrics for your SendGrid account over a specific date range, including delivery rates, opens, clicks, and engagement data. Use this to understand how your email campaigns are performing and identify trends in subscriber behavior.

Retrieve monthly stats for all subusers

View aggregated monthly email performance metrics across all your team members or reseller accounts, including delivery rates, opens, clicks, and bounces. This helps you track overall email campaign success and identify performance trends without checking each subuser individually.

Retrieve stats by a specific client type

Track how your email recipients engage with messages on specific devices or platforms (like mobile phones, tablets, or desktop clients) to understand which client types drive the most opens and interactions. This helps you optimize email designs for the devices your audience uses most.

Retrieve subuser reputations

Get sender reputation scores for your SendGrid subusers to monitor email delivery performance and identify which accounts may have deliverability issues. This helps you maintain good relationships with email providers and ensure your messages reach inboxes.

Retrieve sums of email stats for each category

Aggregates email performance metrics (deliveries, opens, clicks, bounces) across all your email categories to show which types of emails are performing best. Use this to understand engagement patterns and identify underperforming email categories that need improvement.

Retrieve the count of billable recipients (Legacy)

Check how many contacts you'll be charged for on your SendGrid account, helping you understand your email marketing costs.

Sum email stats for subusers

Aggregates email performance metrics across all your SendGrid subusers over a specified date range, giving you a unified view of delivery, engagement, and bounce data. Use this to track overall email campaign health and identify performance trends across multiple SendGrid accounts.

Create a segment

Organize your email contacts into targeted groups based on specific characteristics or behaviors, allowing you to send personalized campaigns to the right audience segments.

Create segment

Create targeted contact groups in SendGrid by defining criteria based on customer data and engagement history, enabling you to organize your email list for more relevant campaigns. This allows you to automatically segment your audience without manual sorting.

Delete a segment

Permanently removes a segment from your SendGrid contact database, with the option to also delete all contacts within that segment. Use this when you no longer need a specific audience group or want to clean up outdated contact lists.

Get list of segments

Retrieves your contact segments from SendGrid so you can view and organize all the audience groups you've created for targeted email campaigns. This helps you manage which customer lists and segments are available for your marketing efforts.

Manually refresh a segment

Force an immediate update of a marketing segment's contact list to ensure you're working with the latest audience data that matches your targeting criteria. This is useful when you need current segment information before launching a campaign without waiting for SendGrid's standard hourly refresh.

Remove segment without affecting contacts

Deletes a segment from your SendGrid marketing campaigns while preserving all contacts, allowing you to clean up your segmentation strategy without losing subscriber data.

Retrieve single segment endpoint

Retrieves detailed information about a specific email marketing segment, including membership criteria, contact count, and validation status. Use this to verify segment configuration and check how many contacts match your targeting rules.

Update a segment

Modify an existing email segment by updating its name or target audience rules, allowing you to refine who receives your campaigns without creating new segments.

Create a sender

Set up a new sender identity in SendGrid to establish who your marketing emails come from, enabling you to maintain brand consistency and sender reputation across your campaigns.

Create a sender identity

Set up a new email sender identity in SendGrid to establish the "from" address and branding information that recipients will see when you send emails. This is essential for sending professional emails and managing multiple brand or campaign identities.

Create verified sender request

Registers a new email address as an authorized sender for your SendGrid account and initiates verification through an email confirmation process. This ensures only legitimate email addresses can send messages through your SendGrid account.

Delete a sender

Permanently removes a sender identity from your SendGrid account, freeing up that email address from your sender list. Use this when you no longer need a particular 'from' address for your marketing campaigns.

Delete a sender identity

Permanently remove a sender identity from your SendGrid account when you no longer need to send emails from that address. This is useful when consolidating email accounts, rebranding, or cleaning up unused sender profiles.

Delete verified sender

Permanently removes a verified sender identity from your SendGrid account so you can stop using that email address for campaigns. This is useful when cleaning up old or inactive sender addresses.

Edit verified sender

Update the details of an existing verified sender in SendGrid, such as display name or contact information, without requiring changes to all sender properties. This keeps your sender identities current and accurate as your business information changes.

Get a list of all senders

Retrieve all email sender identities configured in your SendGrid account, including their verification status and readiness for sending campaigns. This helps you manage and verify which email addresses can be used to send out your marketing messages.

Get a specific sender

Get detailed information about a specific sender profile you've set up in SendGrid, including email address, reply-to details, physical address, and verification status. Use this to verify sender configuration before sending campaigns or to manage multiple sender identities.

Get all sender identities

Retrieve all email sender identities configured in your SendGrid account so you can see which email addresses are authorized to send messages. This helps you manage and verify your sending setup across different brand or business units.

Get all verified senders

Retrieves a list of all sender identities configured in your SendGrid account, allowing you to view and manage which email addresses are verified for sending. This helps you keep track of your approved email senders and ensure compliance with your sending setup.

Resend a sender verification

Resends the verification email for a sender identity in your Marketing Campaigns account when the original email is lost or expired. This helps you complete the sender verification process so you can start sending marketing emails.

Resend sender identity verification

Resends the verification email to a sender identity's 'from' address when the original email wasn't received or has expired, allowing you to complete the verification process. Use this to regain sending capabilities from a sender account that's pending verification.

Resend verified sender request

Resends a verification email to a sender identity that hasn't been verified yet, useful when the original verification message was lost or expired. This allows you to regain access to a sender email address without recreating the entire verification request.

Update a sender

Update your sender identity information such as display name, email address, or physical address for your SendGrid marketing campaigns. Use this to maintain accurate sender details, ensure compliance, and keep your campaign setup organized.

Update a sender identity

Modify an existing sender identity's details such as display name, email address, or reply-to information in SendGrid without affecting other settings.

Verify sender request

Confirms a sender email address by using the verification token sent to that email, allowing you to start sending emails from that address.

View a sender identity

Retrieve the complete details of a sender identity including email configuration, physical address, and verification status. Use this to verify sender settings before launching campaigns or troubleshoot delivery issues.

Assign a batch of subusers to an ip

Efficiently assign multiple subusers to a specific IP address at once, ensuring all assignments are completed together or none at all. This helps you maintain organized email sending infrastructure across different team members or business divisions.

Create subuser

Create a new subuser account within your SendGrid workspace to organize and manage email sending across different projects, clients, or business units with separate credentials and activity tracking.

Delete a batch of subusers from an ip

Remove multiple subusers from a specific IP address in one action to better manage your email sending resources and IP reputation.

Delete a subuser

Permanently remove a subuser account from your SendGrid instance, immediately revoking their access to email sending and reporting. Use this when team members leave, consolidating accounts, or cleaning up unused sub-accounts.

Enable disable a subuser

Control whether a SendGrid subuser account can send emails by enabling or disabling their access. This helps manage team member permissions and prevent unauthorized sending.

Enable disable website access for a subuser

Control whether a SendGrid subuser can access the web dashboard while maintaining their email sending capabilities. This lets you manage login permissions independently from email functionality.

Get a list of subusers assigned to an ip

Retrieve which subusers in your SendGrid account are using a specific IP address, helping you track email sending activity and resource allocation across your team members.

Get the credits for a subuser

Check how many email sending credits a subuser account has remaining, including their credit type and usage details. This helps you track and manage credit allocation across team members or client accounts.

List all subusers

Retrieve and view all subuser accounts you've created in SendGrid, with options to filter and paginate through the list. This helps you manage and monitor multiple email sending accounts within your organization.

Unlink subuser domain

Remove a domain authentication link from a subuser account, preventing them from sending emails through that specific domain. This is useful when you need to revoke a subuser's access to a particular sending domain.

Update the credits for a subuser

Allocate and manage email sending credits for your SendGrid subusers, controlling how many emails each team member or client can send. This lets you set spending limits, distribute resources fairly, and prevent budget overruns.

Update the remaining credits for a subuser

Adjust the email sending credits available to a subuser account by adding or subtracting from their current balance. This helps you manage team member access and control costs across multiple SendGrid accounts.

Add recipient addresses to the global suppression group

Permanently prevent one or more email addresses from receiving any emails from your SendGrid account by adding them to the global suppression list. Use this to honor opt-out requests and manage contacts who should never receive communications.

Add suppressions to a suppression group

Add email addresses to an unsubscribe group so they won't receive emails associated with that specific group, helping you manage subscriber preferences and maintain a clean mailing list.

Create a new suppression group

Create a new suppression group to organize recipients by email type and let them unsubscribe from specific categories rather than all emails. This helps maintain sender reputation and keeps engaged subscribers on your list.

Delete a bounce

Removes an email address from your SendGrid bounce list, allowing you to retry delivery to that address in the future. Use this after confirming an email is valid or the delivery issue has been resolved.

Delete a global suppression

Remove an email address from your global suppression list so you can send emails to that contact again in the future.

Delete a specific block

Remove a blocked email address from your SendGrid blocks list so you can resume sending messages to that recipient. This is useful when an email was incorrectly blocked or the underlying delivery issue has been resolved.

Delete a specific invalid email

Removes a specific email address from SendGrid's invalid emails suppression list, allowing SendGrid to attempt delivery to that address again. Use this when you've confirmed a previously invalid email address is now working correctly.

Delete a specific spam report

Removes a specific email address from SendGrid's spam reports list, allowing you to resume sending emails to that recipient if they've explicitly consented to receive your messages again.

Delete a suppression from a suppression group

Remove an email address from a suppression group to allow you to send emails to that recipient again. Use this when a contact explicitly opts back in to receiving your messages.

Delete a suppression group

Removes an email suppression group from your account, allowing previously suppressed recipients to receive emails again if they wish to resubscribe. Use this when you need to clean up old suppression lists or reorganize your email management structure.

Delete blocks

Remove blocked email addresses from your SendGrid suppression list to clean up failed recipient records and improve deliverability management. This helps you recover from delivery issues and re-engage with contacts whose email addresses may have been temporarily blocked.

Delete bounces

Remove email addresses from your SendGrid bounce list to retry sending to them or clean up outdated suppression records. This helps you recover contact validity and maintain accurate recipient lists.

Delete invalid emails

Remove email addresses from your invalid emails suppression list so SendGrid can retry delivery to those contacts. This is useful when you want to give previously bounced emails a second chance.

Delete spam reports

Remove email addresses from your spam reports list to regain the ability to send emails to those recipients again. Use this when customers request to receive your emails after being marked as spam.

Get information on a single suppression group

Retrieve detailed information about a suppression group, including its name, description, and the number of unsubscribed contacts. Use this to monitor how many people have opted out of specific email types and manage your communication preferences.

Get suppression groups

Retrieve your list of suppression groups to see which email lists have unsubscribe preferences set up and manage recipient communication preferences across your campaigns.

Retrieve a bounce

Look up why a specific email address bounced and when it happened to understand delivery failures and manage your email list quality.

Retrieve a global suppression

Check whether a specific email address is on your global suppression list to avoid sending unwanted messages to opted-out contacts. This helps ensure compliance and prevents wasted send attempts on undeliverable addresses.

Retrieve a specific block

Check if a specific email address is blocked from receiving your messages and understand the reason for the block. Use this to diagnose delivery issues and determine if you need to take corrective action before retrying sends.

Retrieve a specific invalid email

Check if a specific email address is on your suppression list and view the reason it was marked as invalid, helping you maintain clean contact lists and avoid sending to problematic addresses.

Retrieve a specific spam report

Look up whether a specific email address has marked your messages as spam in SendGrid. This helps you understand delivery issues and manage your sender reputation.

Retrieve all blocks

Retrieve a list of email addresses that have been blocked by recipient servers, helping you identify delivery issues caused by content or sending reputation problems. Use this to diagnose why messages aren't reaching certain recipients and take corrective action.

Retrieve all bounces

Get a list of all email addresses that bounced when you tried to send them messages, with options to control how many results you see and where to start in the list.

Retrieve all global suppressions

Retrieve a list of all email addresses that have been globally suppressed from your SendGrid account, including when they opted out. This helps you understand who has unsubscribed and avoid sending to them.

Retrieve all invalid emails

Retrieve a list of email addresses that bounced or are invalid in your SendGrid account, helping you maintain a clean mailing list and improve deliverability. Use pagination to browse through large lists of problem addresses.

Retrieve all spam reports

Retrieve a paginated list of email addresses that have marked your messages as spam, allowing you to review and manage your sender reputation. Use this to identify problematic content, refine your email strategy, and maintain list quality.

Retrieve all suppression groups for an email address

Check which suppression groups a specific email address is included in, helping you understand why someone might not receive your emails or verify their subscription preferences.

Retrieve all suppressions

Retrieve all email addresses that have been suppressed or unsubscribed across your SendGrid account, along with which groups they're suppressed from. This helps you maintain a clean contact list and understand your audience engagement.

Retrieve all suppressions for a suppression group

View all email addresses that have been suppressed or blocked for a specific suppression group, helping you understand who is on your do-not-contact list. This ensures you maintain compliance and avoid sending emails to addresses that have unsubscribed or reported issues.

Search for suppressions within a group

Find which email addresses have unsubscribed from a specific suppression group, helping you identify contacts who've opted out of certain types of communications.

Update a suppression group

Modify the details of an unsubscribe group, including its name, description, and default status, to better organize how recipients manage their email preferences. This helps you keep subscription categories relevant and aligned with your current business needs.

Create an sso teammate

Adds a new team member to SendGrid who logs in through your organization's identity provider for secure, centralized authentication. This streamlines access management while maintaining security for your email marketing platform.

Delete pending teammate

Cancel an outstanding invitation to join your SendGrid account before it's accepted by the recipient.

Delete teammate

Permanently remove a teammate's access from your SendGrid account. Use this when team members leave or no longer need email marketing capabilities.

Edit an SSO Teammate

Update a team member's access permissions and role within SendGrid, allowing you to manage who has admin privileges and what specific features they can access.

Get teammate subuser access

Check which subuser accounts a team member can access in SendGrid and what permissions they have, helping you manage team access control and security.

Invite teammate

Send email invitations to team members to join your SendGrid account with specific permission levels. This allows you to delegate email management tasks while controlling what each team member can access.

Resend teammate invite

Refresh a pending teammate invitation to extend its acceptance deadline by another 7 days, ensuring team members don't miss their chance to join your account.

Retrieve all pending teammates

Get a list of all pending teammate invitations that have been sent but not yet accepted. This helps you track outstanding invitations and manage your team setup process.

Retrieve all teammates

Fetch a list of all team members who have access to your SendGrid account, with options to paginate through results. This helps you see who has account permissions and manage team access.

Retrieve specific teammate

Fetch detailed information about a specific team member in SendGrid by their username, including their email, role, and access permissions.

Update Teammate's Permissions

Modify what actions and features a team member can access in your SendGrid account, either granting full admin rights or limiting them to specific permissions.

Create a transactional template

Create a reusable email template in SendGrid for sending transactional messages like order confirmations, password resets, or account notifications. This allows you to design professional, consistent emails once and use them repeatedly without rebuilding the design each time.

Activate template version

Makes a specific version of your email template the active version used for all emails sent with that template. This allows you to switch between different template designs instantly without losing previous versions.

Create a new transactional template version

Create a new version of an existing email template, allowing you to test design changes, update content, or A/B test different versions without affecting your current template in production.

Delete a template

Permanently remove a transactional email template from your SendGrid account when it's no longer needed. This action cannot be undone, so ensure the template isn't actively in use before deletion.

Delete a transactional template version

Permanently remove a specific version of a transactional email template from your account. This is useful when you have outdated or obsolete template versions taking up space or causing confusion in your template library.

Duplicate a transactional template

Create a copy of an existing email template so you can quickly generate variations without building from scratch. This saves time when you need similar templates for different purposes or recipients.

Edit a transactional template

Update the name of an existing transactional email template to better organize and identify your email communications. This helps keep your template library organized as your business evolves.

Edit a transactional template version

Update the content, subject, and settings of an existing email template version in SendGrid to keep your transactional emails current and relevant. This lets you refine your email designs and messaging without creating new templates.

Retrieve a single transactional template

Retrieves the details and version history of a transactional email template by its ID, helping you manage and verify your email templates before use.

Retrieve a specific transactional template version

Fetch the specific content and settings of a particular email template version to review, compare, or verify template details before sending campaigns.

Retrieve legacy template mail settings

Fetches your current legacy email template configuration to check what HTML wrapper is applied to your emails and whether it's active. Use this to verify or audit your existing template settings before making changes.

Retrieve paged transactional templates

Retrieve a paginated list of your transactional email templates to manage, organize, and track all the pre-built emails you've created for automated communications.

Get Open Tracking Settings

Check whether open tracking is enabled for your emails to monitor when recipients view your messages. This setting controls if SendGrid logs when recipients open your emails.

Retrieve click track settings

Check whether click tracking is enabled for your emails so you can understand if you're capturing engagement data from your recipients.

Retrieve Google Analytics Settings

Retrieve your SendGrid account's Google Analytics tracking settings to see which UTM parameters are configured for your email campaigns. This allows you to verify your tracking setup is enabled and properly configured to measure email performance in Google Analytics.

Retrieve subscription tracking settings

Checks your current subscription tracking configuration to see if automatic unsubscribe links are enabled and what custom messaging is displayed to recipients. This helps ensure your email compliance settings match your communication strategy.

Retrieve tracking settings

View all email tracking settings currently enabled on your account, including open rates, click tracking, and bounce monitoring.

Update click tracking settings

Enable or disable click tracking for your emails to monitor which links recipients are engaging with, helping you understand what content resonates with your audience.

Update Google Analytics Settings

Enable automatic UTM parameter tracking on email links to measure campaign performance directly in Google Analytics. This lets you see which emails drive traffic and conversions without manual link tagging.

Update open tracking settings

Enable or disable open tracking for your SendGrid emails to monitor when recipients view your messages. This helps you understand email engagement and optimize your communication strategy.

Update subscription tracking settings

Configure how unsubscribe options appear in your emails and where subscribers are directed when they opt out, helping you maintain compliance and manage your email list effectively.

Get Bulk Email Validation Job by ID

Check the status and results of a bulk email validation job you've submitted to SendGrid, including whether validation is complete and results are ready to download.

List Bulk Email Validation Jobs

Retrieve all bulk email validation jobs associated with your SendGrid account to monitor the status and progress of your email list verification processes. Use this to track which validation jobs are pending, processing, completed, or have encountered errors.

Request Presigned URL for Bulk Email Validation

Get a presigned upload URL and job ID to validate large lists of email addresses in bulk, allowing you to verify your entire email database at once without manual checking.

Validate a batch ID

Verify that a batch ID exists and is valid in SendGrid's system before using it for email operations. This is essential for confirming batch IDs are properly created before scheduling or managing send campaigns.

Validate an email

Verify whether an email address is valid and deliverable before sending messages, protecting your sender reputation and reducing bounce rates. This checks email syntax, domain validity, and identifies risky or invalid addresses.

Create a new event webhook

Set up a webhook that automatically sends email event notifications to your application whenever emails are sent, delivered, bounced, or opened, enabling real-time tracking and automation of customer communications.

Create a parse setting

Set up automated email receiving and parsing by configuring a webhook that processes incoming emails to a specific domain subdomain. This enables your business to automatically capture, process, and respond to customer emails without manual intervention.

Delete a parse setting

Removes an inbound email parsing configuration for a specific hostname, stopping SendGrid from processing incoming emails for that domain. Use this when you no longer need email forwarding or automated email processing for a particular address.

Delete a single event webhook by id

Remove a specific event webhook from your SendGrid account when you no longer need to receive notifications for email events. This operation requires an ID to prevent accidental deletions of the wrong webhook.

Get signed event webhook's public key

Retrieves the public key needed to verify that incoming webhook notifications from SendGrid are authentic and haven't been tampered with. This is essential for securely processing email events like deliveries, bounces, and opens in your application.

Get the settings for a single event webhook

Retrieve the complete configuration details for a specific email event webhook, including its URL, enabled status, and which email events it's monitoring. This allows you to verify your webhook setup and troubleshoot delivery issues.

Retrieve a specific parse setting

Fetches the configuration details for a specific inbound email parse webhook by hostname, showing how SendGrid processes incoming emails to that domain. Use this to verify or troubleshoot your email parsing setup without needing to retrieve all settings.

Retrieve all of your event webhooks

Fetches a complete list of all your configured email webhooks, showing their settings and IDs so you can view, update, or delete them as needed.

Retrieve all parse settings

Fetch all your inbound email parsing configurations to see how your application is currently set up to receive and process incoming emails. This helps you verify your email handling setup and manage multiple inbound email sources.

Retrieves inbound parse webhook statistics

Get statistics on emails received and processed through SendGrid's Inbound Parse Webhook, including volume metrics within a specified date range. This helps you monitor email intake and system performance.

Test an Event Webhook's Settings

Verify that your webhook endpoint is properly configured to receive SendGrid email events by sending a test notification with sample data.

Toggle signature verification for a single event webhook by id

Enable or disable signature verification for your event webhooks to ensure that incoming webhook requests are authentic and haven't been altered in transit. This adds a security layer that verifies all webhook payloads genuinely originate from SendGrid.

Update a parse setting

Modify how SendGrid processes incoming emails for a specific domain by updating the webhook URL, raw content settings, or spam filtering options. Use this to change where parsed emails are delivered or adjust how email content is processed.

Update a single event webhook by id

Modify an existing event webhook's configuration such as its URL, status, event subscriptions, and name to control how SendGrid notifies your application about email events like bounces, clicks, and opens.