Destinations

SendGrid

Background

SendGrid is a cloud-based email delivery platform that enables businesses to send transactional and marketing emails at scale. In a streaming ETL (Extract, Transform, Load) workflow, SendGrid acts as a destination for transformed data, allowing businesses to deliver personalized and dynamic email content in real-time. Its robust API and analytics tools make it a reliable choice for email automation and optimization.

Supported Actions

mail

  • POSTCreate a batch ID
  • GETValidate batch ID
  • POSTv3 Mail Send

user

  • GETRetrieve scheduled send
  • PATCHUpdate a scheduled send
  • DELETEDelete a cancellation or pause from a scheduled send
  • POSTCancel or pause a scheduled send
  • GETRetrieve all scheduled sends
  • GETRetrieve current Enforced TLS settings.
  • PATCHUpdate Enforced TLS settings
  • GETGet a user's profile
  • PATCHUpdate a user's profile
  • GETRetrieve your account email address
  • PUTUpdate your account email address
  • GETRetrieve your username
  • PUTUpdate your username
  • GETRetrieve Signed Webhook Public Key
  • PATCHEnable/Disable Signed Webhook
  • GETRetrieve Event Webhook settings
  • PATCHUpdate Event Notification Settings
  • POSTTest Event Notification Settings
  • GETRetrieve a specific parse setting
  • PATCHUpdate a parse setting
  • DELETEDelete a parse setting
  • GETRetrieve all parse settings
  • POSTCreate a parse setting
  • GETRetrieves Inbound Parse Webhook statistics.
  • GETGet a user's account information.
  • GETRetrieve your credit balance
  • PUTUpdate your password

api_keys

  • GETRetrieve an existing API Key
  • PATCHUpdate API key name
  • PUTUpdate API key name and scopes
  • DELETEDelete API keys
  • POSTCreate API keys
  • GETRetrieve all API Keys belonging to the authenticated user

scopes

  • DELETEDeny access request
  • PATCHApprove access request
  • GETRetrieve access requests
  • GETRetrieve a list of scopes for which this user has access.

access_settings

  • GETRetrieve a specific allowed IP
  • DELETERemove a specific IP from the allowed list
  • POSTAdd one or more IPs to the allow list
  • GETRetrieve a list of currently allowed IPs
  • DELETERemove one or more IPs from the allow list
  • GETRetrieve all recent access attempts

sso

  • GETGet an SSO Certificate
  • PATCHUpdate SSO Certificate
  • DELETEDelete an SSO Certificate
  • POSTCreate an SSO Certificate
  • GETGet an SSO Integration
  • PATCHUpdate an SSO Integration
  • DELETEDelete an SSO Integration
  • POSTCreate an SSO Integration
  • GETGet All SSO Integrations
  • GETGet All SSO Certificates by Integration
  • POSTCreate SSO Teammate
  • PATCHEdit an SSO Teammate

mail_settings

  • PATCHUpdate address whitelist mail settings
  • GETRetrieve address whitelist mail settings
  • PATCHUpdate footer mail settings
  • GETRetrieve footer mail settings
  • PATCHUpdate forward spam mail settings
  • GETRetrieve forward spam mail settings
  • PATCHUpdate template mail settings
  • GETRetrieve legacy template mail settings
  • PATCHUpdate bounce purge mail settings
  • GETRetrieve bounce purge mail settings
  • PATCHUpdate forward bounce mail settings
  • GETRetrieve forward bounce mail settings
  • GETRetrieve all mail settings

partner_settings

  • PATCHUpdates New Relic partner settings.
  • GETReturns all New Relic partner settings.
  • GETReturns a list of all partner settings.

teammates

  • DELETEDelete pending teammate
  • POSTResend teammate invite
  • GETRetrieve all pending teammates
  • GETRetrieve specific teammate
  • PATCHUpdate teammate's permissions
  • DELETEDelete teammate
  • POSTInvite teammate
  • GETRetrieve all teammates

alerts

  • GETRetrieve a specific alert
  • DELETEDelete an alert
  • PATCHUpdate an alert
  • POSTCreate a new Alert
  • GETRetrieve all alerts

subusers

  • GETRetrieve monitor settings for a subuser
  • POSTCreate monitor settings
  • PUTUpdate Monitor Settings for a subuser
  • DELETEDelete monitor settings
  • PATCHEnable/disable a subuser
  • DELETEDelete a subuser
  • PUTUpdate IPs assigned to a subuser
  • GETRetrieve the monthly email statistics for a single subuser
  • GETRetrieve email statistics for your subusers.
  • GETRetrieve monthly stats for all subusers
  • GETRetrieve the totals for each email statistic metric for all subusers.
  • GETList all Subusers
  • POSTCreate Subuser
  • GETRetrieve Subuser Reputations

