Connectors
Marketing & Customer Engagement
SendGrid
Email platform: transactional sends, templates, contacts, and delivery event tracking
SendGrid API referenceAPI checked August 18, 2026
- Signs in with
- API token
- Runs on
- Cloud or On-Prem Worker
- Operations
- 391
- Ready-made triggers
- 0
Connect SendGrid
- In Neblex open Connect › Connections and click New Connection.
- Search for SendGrid and give the connection a clear name.
- Fill in the fields. Secret values are encrypted and never shown again.
- Click Test, then Create Connection.
| Field | What to enter |
|---|---|
| Access tokenRequiredSecret |
Use it in a flow
- Open a flow, open the node library and search for SendGrid.
- Drag it onto the canvas and choose an Operation and your connection.
- Map the operation's fields from earlier steps, or click Map with Matt.
- Use Test this step to see what it returns, then save.
To start a flow from SendGrid without a ready-made trigger: a Poll for changes trigger can check one of its list operations on a schedule and pass on only what is new; if SendGrid can send webhooks, a Webhook trigger receives them at its own URL.
Operations
391 operations in 65 groups. Each one is a step you can add to a flow.
Account4
Authenticate an account with single sign onAuthenticateAccount | POST | Authenticates and logs in a user to Twilio Sendgrid as a specific admin identity configured for SSO by partner. |
Create an accountCreateAccount | POST | Creates a new account, with specified offering, under the organization. |
Delete an accountDeleteAccount | DELETE | Delete a specific account under your organization by account ID. |
Get all accountsListAccount | GET | Retrieves all accounts under the organization. |
Account State2
Get an account's stateGetAccountState | GET | Retrieve the state of the specified account. |
Update an account's stateUpdateAccountState | PUT | Update the state of the specified account. |
Alert5
Create a new AlertCreateAlert | POST | This endpoint allows you to create a new alert. |
Delete an alertDeleteAlert | DELETE | This endpoint allows you to delete an alert. |
Retrieve a specific alertGetAlert | GET | This endpoint allows you to retrieve a specific alert. |
Retrieve all alertsListAlert | GET | This endpoint allows you to retrieve all of your alerts. |
Update an alertUpdateAlert | PATCH | This endpoint allows you to update an alert. |
API Key6
Create API keysCreateApiKey | POST | This endpoint allows you to create a new API Key for the user. |
Delete API keysDeleteApiKey | DELETE | This endpoint allows you to revoke an existing API Key using an api key id |
Retrieve all API Keys belonging to the authenticated userListApiKey | GET | This endpoint allows you to retrieve all API Keys that belong to the authenticated user. |
Retrieve an existing API KeyGetApiKey | GET | This endpoint allows you to retrieve a single API key using an api key id. |
Update API key nameUpdateApiKeyName | PATCH | This endpoint allows you to update the name of an existing API Key. |
Update API key name and scopesUpdateApiKey | PUT | This endpoint allows you to update the name and scopes of a given API key. |
Block4
Delete a specific blockDeleteSuppressionBlock | DELETE | This endpoint allows you to delete a specific email address from your blocks list. |
Delete blocksDeleteSuppressionBlocks | DELETE | This endpoint allows you to delete all email addresses on your blocks list. |
Retrieve a specific blockGetSuppressionBlock | GET | This endpoint allows you to retrieve a specific email address from your blocks list. |
Retrieve all blocksListSuppressionBlock | GET | This endpoint allows you to retrieve a paginated list of all email addresses that are currently on your blocks list. |
Bounce6
Delete a bounceDeleteSuppressionBounce | DELETE | This endpoint allows you to remove an email address from your bounce list. |
Delete bouncesDeleteSuppressionBounces | DELETE | This endpoint allows you to delete all emails on your bounces list. |
Retrieve a BounceGetSuppressionBounces | GET | This endpoint allows you to retrieve a specific bounce by email address. |
Retrieve all bouncesListSuppressionBounces | GET | This endpoint allows you to retrieve a paginated list of all your bounces. |
Retrieve bounce classification over time by domain statsGetSuppressionBouncesClassifications | GET | This endpoint will return the number of bounces for the classification specified in descending order for each day. |
Retrieve bounce classification totalsListSuppressionBouncesClassifications | GET | This endpoint will return the total number of bounces by classification in descending order for each day. |
Bulk Email Address Validation3
Request a presigned URL and headers for Bulk Email AddressListEmailJobForVerification | PUT | This endpoint returns a presigned URL and request headers. |
This request lists all of a user's Bulk Email Validation Jobs.GetValidationsEmailJobs | GET | This endpoint returns a list of all of a user's Bulk Email Validation Jobs. |
This request returns a single Bulk Email Validation Job.GetEmailJobForVerification | GET | This endpoint returns a specific Bulk Email Validation Job. |
Campaigns API11
Create a CampaignCreateCampaign | POST | This endpoint allows you to create a campaign. |
Delete a CampaignDeleteCampaign | DELETE | This endpoint allows you to delete a specific campaign. |
Retrieve a single campaignGetCampaign | GET | This endpoint allows you to retrieve a specific campaign. |
Retrieve all CampaignsListCampaign | GET | This endpoint allows you to retrieve a paginated list of all of your campaigns. |
Schedule a CampaignScheduleCampaign | POST | This endpoint allows you to schedule a specific date and time for your campaign to be sent. |
Send a CampaignSendCampaign | POST | This endpoint allows you to immediately send an existing campaign. |
Send a Test CampaignSendTestCampaign | POST | This endpoint allows you to send a test campaign. |
Unschedule a Scheduled CampaignUnScheduleCampaign | DELETE | This endpoint allows you to unschedule a campaign that has already been scheduled to be sent. |
Update a CampaignUpdateCampaign | PATCH | This endpoint allows you to update a specific campaign. |
Update a Scheduled CampaignUpdateScheduledCampaign | PATCH | This endpoint allows to you change the scheduled time and date for a campaign to be sent. |
View Scheduled Time of a CampaignGetScheduledCampaign | GET | This endpoint allows you to retrieve the date and time that a campaign has been scheduled to be sent. |
Category3
Retrieve all categoriesListCategory | GET | This endpoint allows you to retrieve a paginated list of all of your categories. |
Retrieve Email Statistics for CategoriesListCategoryStat | GET | This endpoint allows you to retrieve all of your email statistics for each of your categories. |
Retrieve sums of email stats for each category.ListCategoryStatSum | GET | This endpoint allows you to retrieve the total sum of each email statistic for every category over the given date range. |
Contact15
Add or Update a ContactUpdateContact | PUT | This endpoint allows the upsert (insert or update) of up to 30,000 contacts, or 6MB of data, whichever is lower . |
Delete a Contact IdentifierDeleteContactIdentifier | DELETE | This endpoint can be used to delete one identifier from a contact. |
Delete ContactsDeleteContact | DELETE | This endpoint can be used to delete one or more contacts . |
Export ContactsExportContact | POST | Use this endpoint to export lists or segments of contacts . |
Export Contacts StatusGetExportContact | GET | This endpoint can be used to check the status of a contact export job . |
Get a Contact by IDGetContact | GET | This endpoint returns the full details and all fields for the specified contact . |
Get All Existing ExportsListExportContact | GET | Use this endpoint to retrieve details of all current exported jobs . |
Get Batched Contacts by IDsListBatchedContact | POST | This endpoint is used to retrieve a set of contacts identified by their IDs. |
Get Contacts by EmailsListContactByEmail | POST | This endpoint allows you to retrieve up to 100 contacts matching the searched email address(es), including any alternate emails. |
Get Contacts by IdentifiersGetContactByIdentifiers | POST | Use this endpoint to retrieve up to 100 contacts that match the requested identifier values for a single identifier type. |
Get Sample ContactsListContact | GET | This endpoint will return up to 50 of the most recent contacts uploaded or attached to a list . |
Get Total Contact CountListContactCount | GET | This endpoint returns the total number of contacts you have stored. |
Import ContactsImportContact | PUT | This endpoint allows a CSV upload containing up to one million contacts or 5GB of data, whichever is smaller. |
Import Contacts StatusGetImportContact | GET | This endpoint can be used to check the status of a contact import job . |
Search ContactsSearchContact | POST | Use this endpoint to locate contacts . |
Custom Field9
Create a Custom FieldCreateCustomField | POST | This endpoint allows you to create a custom field. |
Create Custom Field DefinitionCreateFieldDefinition | POST | This endpoint creates a new custom field definition. |
Delete a Custom FieldDeleteCustomField | DELETE | This endpoint allows you to delete a custom field by ID. |
Delete Custom Field DefinitionDeleteFieldDefinition | DELETE | This endpoint deletes a defined Custom Field. |
Get All Field DefinitionsListFieldDefinition | GET | This endpoint retrieves all defined Custom Fields and Reserved Fields. |
Retrieve a Custom FieldGetCustomField | GET | This endpoint allows you to retrieve a custom field by ID. |
Retrieve all custom fieldsListCustomField | GET | This endpoint allows you to retrieve all custom fields. |
Retrieve reserved fieldsListReservedField | GET | This endpoint allows you to list all fields that are reserved and can't be used for custom field names. |
Update Custom Field DefinitionUpdateFieldDefinition | PATCH | This endpoint allows you to update a defined Custom Field. |
Design9
Create DesignCreateDesign | POST | This endpoint allows you to create a new design . |
Delete DesignDeleteDesign | DELETE | This endpoint allows you to delete a single design . |
Duplicate DesignDuplicateDesign | POST | This endpoint allows you to duplicate one of your existing designs . |
Duplicate SendGrid Pre-built DesignDuplicatePreBuiltDesign | POST | This endpoint allows you to duplicate one of the pre-built Twilio SendGrid designs . |
Get DesignGetDesign | GET | This endpoint allows you to retrieve a single design . |
Get SendGrid Pre-built DesignGetPreBuiltDesign | GET | This endpoint allows you to retrieve a single pre-built design . |
List DesignsListDesign | GET | This endpoint allows you to retrieve a list of designs already stored in your Design Library . |
List SendGrid Pre-built DesignsListPreBuiltDesign | GET | This endpoint allows you to retrieve a list of pre-built designs provided by Twilio SendGrid . |
Update DesignUpdateDesign | PATCH | This endpoint allows you to edit a design . |
Domain Authentication16
Add an IP to an authenticated domainAddIpToAuthenticatedDomain | POST | This endpoint allows you to add an IP address to an authenticated domain. |
Associate an authenticated domain with a given user, for up toAssociateSubuserWithDomainMultiple | POST | This endpoint allows you to associate a specific authenticated domain with a subuser. |
Associate an authenticated domain with a given user.AssociateSubuserWithDomain | POST | This endpoint allows you to associate a specific authenticated domain with a subuser. |
Authenticate a domainAuthenticateDomain | POST | This endpoint allows you to authenticate a domain. |
Delete an authenticated domain.DeleteAuthenticatedDomain | DELETE | This endpoint allows you to delete an authenticated domain. |
Disassociate an authenticated domain from a given user forDisassociateSubuserFromDomain | DELETE | This endpoint allows you to disassociate a specific authenticated domain from a subuser, for users with up to five associated domains. |
Disassociate an authenticated domain from a given user.DisassociateAuthenticatedDomainFromUser | DELETE | This endpoint allows you to disassociate a specific authenticated domain from a subuser. |
Email DNS records to a co-workerEmailDnsRecord | POST | This endpoint is used to share DNS records with a colleagues |
Get the default authenticationListDefaultAuthenticatedDomain | GET | This endpoint allows you to retrieve the default authentication for a domain. |
List all authenticated domainsListAuthenticatedDomain | GET | This endpoint allows you to retrieve a paginated list of all domains you have authenticated. |
List all the authenticated domains associated with the givenListAllAuthenticatedDomainWithUser | GET | This endpoint allows you to retrieve all of the authenticated domains that have been assigned to a specific subuser. |
List the authenticated domain associated with the given user.ListAuthenticatedDomainWithUser | GET | This endpoint allows you to retrieve all of the authenticated domains that have been assigned to a specific subuser. |
Remove an IP from an authenticated domain.DeleteIpFromAuthenticatedDomain | DELETE | This endpoint allows you to remove an IP address from that domain's authentication. |
Retrieve an authenticated domainGetAuthenticatedDomain | GET | This endpoint allows you to retrieve a specific authenticated domain. |
Update an authenticated domainUpdateAuthenticatedDomain | PATCH | This endpoint allows you to update the settings for an authenticated domain. |
Validate a domain authentication.ValidateAuthenticatedDomain | POST | This endpoint allows you to validate an authenticated domain. |
Email Activity4
Download CSVDownloadCsv | GET | This endpoint will return a presigned URL that can be used to download the CSV that was requested from the "Request a CSV" endpoint. |
Filter all messagesListMessage | GET | Filter all messages to search your Email Activity. |
Filter messages by message IDGetMessage | GET | Get all of the details about the specified message. |
Request CSVRequestCsv | POST | This request will kick off a backend process to generate a CSV file. |
Email Address Validation1
Validate an emailValidateEmail | POST | This endpoint allows you to validate an email address. |
Email Log2
Get all details for the specified message ID.GetMessageById | GET | Get all of the details about the specified message. |
Search all messages using the provided query filters.ListMessagesByFilter | POST | List recent messages within Email Logs, or search for messages using a filter. |
Enforced TLS2
Retrieve current Enforced TLS settings.ListEnforcedTlsSetting | GET | This endpoint allows you to retrieve your current Enforced TLS settings. |
Update Enforced TLS settingsUpdateEnforcedTlsSetting | PATCH | This endpoint allows you to update your Enforced TLS settings. |
Engagement Quality2
Get Engagement Quality ScoresListEngagementQualityScore | GET | This operation allows you to retrieve your SendGrid Engagement Quality (SEQ) scores for a specified date range . |
Get Subusers' Engagement Quality ScoresListSubuserEngagementQualityScore | GET | This operation allows you to retrieve SendGrid Engagement Quality (SEQ) scores for your Subusers or customer accounts for a specific date. |
Event Webhook8
Create a new Event WebhookCreateEventWebhook | POST | This endpoint allows you to create a new Event Webhook. |
Delete a single Event Webhook by ID.DeleteEventWebhook | DELETE | This endpoint allows you to delete a single Event Webhook by ID. |
Get Signed Event Webhook's Public KeyGetSignedEventWebhook | GET | This endpoint allows you to retrieve the public key for a single Event Webhook by ID. |
Get the settings for a single Event Webhook.GetEventWebhook | GET | This endpoint allows you to retrieve a single Event Webhook by ID. |
Retrieve all of your Event Webhooks.ListEventWebhook | GET | This endpoint allows you to retrieve all of your Event Webhooks. |
Test an Event Webhook's settingsTestEventWebhook | POST | This endpoint allows you to test an Event Webhook. |
Toggle signature verification for a single Event Webhook by IDUpdateSignedEventWebhook | PATCH | This endpoint allows you to enable or disable signature verification for a single Event Webhook by ID. |
Update a single Event Webhook by ID.UpdateEventWebhook | PATCH | This endpoint allows you to update a single Event Webhook by ID. |
External Integration Endpoint5
Create IntegrationAddIntegration | POST | This endpoint creates an Integration for email event forwarding. |
Delete Bulk IntegrationDeleteIntegration | DELETE | This endpoint deletes Integrations. |
Get IntegrationFindIntegrationById | GET | This endpoint returns the data for a specific Integration. |
List IntegrationGetIntegrationsByUser | GET | This endpoint returns all the Integrations for the user making this call. |
Update IntegrationUpdateIntegration | PATCH | This endpoint updates an existing Integration. |
Global Suppression4
Add recipient addresses to the global suppression group.CreateGlobalSuppression | POST | This endpoint allows you to add one or more email addresses to the global suppressions group. |
Delete a Global SuppressionDeleteGlobalSuppression | DELETE | This endpoint allows you to remove an email address from the global suppressions group. |
Retrieve a Global SuppressionGetGlobalSuppression | GET | This endpoint allows you to retrieve a global suppression. |
Retrieve all global suppressionsListGlobalSuppression | GET | This endpoint allows you to retrieve a paginated list of all email address that are globally suppressed. |
Invalid Email4
Delete a specific invalid emailDeleteInvalidEmail | DELETE | This endpoint allows you to remove a specific email address from the invalid email address list. |
Delete invalid emailsDeleteInvalidEmails | DELETE | This endpoint allows you to remove email addresses from your invalid email address list. |
Retrieve a specific invalid emailGetInvalidEmail | GET | This endpoint allows you to retrieve a specific invalid email addresses. |
Retrieve all invalid emailsListInvalidEmail | GET | This endpoint allows you to retrieve a paginated list of all invalid email addresses. |
IP Access Management6
Add one or more IPs to the allow listAddIpToAllowList | POST | This endpoint allows you to add one or more allowed IP addresses. |
Remove a specific IP from the allowed listDeleteAllowedIp | DELETE | This endpoint allows you to remove a specific IP address from your list of allowed addresses. |
Remove one or more IPs from the allow listDeleteAllowedIps | DELETE | This endpoint allows you to remove one or more IP addresses from your list of allowed addresses. |
Retrieve a list of currently allowed IPsListAllowedIp | GET | This endpoint allows you to retrieve a list of IP addresses that are currently allowed to access your account. |
Retrieve a specific allowed IPGetAllowedIp | GET | This endpoint allows you to retreive a specific IP address that has been allowed to access your account. |
Retrieve all recent access attemptsListAccessActivity | GET | This endpoint allows you to retrieve a list of all of the IP addresses that recently attempted to access your account either through the User Interface or the API. |
IP Address5
Add IPsAddIp | POST | This endpoint is for adding a(n) IP Address(es) to your account. |
Get remaining IPs countListRemainingIpCount | GET | This endpoint gets amount of IP Addresses that can still be created during a given period and the price of those IPs. |
Retrieve all assigned IPsListAssignedIp | GET | This endpoint allows you to retrieve only assigned IP addresses. |
Retrieve all IP addressesListIp | GET | This endpoint allows you to retrieve a paginated list of all assigned and unassigned IPs. |
Retrieve all IP pools an IP address belongs toGetIp | GET | This endpoint allows you to see which IP pools a particular IP address has been added to. |
IP Address Management15
Add a Batch of IPs to an IP PoolAddIpsToIpPool | POST | This operation appends a batch of IPs to an IP Pool. |
Add a Twilio SendGrid IP AddressAddIp_ | POST | This operation adds a Twilio SendGrid IP address to your account. |
Assign a Batch of Subusers to an IPAddSubUsersToIp | POST | This operation appends a batch of Subusers to a specified IP address. |
Create an IP Pool with a Name and IP AssignmentsCreateIpPool_ | POST | This operation will create a named IP Pool and associate specified IP addresses with the newly created Pool. |
Delete a Batch of IPs from an IP PoolDeleteIpsFromIpPool | POST | This operation removes a batch of IPs from an IP Pool. |
Delete a Batch of Subusers from an IPDeleteSubUsersFromIp | POST | This operation removes a batch of Subusers from a specified IP address. |
Delete IP PoolDeleteIpPool_ | DELETE | This operation deletes an IP Pool and unassigns all IP addresses associated with the Pool. |
Get a List of all IP Addresses on your AccountListIp_ | GET | This operation returns a list of all IP addresses associated with your account. |
Get a List of Subusers Assigned to an IPListSubUserAssignedToIp | GET | This operation returns a list of Subuser IDs that have been assigned the specified IP address. |
GET all IP Pools that have Associated IPsListIpPool_ | GET | This operation returns a list of your IP Pools and a sample of each Pools' associated IP addresses. |
Get Details for an IP AddressGetIp_ | GET | This operation returns details for a specified IP address. |
Get Details for an IP PoolGetIpPool_ | GET | This operation will return the details for a specified IP Pool, including the Pool's name, ID, a sample list of the IPs associated with the Pool, and the total number of IPs belonging to... |
Get IPs Assigned to an IP PoolListIpAssignedToIpPool | GET | This operation returns the IP addresses that are assigned to the specified IP pool. |
Update an IP Pool NameUpdateIpPool_ | PUT | This operation will rename an IP Pool. |
Update Details for an IP AddressUpdateIp | PATCH | This operation updates an IP address's settings, including whether the IP is set to warm up automatically, if the IP is assigned by a parent account, and whether the IP is enabled or... |
IP Pool7
Add an IP address to a poolAddIpToIpPool | POST | This endpoint allows you to add an IP address to an IP pool. |
Create an IP poolCreateIpPool | POST | This endpoint allows you to create an IP pool. |
Delete an IP poolDeleteIpPool | DELETE | This endpoint allows you to delete an IP pool. |
Remove an IP address from a poolDeleteIpFromIpPool | DELETE | This endpoint allows you to remove an IP address from an IP pool. |
Rename an IP poolUpdateIpPool | PUT | This endpoint allows you to update the name of an IP pool. |
Retrieve all IP poolsListIpPool | GET | This endpoint allows you to get all of your IP pools. |
Retrieve all the IPs in a specified poolGetIpPool | GET | This endpoint allows you to get all of the IP addresses that are in a specific IP pool. |
IP Provisioning3
Add Account IPsAddAccountIps | POST | Adds IP(s) to the specified account. |
List Account IPsListAccountIps | GET | Retrieves a paginated list of IPs associated with the specified account, ordered by most recently added IP. |
Remove Account IPsRemoveAccountIps | DELETE | Removes IP(s) from the specified account. |
IP Warmup4
Retrieve all IPs currently in warmupListWarmUpIp | GET | This endpoint allows you to retrieve all of your IP addresses that are currently warming up. |
Retrieve the warmup status for a specific IP addressGetWarmUpIp | GET | This endpoint allows you to retrieve the warmup status for a specific IP address. |
Start warming up an IP addressWarmUpIp | POST | This endpoint allows you to put an IP address into warmup mode. |
Stop warming up an IP addressStopIpWarmUp | DELETE | This endpoint allows you to remove an IP address from warmup mode. |
Link Branding10
Associate a branded link with a subuserAssociateBrandedLinkWithSubuser | POST | This endpoint allows you to associate a branded link with a subuser account. |
Create a branded linkCreateBrandedLink | POST | This endpoint allows you to create a new branded link. |
Delete a branded linkDeleteBrandedLink | DELETE | This endpoint allows you to delete a branded link. |
Disassociate a branded link from a subuserDisassociateBrandedLinkFromSubuser | DELETE | This endpoint allows you to take a branded link away from a subuser. |
Retrieve a branded linkGetBrandedLink | GET | This endpoint allows you to retrieve a specific branded link by providing its ID. |
Retrieve a subuser's branded linkListSubuserBrandedLink | GET | This endpoint allows you to retrieve the branded link associated with a subuser. |
Retrieve all branded linksListBrandedLink | GET | This endpoint allows you to retrieve all branded links . |
Retrieve the default branded linkListDefaultBrandedLink | GET | This endpoint allows you to retrieve the default branded link. |
Update a branded linkUpdateBrandedLink | PATCH | This endpoint allows you to update a specific branded link. |
Validate a branded linkValidateBrandedLink | POST | This endpoint allows you to validate a branded link. |
List17
Add a Single Recipient to a ListAddRecipientToContactDbList | POST | This endpoint allows you to add a single recipient to a list. |
Add Multiple Recipients to a ListAddRecipientsToContactDbList | POST | This endpoint allows you to add multiple recipients to a list. |
Create a ListCreateContactDbList | POST | This endpoint allows you to create a list for your recipients. |
Create ListCreateMarketingList | POST | This endpoint creates a new contacts list. |
Delete a ListDeleteContactDbList | DELETE | This endpoint allows you to delete a specific recipient list with the given ID. |
Delete a listDeleteMarketingList | DELETE | This endpoint allows you to deletes a specific list. |
Delete a Single Recipient from a Single ListDeleteRecipientFromContactDbList | DELETE | This endpoint allows you to delete a single recipient from a list. |
Delete Multiple listsDeleteContactDbLists | DELETE | This endpoint allows you to delete multiple recipient lists. |
Get a List by IDGetMarketingList | GET | This endpoint returns data about a specific list. |
Get All ListsListMarketingList | GET | This endpoint returns an array of all of your contact lists. |
Get List Contact CountListContactCount_ | GET | This endpoint returns the number of contacts on a specific list. |
Remove Contacts from a ListDeleteContact_ | DELETE | This endpoint allows you to remove contacts from a given list. |
Retrieve a single listGetContactDbList | GET | This endpoint allows you to retrieve a single recipient list. |
Retrieve all listsListContactDbList | GET | This endpoint allows you to retrieve all of your recipient lists. |
Retrieve all recipients on a ListListRecipientsFromContactDbList | GET | This endpoint allows you to retrieve all recipients on the list with the given ID. |
Update a ListUpdateContactDbList | PATCH | This endpoint allows you to update the name of one of your recipient lists. |
Update ListUpdateMarketingList | PATCH | This endpoint updates the name of a list. |
Mail Batch2
Create a batch ID.CreateMailBatch | POST | This operation allows you to generate a new mail batch ID. |
Validate a batch ID.GetMailBatch | GET | This operation allows you to validate a mail batch ID. |
Mail Send1
Send Email with Twilio SendGrid.SendMail | POST | The Mail Send operation allows you to send email over SendGrid's v3 Web API |
Mail Setting13
Retrieve address whitelist mail settingsListAddressWhitelist | GET | This endpoint allows you to retrieve your current email address whitelist settings. |
Retrieve all mail settingsListMailSetting | GET | This endpoint allows you to retrieve a paginated list of all mail settings. |
Retrieve Bounce Purge Mail SettingsListBouncePurge | GET | This endpoint allows you to retrieve your current Bounce Purge mail settings. |
Retrieve footer mail settingsListFooter | GET | This endpoint allows you to retrieve your current Footer mail settings. |
Retrieve forward bounce mail settingsListForwardBounce | GET | This endpoint allows you to retrieve your current bounce forwarding mail settings. |
Retrieve forward spam mail settingsListForwardSpam | GET | This endpoint allows you to retrieve your current Forward Spam mail settings. |
Retrieve legacy template mail settingsListTemplate | GET | This endpoint allows you to retrieve your current legacy email template settings. |
Update address whitelist mail settingsUpdateAddressWhitelist | PATCH | This endpoint allows you to update your current email address whitelist settings. |
Update Bounce Purge Mail SettingsUpdateBouncePurge | PATCH | This endpoint allows you to update your current Bounce Purge mail settings. |
Update footer mail settingsUpdateFooter | PATCH | This endpoint allows you to update your current Footer mail settings. |
Update forward bounce mail settingsUpdateForwardBounce | PATCH | This endpoint allows you to update your current bounce forwarding mail settings. |
Update forward spam mail settingsUpdateForwardSpam | PATCH | This endpoint allows you to update your current Forward Spam mail settings. |
Update template mail settingsUpdateTemplate | PATCH | This endpoint allows you to update your current legacy email template settings. |
Offering3
Get account offeringsListAccountOffering | GET | Retrieves offering information about the specified account. |
Get all available offeringsListOffering | GET | Retrieves offerings available under the organization. |
Update account offeringsUpdateAccountOffering | PUT | Changes a package offering for the specified account. |
Parse Webhook6
Create a parse settingCreateParseSetting | POST | This endpoint allows you to create a new inbound parse setting. |
Delete a parse settingDeleteParseSetting | DELETE | This endpoint allows you to delete a specific inbound parse setting by hostname. |
Retrieve a specific parse settingGetParseSetting | GET | This endpoint allows you to retrieve a specific inbound parse setting by hostname. |
Retrieve all parse settingsListParseSetting | GET | This endpoint allows you to retrieve all of your current inbound parse settings. |
Retrieves Inbound Parse Webhook statistics.ListParseStatic | GET | This endpoint allows you to retrieve the statistics for your Parse Webhook usage. |
Update a parse settingUpdateParseSetting | PATCH | This endpoint allows you to update a specific inbound parse setting by hostname. |
Partner Setting1
Returns a list of all partner settings.ListPartnerSetting | GET | This endpoint allows you to retrieve a paginated list of all partner settings that you can enable. |
Point Delete System1
Erase recipients' email dataEraseRecipientEmailData | POST | This operation allows you to delete your recipients' personal email data |
Recipient15
Add recipientsAddRecipient | POST | This endpoint allows you to add a Marketing Campaigns recipient. |
Delete a RecipientDeleteRecipient | DELETE | This endpoint allows you to delete a single recipient with the given ID from your contact database. |
Delete RecipientsDeleteRecipients | DELETE | This endpoint allows you to deletes one or more recipients. |
Export RecipientsExportRecipient | POST | Use this endpoint to export lists or segments of recipients . |
Export Recipients StatusGetExportRecipient | GET | This endpoint can be used to check the status of a recipient export job . |
Get All Existing ExportsListExportRecipient | GET | Use this endpoint to retrieve details of all current exported jobs . |
Get Recipient Upload StatusListStatus | GET | This endpoint allows you to check the upload status of a Marketing Campaigns recipient. |
Retrieve a Count of RecipientsListRecipientCount | GET | This endpoint allows you to retrieve the total number of Marketing Campaigns recipients. |
Retrieve a single recipientGetRecipient | GET | This endpoint allows you to retrieve a single recipient by ID from your contact database. |
Retrieve recipientsListRecipient | GET | This endpoint allows you to retrieve all of your Marketing Campaigns recipients. |
Retrieve the count of billable recipientsGetBillable | GET | This endpoint allows you to retrieve the number of Marketing Campaigns recipients that you will be billed for. |
Retrieve the lists that a recipient is onGetRecipientList | GET | This endpoint allows you to retrieve the lists that a given recipient belongs to. |
Search recipientsListSearchRecipient | GET | This endpoint allows you to perform a search on all of your Marketing Campaigns recipients. |
Search recipientsSearchRecipient | POST | Search using segment conditions without actually creating a segment. |
Update RecipientUpdateRecipient | PATCH | This endpoint allows you to update one or more recipients. |
Reverse DNS5
Delete a reverse DNS recordDeleteReverseDns | DELETE | This endpoint allows you to delete a reverse DNS record. |
Retrieve a reverse DNS recordGetReverseDns | GET | This endpoint allows you to retrieve a reverse DNS record. |
Retrieve all reverse DNS recordsListReverseDns | GET | This endpoint allows you to retrieve a paginated list of all the Reverse DNS records created by this account. |
Set up reverse DNSSetUpReverseDns | POST | This endpoint allows you to set up reverse DNS. |
Validate a reverse DNS recordValidateReverseDns | POST | This endpoint allows you to validate a reverse DNS record. |
Scheduled Send5
Cancel or pause a scheduled sendCreateScheduledSend | POST | This endpoint allows you to cancel or pause a scheduled send associated with a batch id. |
Delete a cancellation or pause from a scheduled sendDeleteScheduledSend | DELETE | This endpoint allows you to delete the cancellation/pause of a scheduled send. |
Retrieve all scheduled sendsListScheduledSend | GET | This endpoint allows you to retrieve all cancelled and paused scheduled send information. |
Retrieve scheduled sendGetScheduledSend | GET | This endpoint allows you to retrieve the cancel/paused scheduled send information for a specific batch id. |
Update a scheduled sendUpdateScheduledSend | PATCH | This endpoint allows you to update the status of a scheduled send for the given batch id. |
Scope1
Retrieve a list of scopes for which this user has access.ListScope | GET | This endpoint returns a list of all scopes that this user has access to. |
Segment6
Create a SegmentCreateSegment | POST | This endpoint allows you to create a new segment. |
Delete a segmentDeleteSegment | DELETE | This endpoint allows you to delete a segment from your recipients database. |
Retrieve a segmentGetSegment | GET | This endpoint allows you to retrieve a single segment with the given ID. |
Retrieve all segmentsListSegment | GET | This endpoint allows you to retrieve all of your segments. |
Retrieve recipients on a segmentListRecipientForSegment | GET | This endpoint allows you to retrieve all of the recipients in a segment with the given ID. |
Update a segmentUpdateSegment | PATCH | This endpoint allows you to update a segment. |
Segmenting Contact3
Delete SegmentDeleteSegment__ | DELETE | This endpoint allows you to delete a segment by segment id. |
Get List of SegmentsListSegment_ | GET | This endpoint allows you to retrieve a list of segments. |
Get Segment by IDGetSegment__ | GET | This endpoint allows you to retrieve a single segment by ID. |
Segmenting Contacts V26
Create SegmentCreateSegment_ | POST | Segment name has to be unique. |
Delete segmentDeleteSegment_ | DELETE | This endpoint allows you to delete a segment by ID. |
Get List of SegmentsListSegment__ | GET | This endpoint allows you to retrieve a list of segments. |
Get Segment by IDGetSegment_ | GET | Get Marketing Campaigns Segment by ID |
Manually refresh a segmentRefreshSegment | POST | Manually refresh a segment by segment ID. |
Update SegmentUpdateSegment_ | PATCH | Segment name has to be unique. |
Send Test Email1
Send a Test Marketing EmailSendTestMarketingEmail | POST | This endpoint allows you to send a test marketing email to a list of email addresses . |
Sender6
Create a SenderCreateSender | POST | This endpoint allows you to create a new Sender. |
Delete a SenderDeleteSender | DELETE | This endpoint allows you to delete an existing Sender. |
Get a list of all SendersListSender | GET | This endpoint allows you to get a list of all your Senders. |
Get a specific SenderGetSender | GET | This endpoint allows you to get the details for a specific Sender by id. |
Resend a Sender verificationResetSenderVerification | POST | This endpoint allows you to resend the verification request for a specific Sender. |
Update a SenderUpdateSender | PATCH | This endpoint allows you to update an existing Sender. |
Sender Identity6
Create a Sender IdentityCreateSender_ | POST | This endpoint allows you to create a new sender identity. |
Delete a Sender IdentityDeleteSender_ | DELETE | This endpoint allows you to delete one of your sender identities. |
Get all Sender IdentitiesListSender_ | GET | This endpoint allows you to retrieve a list of all sender identities that have been created for your account. |
Resend Sender Identity VerificationResetSenderVerification_ | POST | This endpoint allows you to resend a sender identity verification email. |
Update a Sender IdentityUpdateSender_ | PATCH | This endpoint allows you to update a sender identity. |
View a Sender IdentityGetSender_ | GET | This endpoint allows you to retrieve a specific sender identity. |
Sender Verification8
Completed StepsListVerifiedSenderStepsCompleted | GET | This endpoint allows you to determine which of SendGrid’s verification processes have been completed for an account . |
Create Verified Sender RequestCreateVerifiedSender | POST | This endpoint allows you to create a new Sender Identify . |
Delete Verified SenderDeleteVerifiedSender | DELETE | This endpoint allows you to delete a Sender Identity . |
Domain Warn ListListVerifiedSenderDomain | GET | This endpoint returns a list of domains known to implement DMARC and categorizes them by failure type - hard failure or soft failure . |
Edit Verified SenderUpdateVerifiedSender | PATCH | This endpoint allows you to update an existing Sender Identity . |
Get All Verified SendersListVerifiedSender | GET | This endpoint allows you to retrieve all the Sender Identities associated with an account. |
Resend Verified Sender RequestResendVerifiedSender | POST | This endpoint allows you to resend a verification email to a specified Sender Identity . |
Verify Sender RequestVerifySenderToken | GET | This endpoint allows you to verify a sender requests. |
Single Send11
Bulk Delete Single SendsDeleteSingleSends | DELETE | This endpoint allows you to delete multiple Single Sends using an array of Single Sends IDs. |
Create Single SendCreateSingleSend | POST | This endpoint allows you to create a new Single Send. |
Delete Single Send by IDDeleteSingleSend | DELETE | This endpoint allows you to delete one Single Send using a Single Send ID. |
Delete Single Send ScheduleDeleteScheduledSingleSend | DELETE | This endpoint allows you to cancel a scheduled Single Send using a Single Send ID. |
Duplicate Single SendDuplicateSingleSend | POST | This endpoint allows you to duplicate an existing Single Send using its Single Send ID. |
Get All CategoriesListCategory_ | GET | This endpoint allows you to retrieve all the categories associated with your Single Sends. |
Get All Single SendsListSingleSend | GET | This endpoint allows you to retrieve all your Single Sends. |
Get Single Send by IDGetSingleSend | GET | This endpoint allows you to retrieve details about one Single Send using a Single Send ID. |
Get Single Sends SearchSearchSingleSend | POST | This endpoint allows you to search for Single Sends based on specified criteria. |
Schedule Single SendScheduleSingleSend | PUT | This endpoint allows you to send a Single Send immediately or schedule it to be sent at a later time. |
Update Single SendUpdateSingleSend | PATCH | This endpoint allows you to update a Single Send using a Single Send ID. |
Spam Report4
Delete a specific spam reportDeleteSpamReport | DELETE | This endpoint allows you to delete a specific spam report by email address. |
Delete spam reportsDeleteSpamReports | DELETE | This endpoint allows you to delete your spam reports. |
Retrieve a specific spam reportGetSpamReport | GET | This endpoint allows you to retrieve a specific spam report by email address. |
Retrieve all spam reportsListSpamReport | GET | This endpoint allows you to retrieve a paginated list of all spam reports. |
SSO Certificate5
Create an SSO CertificateCreateSsoCertificate | POST | This endpoint allows you to create an SSO certificate. |
Delete an SSO CertificateDeleteSsoCertificate | DELETE | This endpoint allows you to delete an SSO certificate. |
Get All SSO Certificates by IntegrationListSsoIntegrationCertificate | GET | This endpoint allows you to retrieve all your IdP configurations by configuration ID. |
Get an SSO CertificateGetSsoCertificate | GET | This endpoint allows you to retrieve an individual SSO certificate. |
Update SSO CertificateUpdateSsoCertificate | PATCH | This endpoint allows you to update an existing certificate by ID. |
SSO Setting5
Create an SSO IntegrationCreateSsoIntegration | POST | This endpoint allows you to create an SSO integration. |
Delete an SSO IntegrationDeleteSsoIntegration | DELETE | This endpoint allows you to delete an IdP configuration by ID. |
Get All SSO IntegrationsListSsoIntegration | GET | This endpoint allows you to retrieve all SSO integrations tied to your Twilio SendGrid account. |
Get an SSO IntegrationGetSsoIntegration | GET | This endpoint allows you to retrieve an SSO integration by ID. |
Update an SSO IntegrationUpdateSsoIntegration | PATCH | This endpoint allows you to modify an exisiting SSO integration. |
SSO Teammate2
Create an SSO Teammate.CreateSsoTeammate | POST | This endpoint allows you to create an SSO Teammate. |
Edit an SSO TeammateUpdateSsoTeammate | PATCH | This endpoint allows you to modify an existing SSO Teammate. |
Stat15
Export Single Send StatsExportAutomationStat | GET | This endpoint allows you to export Single Send stats as .CSV data . |
Export Single Send StatsExportSingleSendStat | GET | This endpoint allows you to export Single Send stats as .CSV data . |
Get All Automation StatsListAutomationStat | GET | This endpoint allows you to retrieve stats for all your Automations. |
Get All Single Sends StatsListSingleSendStat | GET | This endpoint allows you to retrieve stats for all your Single Sends. |
Get Automation Click Tracking Stats by IDListClickTrackingStat | GET | This endpoint lets you retrieve click-tracking stats for a single Automation . |
Get Automation Stats by IDGetAutomationStat | GET | This endpoint allows you to retrieve stats for a single Automation using its ID. |
Get Single Send Click Tracking Stats by IDListSingleSendTrackingStat | GET | This endpoint lets you retrieve click-tracking stats for one Single Send . |
Get Single Send Stats by IDGetSingleSendStat | GET | This endpoint allows you to retrieve stats for an individual Single Send using a Single Send ID. |
Retrieve email statistics by browser.ListBrowserStat | GET | This endpoint allows you to retrieve your email statistics segmented by browser type. |
Retrieve email statistics by client type.ListClientStat | GET | This endpoint allows you to retrieve your email statistics segmented by client type. |
Retrieve email statistics by country and state/province.ListGeoStat | GET | This endpoint allows you to retrieve your email statistics segmented by country and state/province. |
Retrieve email statistics by device type.ListDeviceStat | GET | This endpoint allows you to retrieve your email statistics segmented by the device type. |
Retrieve email statistics by mailbox provider.ListMailboxProviderStat | GET | This endpoint allows you to retrieve your email statistics segmented by recipient mailbox provider. |
Retrieve global email statisticsListStat | GET | This endpoint allows you to retrieve all of your global email statistics between a given date range. |
Retrieve stats by a specific client type.GetClientStat | GET | This endpoint allows you to retrieve your email statistics segmented by a specific client type. |
Subuser9
Create SubuserCreateSubuser | POST | This endpoint allows you to create a new subuser. |
Delete a subuserDeleteSubuser | DELETE | This endpoint allows you to delete a subuser. |
Enable/disable a subuserUpdateSubuser | PATCH | This endpoint allows you to enable or disable a subuser. |
Get the Credits for a SubuserGetSubuserCredit | GET | This endpoint allows you to retrieve a Credits overview for a Subuser. |
List all SubusersListSubuser | GET | This endpoint allows you to retrieve a paginated list of all your subusers. |
Retrieve Subuser ReputationsListReputation | GET | This endpoint allows you to request the reputations for your subusers. |
Update IPs assigned to a subuserUpdateSubuserIp | PUT | This endpoint allows you update your subusers' assigned IP. |
Update the Credits for a SubuserUpdateSubuserCredit | PUT | This endpoint allows you to update the Credits for a Subuser. |
Update the remaining credits for a SubuserUpdateSubuserRemainingCredit | PATCH | This endpoint allows you to update the remaining credits for a Subuser. |
Subuser Statistic4
Retrieve email statistics for your subusers.ListStat_ | GET | This endpoint allows you to retrieve the email statistics for the given subusers. |
Retrieve monthly stats for all subusersListMonthlyStat | GET | This endpoint allows you to retrieve the monthly email statistics for all subusers over the given date range. |
Retrieve the monthly email statistics for a single subuserListSubuserMonthlyStat | GET | This endpoint allows you to retrive the monthly email statistics for a specific subuser. |
Retrieve the totals for each email statistic metric for allListStatSum | GET | This endpoint allows you to retrieve the total sums of each email statistic metric for all subusers over the given date range. |
Subuser Website Access1
Enable/Disable website access for a SubuserUpdateSubuserWebsiteAccess | PATCH | Enable/Disable website access for a Subuser, while still preserving email send functionality. |
Suppression6
Add suppressions to a suppression groupAddSuppressionToAsmGroup | POST | This endpoint allows you to add email addresses to an unsubscribe group. |
Delete a suppression from a suppression groupDeleteSuppressionFromAsmGroup | DELETE | This endpoint allows you to remove a suppressed email address from the given suppression group. |
Retrieve all suppression groups for an email addressGetAsmSuppression | GET | This endpoint returns a list of all groups from which the given email address has been unsubscribed. |
Retrieve all suppressionsListAsmSuppression | GET | This endpoint allows you to retrieve a list of all suppressions. |
Retrieve all suppressions for a suppression groupListSuppressionFromAsmGroup | GET | This endpoint allows you to retrieve all suppressed email addresses belonging to the given group. |
Search for suppressions within a groupSearchSuppressionFromAsmGroup | POST | This endpoint allows you to search a suppression group for multiple suppressions. |
Teammate9
Delete pending teammateDeletePendingTeammate | DELETE | This endpoint allows you to delete a pending teammate invite. |
Delete teammateDeleteTeammate | DELETE | This endpoint allows you to delete a teammate. |
Get Teammate Subuser AccessListSubuserByTemplate | GET | This operation allows you to retrieve the Subusers that can be accessed by a specified Teammate. |
Invite teammateInviteTeammate | POST | This endpoint allows you to invite a Teammate to your account via email. |
Resend teammate inviteResendTeammateInvite | POST | This endpoint allows you to resend a Teammate invitation. |
Retrieve all pending teammatesListPendingTeammate | GET | This endpoint allows you to retrieve a list of all pending Teammate invitations. |
Retrieve all teammatesListTeammate | GET | This endpoint allows you to retrieve a paginated list of all current Teammates. |
Retrieve specific teammateGetTeammate | GET | This endpoint allows you to retrieve a specific Teammate by username. |
Update teammate's permissionsUpdateTeammate | PATCH | This endpoint allows you to update a teammate’s permissions. |
Template6
Create a transactional template.CreateTemplate | POST | This endpoint allows you to create a transactional template. |
Delete a template.DeleteTemplate | DELETE | This endpoint allows you to delete a transactional template. |
Duplicate a transactional template.DuplicateTemplate | POST | This endpoint allows you to duplicate a transactional template. |
Edit a transactional template.UpdateTemplate_ | PATCH | This endpoint allows you to edit the name of a transactional template. |
Retrieve a single transactional template.GetTemplate | GET | This endpoint allows you to retrieve a single transactional template. |
Retrieve paged transactional templates.ListTemplate_ | GET | This endpoint allows you to retrieve all transactional templates. |
Templates Version5
Activate a transactional template version.ActivateTemplateVersion | POST | This endpoint allows you to activate a version of one of your templates. |
Create a new transactional template version.CreateTemplateVersion | POST | This endpoint allows you to create a new version of a template. |
Delete a transactional template version.DeleteTemplateVersion | DELETE | This endpoint allows you to delete a transactional template version. |
Edit a transactional template version.UpdateTemplateVersion | PATCH | This endpoint allows you to edit the content of your template version. |
Retrieve a specific transactional template version.GetTemplateVersion | GET | This endpoint allows you to retrieve a specific version of a template. |
Tracking9
Get Open Tracking SettingsListOpenTrackingSetting | GET | This endpoint allows you to retrieve your current settings for open tracking. |
Retrieve Click Track SettingsListClickTrackingSetting | GET | This endpoint allows you to retrieve your current click tracking setting. |
Retrieve Google Analytics SettingsListGoogleAnalyticsTrackingSetting | GET | This endpoint allows you to retrieve your current setting for Google Analytics. |
Retrieve Subscription Tracking SettingsListSubscriptionTrackingSetting | GET | This endpoint allows you to retrieve your current settings for subscription tracking. |
Retrieve Tracking SettingsListTrackingSetting | GET | This endpoint allows you to retrieve a list of all tracking settings on your account. |
Update Click Tracking SettingsUpdateClickTrackingSetting | PATCH | This endpoint allows you to enable or disable your current click tracking setting. |
Update Google Analytics SettingsUpdateGoogleAnalyticsTrackingSetting | PATCH | This endpoint allows you to update your current setting for Google Analytics. |
Update Open Tracking SettingsUpdateOpenTrackingSetting | PATCH | This endpoint allows you to update your current settings for open tracking. |
Update Subscription Tracking SettingsUpdateSubscriptionTrackingSetting | PATCH | This endpoint allows you to update your current settings for subscription tracking. |
Unsubscribe Group5
Create a new suppression groupCreatAsmGroup | POST | This endpoint allows you to create a new suppression group. |
Delete a Suppression GroupDeleteAsmGroup | DELETE | This endpoint allows you to delete a suppression group. |
Get information on a single suppression group.GetAsmGroup | GET | This endpoint allows you to retrieve a single suppression group. |
Retrieve all suppression groups associated with the user.ListAsmGroup | GET | This endpoint allows you to retrieve a list of all suppression groups created by this user. |
Update a suppression group.UpdateAsmGroup | PATCH | This endpoint allows you to update or change a suppression group. |
Users API9
Get a user's account information.ListAccount_ | GET | This endpoint allows you to retrieve your user account details. |
Get a user's profileListProfile | GET | This endpoint allows you to retrieve your current profile details. |
Retrieve your account email addressListEmail | GET | This endpoint allows you to retrieve the email address currently on file for your account. |
Retrieve your credit balanceListCredit | GET | This endpoint allows you to retrieve the current credit balance for your account. |
Retrieve your usernameListUsername | GET | This endpoint allows you to retrieve your current account username. |
Update a user's profileUpdateProfile | PATCH | This endpoint allows you to update your current profile details. |
Update your account email addressUpdateEmail | PUT | This endpoint allows you to update the email address currently on file for your account. |
Update your passwordUpdatePassword | PUT | This endpoint allows you to update your password. |
Update your usernameUpdateUsername | PUT | This endpoint allows you to update the username for your account. |
Webhook Security5
Create a new webhook security policyCreateSecurityPolicy | POST | Create a new webhook security policy. |
Delete a specific webhook security policyDeleteSecurityPolicy | DELETE | Permanently delete a webhook security policy by its ID. |
Retrieve a specific webhook security policyGetSecurityPolicy | GET | Retrieve the details of a specific webhook security policy by its ID. |
Retrieve all webhook security policies for your accountListAllSecurityPolicies | GET | Returns a list of all webhook security policies configured for your account, including their IDs, names, and security configurations. |
Update an existing webhook security policyUpdateSecurityPolicy | PATCH | Update an existing webhook security policy with new configuration values. |