whitelabel

  • GETRetrieve a branded link
  • PATCHUpdate a branded link
  • DELETEDelete a branded link
  • POSTValidate a branded link
  • GETRetrieve a subuser's branded link
  • DELETEDisassociate a branded link from a subuser
  • POSTCreate a branded link
  • GETRetrieve all branded links
  • POSTAssociate a branded link with a subuser
  • GETRetrieve the default branded link
  • GETRetrieve a reverse DNS record
  • DELETEDelete a reverse DNS record
  • POSTValidate a reverse DNS record
  • POSTSet up reverse DNS
  • GETRetrieve all reverse DNS records
  • GETRetrieve an authenticated domain
  • PATCHUpdate an authenticated domain
  • DELETEDelete an authenticated domain.
  • POSTAssociate an authenticated domain with a given user.
  • POSTAdd an IP to an authenticated domain
  • DELETERemove an IP from an authenticated domain.
  • POSTValidate a domain authentication.
  • GETList the authenticated domain associated with the given user.
  • DELETEDisassociate an authenticated domain from a given user.
  • GETList all authenticated domains
  • POSTAuthenticate a domain
  • GETGet the default authentication
  • POSTEmail DNS records to a co-worker

ips

  • GETRetrieve the warmup status for a specific IP address
  • DELETEStop warming up an IP address
  • POSTStart warming up an IP address
  • GETRetrieve all IPs currently in warmup
  • POSTAdd an IP address to a pool
  • DELETERemove an IP address from a pool
  • GETRetrieve all the IPs in a specified pool
  • PUTRename an IP pool
  • DELETEDelete an IP pool
  • POSTCreate an IP pool
  • GETRetrieve all IP pools
  • POSTAdd IPs
  • GETRetrieve all IP addresses
  • GETGet remaining IPs count
  • GETRetrieve all assigned IPs
  • GETRetrieve all IP pools an IP address belongs to

verified_senders

  • PATCHEdit Verified Sender
  • DELETEDelete Verified Sender
  • POSTCreate Verified Sender Request
  • GETGet All Verified Senders
  • GETDomain Warn List
  • GETCompleted Steps
  • GETVerify Sender Request
  • POSTResend Verified Sender Request

designs

  • POSTDuplicate Design
  • GETGet Design
  • PATCHUpdate Design
  • DELETEDelete Design
  • POSTDuplicate SendGrid Pre-built Design
  • GETGet SendGrid Pre-built Design
  • GETList SendGrid Pre-built Designs
  • POSTCreate Design
  • GETList Designs

marketing

  • POSTExport Contacts
  • GETGet All Existing Exports
  • GETExport Contacts Status
  • POSTSearch Contacts
  • POSTGet Contacts by Emails
  • PUTImport Contacts
  • GETImport Contacts Status
  • PUTAdd or Update a Contact
  • DELETEDelete Contacts
  • GETGet Sample Contacts
  • GETGet Total Contact Count
  • GETGet a Contact by ID
  • POSTGet Batched Contacts by IDs
  • PATCHUpdate Segment
  • GETGet Segment by ID
  • DELETEDelete segment
  • POSTCreate Segment
  • GETGet List of Segments
  • GETGet Segment by ID
  • PATCHUpdate Segment
  • DELETEDelete Segment
  • POSTCreate Segment
  • GETGet List of Segments
  • POSTBulk Delete Segments
  • DELETERemove Contacts from a List
  • GETGet List Contact Count
  • GETGet a List by ID
  • PATCHUpdate List
  • DELETEDelete a list
  • POSTCreate List
  • GETGet All Lists
  • PATCHUpdate Custom Field Definition
  • DELETEDelete Custom Field Definition
  • POSTCreate Custom Field Definition
  • GETGet All Field Definitions
  • PUTSchedule Single Send
  • DELETEDelete Single Send Schedule
  • POSTDuplicate Single Send
  • PATCHUpdate Single Send
  • GETGet Single Send by ID
  • DELETEDelete Single Send by ID
  • POSTCreate Single Send
  • GETGet All Single Sends
  • DELETEBulk Delete Single Sends
  • POSTGet Single Sends Search
  • GETGet All Categories
  • GETGet Automation Stats by ID
  • GETGet Automation Click Tracking Stats by ID
  • GETGet All Automation Stats
  • GETExport Automation Stats
  • GETGet Single Send Stats by ID
  • GETGet Single Send Click Tracking Stats by ID
  • GETGet All Single Sends Stats
  • GETExport Single Send Stats
  • POSTCreate a Sender Identity
  • POSTSend a Test Marketing Email

senders

  • GETView a Sender Identity
  • PATCHUpdate a Sender Identity
  • DELETEDelete a Sender Identity
  • POSTResend Sender Identity Verification
  • POSTCreate a Sender Identity
  • GETGet all Sender Identities

contactdb

  • POSTAdd a Single Recipient to a List
  • DELETEDelete a Single Recipient from a Single List
  • GETRetrieve all recipients on a List
  • POSTAdd Multiple Recipients to a List
  • GETRetrieve a single list
  • PATCHUpdate a List
  • DELETEDelete a List
  • POSTCreate a List
  • GETRetrieve all lists
  • DELETEDelete Multiple lists
  • GETRetrieve a single recipient
  • DELETEDelete a Recipient
  • GETRetrieve the lists that a recipient is on
  • GETSearch recipients
  • POSTSearch recipients
  • POSTAdd recipients
  • PATCHUpdate Recipient
  • DELETEDelete Recipients
  • GETRetrieve recipients
  • GETRetrieve the count of billable recipients
  • GETRetrieve a Count of Recipients
  • GETRetrieve a Custom Field
  • DELETEDelete a Custom Field
  • POSTCreate a Custom Field
  • GETRetrieve all custom fields
  • GETRetrieve a segment
  • PATCHUpdate a segment
  • DELETEDelete a segment
  • GETRetrieve recipients on a segment
  • POSTCreate a Segment
  • GETRetrieve all segments
  • GETGet Recipient Upload Status
  • GETRetrieve reserved fields

categories

  • GETRetrieve Email Statistics for Categories
  • GETRetrieve sums of email stats for each category [Needs: Stats object defined, has category ID?]
  • GETRetrieve all categories

campaigns

  • POSTSchedule a Campaign
  • PATCHUpdate a Scheduled Campaign
  • GETView Scheduled Time of a Campaign
  • DELETEUnschedule a Scheduled Campaign
  • POSTSend a Campaign
  • POSTSend a Test Campaign
  • GETRetrieve a single campaign
  • DELETEDelete a Campaign
  • PATCHUpdate a Campaign
  • POSTCreate a Campaign
  • GETRetrieve all Campaigns

templates

  • GETRetrieve a specific transactional template version.
  • PATCHEdit a transactional template version.
  • DELETEDelete a transactional template version.
  • POSTActivate a transactional template version.
  • POSTCreate a new transactional template version.
  • POSTDuplicate a transactional template.
  • GETRetrieve a single transactional template.
  • PATCHEdit a transactional template.
  • DELETEDelete a template.
  • POSTCreate a transactional template.
  • GETRetrieve paged transactional templates.

messages

  • POSTRequest CSV
  • GETDownload CSV
  • GETFilter all messages
  • GETFilter messages by message ID

tracking_settings

  • GETRetrieve Click Track Settings
  • PATCHUpdate Click Tracking Settings
  • GETRetrieve Google Analytics Settings
  • PATCHUpdate Google Analytics Settings
  • GETGet Open Tracking Settings
  • PATCHUpdate Open Tracking Settings
  • GETRetrieve Subscription Tracking Settings
  • PATCHUpdate Subscription Tracking Settings
  • GETRetrieve Tracking Settings

clients

  • GETRetrieve email statistics by client type.
  • GETRetrieve stats by a specific client type.

suppression

  • GETRetrieve a Bounce
  • DELETEDelete a bounce
  • GETRetrieve all bounces
  • DELETEDelete bounces
  • GETRetrieve a specific block
  • DELETEDelete a specific block
  • GETRetrieve all blocks
  • DELETEDelete blocks
  • GETRetrieve a specific spam report
  • DELETEDelete a specific spam report
  • GETRetrieve all spam reports
  • DELETEDelete spam reports
  • GETRetrieve a specific invalid email
  • DELETEDelete a specific invalid email
  • GETRetrieve all invalid emails
  • DELETEDelete invalid emails
  • GETRetrieve all global suppressions

asm

  • GETRetrieve a Global Suppression
  • DELETEDelete a Global Suppression
  • POSTAdd recipient addresses to the global suppression group.
  • GETRetrieve all suppressions
  • GETRetrieve all suppression groups for an email address
  • POSTAdd suppressions to a suppression group
  • GETRetrieve all suppressions for a suppression group
  • POSTSearch for suppressions within a group
  • DELETEDelete a suppression from a suppression group
  • GETGet information on a single suppression group.
  • PATCHUpdate a suppression group.
  • DELETEDelete a Suppression Group
  • POSTCreate a new suppression group
  • GETRetrieve all suppression groups associated with the user.

Validate an email

  • POSTValidate an email

Retrieve global email statistics

  • GETRetrieve global email statistics

Retrieve email statistics by country and state/province.

  • GETRetrieve email statistics by country and state/province.

Retrieve email statistics by device type.

  • GETRetrieve email statistics by device type.

Retrieve email statistics by mailbox provider.

  • GETRetrieve email statistics by mailbox provider.

Retrieve email statistics by browser.

  • GETRetrieve email statistics by browser.