Tools
Sendgrid
SendGrid is a cloud-based email delivery platform providing transactional and marketing email services, with APIs for integration, analytics, and scalability
Activate a transactional template version
Activate a transactional template version
this endpoint allows you to activate a version of one of your templates.
Add an ip to an authenticated domain
Add an ip to an authenticated domain
this endpoint allows you to add an ip address to an authenticated domain.
Add a batch of ips to an ip pool
Add a batch of ips to an ip pool
This operation appends a batch of ips to an ip pool. this operation requires all ip assignments to succeed. if any ip assignments fail, this endpoint will return an error.
Add an ip address to a pool
Add an ip address to a pool
Add an ip address to a pool with this endpoint. activation in sendgrid needed first. it takes up to 60 seconds. possible to add to multiple pools. retrieve ips via a specific endpoint.
Add a single recipient to a list
Add a single recipient to a list
this endpoint allows you to add a single recipient to a list.
Add ips
Add ips
this endpoint is for adding a(n) ip address(es) to your account.
Approve access request
Approve access request
this endpoint allows you to approve an access attempt. note: only teammate admins may approve another teammate’s access request.
Add a twilio sendgrid ip address
Add a twilio sendgrid ip address
This operation adds a twilio sendgrid ip address to your account. you can also assign up to 100 subusers to the ip address at creation.
Add suppressions to a suppression group
Add suppressions to a suppression group
this endpoint allows you to add email addresses to an unsubscribe group. if you attempt to add suppressions to a group that has been deleted or does not exist, the suppressions will be added to the global suppressions list.
Add one or more ips to the allow list
Add one or more ips to the allow list
This endpoint adds allowed ip addresses to a list, which then assigns each ip an id for future removal; ids can be retrieved via a specific retrieval endpoint.
Assign a batch of subusers to an ip
Assign a batch of subusers to an ip
This operation appends a batch of subusers to a specified ip address. this endpoint requires all subuser assignments to succeed. if a subuser assignment fails, this endpoint will return an error.
Associate a branded link with a subuser
Associate a branded link with a subuser
Parent accounts can create and validate branded links, then assign them to subusers through the api or twilio sendgrid app, enabling subusers to use the branded links for mail.
Authenticate an account with single sign on
Authenticate an account with single sign on
Authenticates and logs in a user to twilio sendgrid as a specific admin identity configured for sso by partner. any additional teammates or subusers will need to log in directly via app.sendgrid.com
Associate an authenticated domain with a given user
Associate an authenticated domain with a given user
Associate authenticated domains with subusers under a parent account to enable email sending using the parent’s domain. authentication by the parent is required. multiple domains can be linked using the specified endpoint.
Add or update a contact
Add or update a contact
The endpoint can handle 30k contacts or 6mb, reports queuing/errors, needs extra steps to confirm changes and retrieve ids. custom fields must pre-exist and exact identifiers are required for updates; email addresses are auto-lowered in case.
Authenticate a domain
Authenticate a domain
The endpoint enables domain authentication for users or subusers, offering two methods—‘username’ parameter for visibility and modification, or the association workflow for a fixed, non-editable domain assignment.
Add recipient addresses to the global suppression group
Add recipient addresses to the global suppression group
this endpoint allows you to add one or more email addresses to the global suppressions group.
Cancel or pause a scheduled send
Cancel or pause a scheduled send
This api endpoint allows users to cancel or pause a scheduled email by providing its
batch id. to change or remove this status, specific endpoints must be used; exceeding limits or duplicating actions will trigger a 400 error.Bulk delete single sends
Bulk delete single sends
This api endpoint enables the deletion of multiple single sends by providing their ids. retrieve ids with a get request to
/marketing/singlensends. deletions are irreversible.Bind authenticated domains to user
Bind authenticated domains to user
This endpoint enables linking up to five authenticated domains from a parent account to a subuser, giving them permission to send emails with the parent’s domain. domains are prioritized when sending emails.
Create an ip pool
Create an ip pool
Create an ip pool by activating an ip in sendgrid: log in, go to settings > ip addresses, edit selected ip, check to allow sending, and save.
Create an ip pool with a name and ip assignments
Create an ip pool with a name and ip assignments
Creating an ip pool associates specified ips with it. all ips must be successfully assigned, or creation fails with an error. a pool can have up to 100 ips.
Create an sso certificate
Create an sso certificate
this endpoint allows you to create an sso certificate.
Create a batch id
Create a batch id
Create a new mail batch id to group email sends, allowing pause or cancel actions via the scheduled sends api.
Create an sso integration
Create an sso integration
this endpoint allows you to create an sso integration.
Completed steps
Completed steps
This api endpoint checks if a sendgrid account has completed domain authentication (
domain verified) and single sender verification (sender verified), returning boolean values for each.Create an account
Create an account
Creates a new account, with specified offering, under the organization.
Create a campaign
Create a campaign
This endpoint enables campaign creation, requiring a subject, sender id, content (html and text suggested), and a list or segment id for sending or scheduling, but not for initial creation.
Create a list
Create a list
this endpoint allows you to create a list for your recipients.
Create a branded link
Create a branded link
Create a new branded link by specifying the root domain, which must align with your from email, and an optional unique subdomain. subusers can request using the
on-behalf-of header.Create a custom field
Create a custom field
this endpoint allows you to create a custom field. you can create up to 120 custom fields.
Create api keys
Create api keys
Use sendgrid app to create an initial api key; then manage others via api. json with ‘name’ required; 100 key limit. keys have unique ids, default ‘full access’ unless scopes specified. update scopes with ‘update api keys’ endpoint.
Create an sso teammate
Create an sso teammate
Create an sso teammate with email as username. assign roles using
is admin, scopes, or persona. admins have full rights, personas have predefined permissions, and scopes are specific rights. teammates can manage subusers with potential limitations.Create a new alert
Create a new alert
this endpoint allows you to create a new alert.
Create a new suppression group
Create a new suppression group
this endpoint allows you to create a new suppression group. to add an email address to the suppression group, create a suppression.
Create a new event webhook
Create a new event webhook
Set up an event webhook by providing a url, choosing events for post requests, and receive a unique id. after creation, you can add names, oauth, and signature verification.
Create a segment
Create a segment
New segment endpoint created: supports various operators for date, text, number, and email fields. values must be strings, can specify campaign for email actions. conditions combinable via “and”/“or”.
Create a new transactional template version
Create a new transactional template version
this endpoint allows you to create a new version of a template.
Sendgrid Create Integration
Sendgrid Create Integration
This endpoint creates an integration for email event forwarding. each integration has a maximum number of allowed integration instances per user. for example, users can create up to 10 segment integrations.
Create a sender identity
Create a sender identity
this endpoint allows you to create a new sender identity. you may create up to 100 unique sender identities.
Create design
Create design
Create new designs via
/designs by submitting html content. consider email client limitations and see the guide for best practices. convert html to editable modules in the design library, or use preferred tools/migrate existing designs.Create a parse setting
Create a parse setting
Create a new inbound parse setting with a twilio sendgrid authenticated
hostname and a public url to receive parsed messages via http post. complete domain authentication and mx record setup as instructed in sendgrid documentation.Create a transactional template
Create a transactional template
this endpoint allows you to create a transactional template.
Delete an account
Delete an account
To delete an organization’s account by id: it revokes api keys/sso, removes sendgrid resources like dedicated ips, and stops billing immediately. this action is irreversible.
Delete ip pool
Delete ip pool
This operation deletes an ip pool and unassigns all ip addresses associated with the pool. ip addresses associated with the deleted pool will remain in your account.
Delete a single event webhook by id
Delete a single event webhook by id
Delete a specific event webhook by id with this endpoint. unlike other endpoints which default to the oldest webhook, this requires an id, else it errors to prevent accidental deletions. to disable, not delete, use
enabled property to false.Delete a campaign
Delete a campaign
this endpoint allows you to delete a specific campaign.
Delete a sender identity
Delete a sender identity
this endpoint allows you to delete one of your sender identities.
Delete a cancellation or pause from a scheduled send
Delete a cancellation or pause from a scheduled send
this endpoint allows you to delete the cancellation/pause of a scheduled send. scheduled sends cancelled less than 10 minutes before the scheduled time are not guaranteed to be cancelled.
Delete a single recipient from a single list
Delete a single recipient from a single list
this endpoint allows you to delete a single recipient from a list.
Create a sender
Create a sender
This api endpoint is for creating new senders, with a limit of 100. verification is mandatory, either automatic upon domain authentication or via a confirmation email sent to the sender’s address.
Create subuser
Create subuser
this endpoint allows you to create a new subuser.
Create verified sender request
Create verified sender request
This endpoint creates a new sender identity via
post, sends a verification email to from email, and requires email verification. to resend, use /resend/\{id\}. for domain authentication, refer to the domain authentication api.Deny access request
Deny access request
this endpoint allows you to deny an attempt to access your account. note: only teammate admins may delete a teammate’s access request.
Delete blocks
Delete blocks
This endpoint enables clearing blocked emails either by deleting all with
delete all=true or by specifying addresses in the emails array.Delete bounces
Delete bounces
This api endpoint lets users delete bounced emails: either all by setting
delete all to true, or specific ones by listing them in emails. do not use both options together.Delete invalid emails
Delete invalid emails
This endpoint lets you delete email addresses from your invalid list; delete all by setting
delete all to true, or specify individual addresses to remove.Delete teammate
Delete teammate
this endpoint allows you to delete a teammate. only the parent user or an admin teammate can delete another teammate.
Edit a transactional template
Edit a transactional template
This endpoint lets you change the name of a transactional template. for template modifications, create a new version using the provided link.
Delete an alert
Delete an alert
this endpoint allows you to delete an alert.
Delete verified sender
Delete verified sender
Use this endpoint with a sender identity’s
id to remove it from your account. find sender identity ids through the “get all verified senders” endpoint.Disassociate an authenticated domain from a given user
Disassociate an authenticated domain from a given user
This endpoint removes an authenticated domain from a subuser that was previously assigned by a parent account, used for sending emails under the parent’s domain.
Duplicate sendgrid pre built design
Duplicate sendgrid pre built design
The endpoint lets you duplicate twilio sendgrid pre-built designs without data. if unnamed, “duplicate:” precedes the original name. the copy gets a unique id, modifiable upon creation. use “list sendgrid pre-built designs” for ids.
Create list
Create list
This endpoint enables the creation of a new contacts list, which can automate email sending when new contacts are added. a link to the new list is provided in
metadata.Duplicate single send
Duplicate single send
This endpoint duplicates single sends using an id for easy creation, allowing edits via patch. duplicates are named as “copy of” the original, with a 100-character limit for names.
Duplicate design
Duplicate design
This endpoint duplicates existing designs without requiring data in the request body. if you don’t specify a
name, it’s labeled “duplicate:” plus the original’s name, but you can set a new name upon creation. each copy gets a unique id.Delete an authenticated domain
Delete an authenticated domain
this endpoint allows you to delete an authenticated domain.
Create custom field definition
Create custom field definition
Create unique case-insensitive custom fields with alphanumeric/underscore names starting with a letter/underscore. save the id for edits/deletes. limited to 500 fields of type date, text, or number. avoid starting with numbers to prevent campaign issues.
Delete a transactional template version
Delete a transactional template version
this endpoint allows you to delete a transactional template version.
Disassociate a branded link from a subuser
Disassociate a branded link from a subuser
The endpoint permits parent accounts to remove a branded link from a subuser, with successful disassociations confirmed by a 204 status code response.
Delete a contact identifier
Delete a contact identifier
This endpoint asynchronously deletes an identifier (not the entire contact) from a contact, failing if it’s their only one. allowed identifier types are email, phonenumberid, externalid, or anonymousid.
Edit a transactional template version
Edit a transactional template version
this endpoint allows you to edit the content of your template version.
Export contacts
Export contacts
Use the endpoint to export contact lists or segments by email, with notifications, or download as csvs using an ‘id’. specify the data by id and choose json or csv output with a max file size option.
Delete a specific block
Delete a specific block
this endpoint allows you to delete a specific email address from your blocks list.
Sendgrid Delete Bulk Integration
Sendgrid Delete Bulk Integration
This endpoint deletes integrations.
Erase recipients email data
Erase recipients email data
Sendgrid’s delete recipients’ email data operation removes personal data of up to 5,000 unique email recipients or a 256kb payload per request. invalid emails return an error, and deletions are account-specific, not affecting subusers.
Domain warn list
Domain warn list
The endpoint provides a list of domains with dmarc, divided by how they fail (hard or soft). hard failures prevent mail delivery using those domains as sender identities. for more on dmarc, visit sendgrid’s guide.
Delete a custom field
Delete a custom field
this endpoint allows you to delete a custom field by id.
Email dns records to a co worker
Email dns records to a co worker
Use sendgrid for domain validation and branding by sharing dns records—cname for automated security, or txt/mx otherwise. include
link id for link branding and domain id for domain auth.Edit an sso teammate
Edit an sso teammate
This endpoint allows admin or parent users to adjust sso teammate permissions using ‘is admin’, ‘scopes’, or ‘persona’, and to control subuser access, including restrictions.
Export single send stats
Export single send stats
This endpoint exports single send stats in .csv format, allowing specification of multiple single sends by separating their ids with commas in the
ids parameter.Delete contacts
Delete contacts
Use this endpoint to bulk delete contacts with
ids as a list of ids or delete all contacts set to "true" for all. deletions are asynchronous. regularly export contacts as a backup.Filter messages by message id
Filter messages by message id
Get all of the details about the specified message.
Enable disable website access for a subuser
Enable disable website access for a subuser
Enable/disable website access for a subuser, while still preserving email send functionality.
Delete an ip pool
Delete an ip pool
this endpoint allows you to delete an ip pool.
Delete an sso certificate
Delete an sso certificate
this endpoint allows you to delete an sso certificate. you can retrieve a certificate’s id from the response provided by the “get all sso integrations” endpoint.
Enable disable a subuser
Enable disable a subuser
this endpoint allows you to enable or disable a subuser.
Delete a specific spam report
Delete a specific spam report
This endpoint removes a spam report for an email, lifting suppression and allowing email to be sent to that address. use with caution and recipient consent, or use bypass filters for exceptions.
Delete a specific invalid email
Delete a specific invalid email
this endpoint allows you to remove a specific email address from the invalid email address list.
Get all automation stats
Get all automation stats
Retrieve all your automation stats by default or specify with ‘automation ids’. results are paginated with customizable ‘page size’ (1-50, default 25) and ‘page token’ for specific pages.
Filter all messages
Filter all messages
Summarize email activity filtering: use url-encoded queries in the format
query=\{type\}="\{content\}" to search email activity. example: filter by email with query=to email%3d"example@example.com". reference more at sendgrid query reference.Delete segment
Delete segment
this endpoint allows you to delete a segment by id.
Sendgrid Filter Segments By Parent Ids
Sendgrid Filter Segments By Parent Ids
Retrieve segments using
parent list ids as a filter. an empty or unmatched query returns an empty result with a 200 code. filters combine parent list ids and the absence or presence of no parent list id with segment ids.Delete a global suppression
Delete a global suppression
This endpoint removes an email from suppressions, allowing future emails to be sent to it. use with consent or bypass filters for one-off emails.
Get all field definitions
Get all field definitions
this endpoint retrieves all defined custom fields and reserved fields.
Delete custom field definition
Delete custom field definition
this endpoint deletes a defined custom field. you can delete only custom fields; reserved fields cannot be deleted.
Get all accounts
Get all accounts
Retrieves all accounts under the organization.
Delete an sso integration
Delete an sso integration
this endpoint allows you to delete an idp configuration by id. you can retrieve the ids for your configurations from the response provided by the “get all sso integrations” endpoint.
Delete pending teammate
Delete pending teammate
this endpoint allows you to delete a pending teammate invite.
Get all available offerings
Get all available offerings
Retrieves offerings available under the organization.
Get account offerings
Get account offerings
Retrieves offering information about the specified account.
Get all categories
Get all categories
this endpoint allows you to retrieve all the categories associated with your single sends. this endpoint will return your latest 1,000 categories.
Get all ip pools that have associated ips
Get all ip pools that have associated ips
The function lists your ip pools and samples up to 10 ips from each. for more ips per pool, use “get ips assigned to an ip pool.” max of 100 ip pools per user.
Get all existing exports
Get all existing exports
This endpoint provides an array with details on active or completed export jobs. each object includes
export type, status, and downloadable urls for ready exports. useful when export ids are unknown.Get all sender identities
Get all sender identities
this endpoint allows you to retrieve a list of all sender identities that have been created for your account.
Delete a list
Delete a list
this endpoint allows you to delete a specific recipient list with the given id.
Get all lists
Get all lists
this endpoint returns an array of all of your contact lists.
Get all single sends
Get all single sends
Retrieve a list of your single sends with brief details, including their ids. for in-depth information on a specific single send, use its id at the
/marketing/singlesends/\{id\} endpoint.Delete single send by id
Delete single send by id
This endpoint lets you delete a single send with its id, which you can obtain by a get request to
/marketing/singlensends. note: deletion is irreversible.Edit verified sender
Edit verified sender
Update a sender identity by sending a
patch request with the id and json-formatted changes. unchanged fields will stay the same. retrieve ids via get to /verified senders.Get all single sends stats
Get all single sends stats
Retrieve single sends stats with options for filtering by ids, pagination, and custom page sizes from 1-50. default response batch is 25.
Delete design
Delete design
this endpoint allows you to delete a single design. be sure to check the id of the design you intend to delete before making this request; deleting a design is a permanent action.
Get all sso integrations
Get all sso integrations
this endpoint allows you to retrieve all sso integrations tied to your twilio sendgrid account. the ids returned by this endpoint can be used by the apis additional endpoints to modify your sso integrations.
Get all sso certificates by integration
Get all sso certificates by integration
this endpoint allows you to retrieve all your idp configurations by configuration id. the
integration id expected by this endpoint is the id returned in the response by the “get all sso integrations” endpoint.Download csv
Download csv
this endpoint will return a presigned url that can be used to download the csv that was requested from the “request a csv” endpoint.
Delete a recipient
Delete a recipient
this endpoint allows you to delete a single recipient with the given id from your contact database. > use this to permanently delete your recipients from all of your contact lists and all segments if required by applicable law.
Delete api keys
Delete api keys
this endpoint allows you to revoke an existing api key using an
api key id authentications using a revoked api key will fail after after some small propogation delay. if the api key id does not exist, a 404 status will be returned.Delete single send schedule
Delete single send schedule
Cancel a scheduled single send by making a delete request with its id to the endpoint. this action doesn’t delete the single send content, only stops the send-out.
Export contacts status
Export contacts status
Use this endpoint with an
id from “export contacts” to check the status and get urls for downloading your csv contact export files. regular exports are recommended for backups.Delete a reverse dns record
Delete a reverse dns record
This endpoint deletes a reverse dns record, returning a 204 code on success. retrieve record ids using the “retrieve all reverse dns records” endpoint.
Delete a subuser
Delete a subuser
this endpoint allows you to delete a subuser. this is a permanent action. once deleted, a subuser cannot be retrieved.
Duplicate a transactional template
Duplicate a transactional template
this endpoint allows you to duplicate a transactional template.
Delete a batch of ips from an ip pool
Delete a batch of ips from an ip pool
This operation removes a batch of ips from an ip pool. all ips associated with the pool will be unassigned from the deleted pool. however, this operation does not remove the ips from your account.
Delete a bounce
Delete a bounce
this endpoint allows you to remove an email address from your bounce list.
Delete spam reports
Delete spam reports
This endpoint lets users delete spam reports, lifting email suppression for specified addresses. it’s advised only when recipients want to resume emails. two deletion methods: ‘delete all’ or listing emails. use ‘bypass filters’ for exceptions.
Delete a batch of subusers from an ip
Delete a batch of subusers from an ip
This operation removes a batch of subusers from a specified ip address.
Delete a parse setting
Delete a parse setting
this endpoint allows you to delete a specific inbound parse setting by hostname. you can retrieve all your inbound parse settings and their associated host names with the “retrieve all parse settings” endpoint.
Delete a segment
Delete a segment
this endpoint allows you to delete a segment from your recipients database. you also have the option to delete all the contacts from your marketing campaigns recipient database who were in this segment.
Delete a suppression from a suppression group
Delete a suppression from a suppression group
This endpoint removes an email from a suppression group, re-enabling email delivery unless specified otherwise, and should only be used when recipients opt back in.
Get all verified senders
Get all verified senders
Retrieve all sender identities (verified/unverified) for an account via an endpoint. customize results using
limit, lastseenid, and id parameters to define the results scope.Delete a branded link
Delete a branded link
Delete a branded link using this endpoint; successful deletion returns a 204 status. record link details beforehand as they’re not provided. subuser deletions are possible with their id in the header.
Delete a template
Delete a template
this endpoint allows you to delete a transactional template.
Create segment
Create segment
Segment
name has to be unique. a user can not create a new segment with an existing segment name.Delete a sender
Delete a sender
this endpoint allows you to delete an existing sender.
Create single send
Create single send
The endpoint lets you create a single send draft without needing a template id; it now uses
email config. a set send at doesn’t schedule it; it must be done through another endpoint or ui.Delete a suppression group
Delete a suppression group
This api endpoint deletes email suppression groups. deleted group members get globally suppressed if they unsubscribe. use with caution, only if recipients want to resubscribe. bypass filters available for exceptions.
Get an sso certificate
Get an sso certificate
this endpoint allows you to retrieve an individual sso certificate.
Get an account s state
Get an account s state
Retrieve the state of the specified account.
Get a contact by id
Get a contact by id
this endpoint returns the full details and all fields for the specified contact. the “get contacts by identifier” endpoint can be used to get the id of a contact.
Remove list and optional contacts
Remove list and optional contacts
this endpoint allows you to deletes a specific list. optionally, you can also delete contacts associated to the list. the query parameter,
delete contacts=true, will delete the list and start an asynchronous job to delete associated contacts.List sendgrid pre built designs
List sendgrid pre built designs
The
designs/pre-builts endpoint fetches a list of twilio sendgrid’s ready-made designs, not user-specific ones, with 100 results per request by default, adjustable with page size. useful for duplicating and editing design ids.Get single sends search
Get single sends search
Search for single sends by specifying
name, status, and categories in the request body. example provided for drafts or scheduled items related to “shoes”.Get a list of subusers assigned to an ip
Get a list of subusers assigned to an ip
The api lists subuser ids with a specific ip, retrieves up to 100 per request, and iterates with
after key for more. use subusers api for details.Get a list of all senders
Get a list of all senders
this endpoint allows you to get a list of all your senders.
Get automation click tracking stats by id
Get automation click tracking stats by id
this endpoint lets you retrieve click-tracking stats for a single automation. the stats returned list the urls embedded in your automation and the number of clicks each one received.
Get automation stats by id
Get automation stats by id
Retrieve detailed stats for a specific automation by id, with optional date and aggregation filters, or use another endpoint to get stats for multiple automations.
Get information on a single suppression group
Get information on a single suppression group
this endpoint allows you to retrieve a single suppression group.
Get an sso integration
Get an sso integration
this endpoint allows you to retrieve an sso integration by id. you can retrieve the ids for your configurations from the response provided by the “get all sso integrations” endpoint.
Sendgrid Get Integration
Sendgrid Get Integration
This endpoint returns the data for a specific integration.
Sendgrid List Integration
Sendgrid List Integration
This endpoint returns all the integrations for the user making this call.
List the authenticated domain associated with the given user
List the authenticated domain associated with the given user
Parent accounts can link validated domains to subusers through an endpoint, allowing subusers to email from those domains. the api supports multiple domain associations and listings.
Get total contact count
Get total contact count
this endpoint returns the total number of contacts you have stored. twilio sendgrid recommends exporting your contacts regularly as a backup to avoid issues or lost data.
Get signed event webhook s public key
Get signed event webhook s public key
Retrieve a webhook’s public key using its id via this endpoint; if no id is given, the oldest key is returned. useful for signature verification and toggling signature settings. multiple ids can be found using the “get all event webhooks” endpoint.
Remove one or more ips from the allow list
Remove one or more ips from the allow list
This endpoint lets you remove ips from your allowed list by sending an array of their ids, obtained from another endpoint. carefully select ips to avoid blocking your account access. if blocked, submit a support ticket.
Get a specific sender
Get a specific sender
this endpoint allows you to get the details for a specific sender by
id.Rename an ip pool
Rename an ip pool
this endpoint allows you to update the name of an ip pool.
Get single send by id
Get single send by id
this endpoint allows you to retrieve details about one single send using a single send id. you can retrieve all of your single sends by making a get request to the
/marketing/singlesends endpoint.Remove segment without affecting contacts
Remove segment without affecting contacts
This endpoint permits the deletion of a segment using
segment id, but associated contacts remain in the overall list and any other segments they’re part of.Request csv
Request csv
Initiating a backend process creates a csv file of up to 1 million events from the last 30 days, emailed to the user with a 3-day expiry link. limited to one request per 12 hours, it’s similar to the get single message but for csv downloads.
Get ips assigned to an ip pool
Get ips assigned to an ip pool
This operation returns the ip addresses that are assigned to the specified ip pool.
Get single send click tracking stats by id
Get single send click tracking stats by id
this endpoint lets you retrieve click-tracking stats for one single send. the stats returned list the urls embedded in the specified single send and the number of clicks each one received.
Get a list by id
Get a list by id
This endpoint fetches detailed information on a list. using
contact sample=true includes up to 50 recent contacts and the total contact count in the response.Resend a sender verification
Resend a sender verification
this endpoint allows you to resend the verification request for a specific sender.
Manually refresh a segment
Manually refresh a segment
Manually refresh a segment by segment id.
Import contacts
Import contacts
The endpoint permits async csv uploads for up to 1m contacts or 5gb with specified identifiers and file type, supports gzip, field mappings, uses job id for tracking, and recommends regular backups.
Retrieve all assigned ips
Retrieve all assigned ips
This api endpoint retrieves assigned ip addresses used to send emails for various domains, where the ip’s reputation is influenced by the collective performance of all sending users.
Retrieve address whitelist mail settings
Retrieve address whitelist mail settings
This endpoint lets you access settings for whitelisting specific emails or domains to prevent email suppression due to bounces, blocks, or unsubscribes.
Import contacts status
Import contacts status
Check the status of contact import jobs using
job id via this endpoint. it shows if the job is pending, completed, errored, or failed. for errors, download the errors url file. regular contact exports are advised for backup.Retrieve all api keys belonging to the authenticated user
Retrieve all api keys belonging to the authenticated user
Retrieve user’s api key names and ids with this endpoint; keys themself cannot be retrieved for security. lost keys require recreation. use ‘api key id’ to manage keys.
Resend sender identity verification
Resend sender identity verification
this endpoint allows you to resend a sender identity verification email.
Presigned url headers for bulk email validation
Presigned url headers for bulk email validation
Get a presigned url and headers to upload an email list for verification. ensure the ‘content-type’ matches ‘file type’ in the ‘put’ request. visit the bulk validation overview page for format and sample request.
Retrieve all ips currently in warmup
Retrieve all ips currently in warmup
this endpoint allows you to retrieve all of your ip addresses that are currently warming up.
Resend teammate invite
Resend teammate invite
this endpoint allows you to resend a teammate invitation. teammate invitations will expire after 7 days. resending an invitation will reset the expiration date.
Retrieve all custom fields
Retrieve all custom fields
this endpoint allows you to retrieve all custom fields.
Retrieve all blocks
Retrieve all blocks
Retrieve a paginated list of blocked emails using this endpoint, with adjustable page sizes via the ‘limit’ parameter and starting points with ‘offset’ for multiple requests.
Retrieve all invalid emails
Retrieve all invalid emails
Retrieve paginated lists of invalid emails with ‘limit’ for page size and ‘offset’ to start from a specific position for lists exceeding the limit.
Retrieve all global suppressions
Retrieve all global suppressions
Retrieve paginated lists of globally suppressed emails using
limit for page size and offset to start from a specific list position. multiple requests may be needed for large lists.Retrieve all categories
Retrieve all categories
This endpoint provides a paginated list of user categories, with adjustable page size using the
limit and pagination control using offset. multiple requests are needed for large lists.Remove an ip address from a pool
Remove an ip address from a pool
this endpoint allows you to remove an ip address from an ip pool.
Retrieve all ip pools an ip address belongs to
Retrieve all ip pools an ip address belongs to
This endpoint checks which ip pools contain a specific ip, which may be shared across multiple ip pools and affect the ip’s reputation based on collective usage for email sending.
Invite teammate
Invite teammate
Invite teammates to your account through email with this endpoint, assigning initial permissions via the
scopes array. invites expire after 7 days but can be resent.Get list contact count
Get list contact count
this endpoint returns the number of contacts on a specific list.
Retrieve all ip pools
Retrieve all ip pools
this endpoint allows you to get all of your ip pools.
Retrieve all ip addresses
Retrieve all ip addresses
Retrieve a paginated list of assigned/unassigned ips with warmup status, pools, subusers, and dns info. ip reputation is based on email traffic. use
limit and offset parameters to control pagination.Resend verified sender request
Resend verified sender request
This endpoint resends a verification email to a sender identity’s ‘from address’ by using the ‘id’ of the sender. useful if the original email is lost or needs to be resent. retrieve ids via “get all verified senders” endpoint.
Get single send stats by id
Get single send stats by id
Retrieve individual single send stats using its id. for multiple ids, use “get all single sends stats”. filter results by date or refine with
group by and aggregated by parameters.Retrieve all bounces
Retrieve all bounces
This endpoint retrieves a paginated list of all your bounces, allowing customization of page size with
limit and starting position with offset for multiple requests.Retrieve all lists
Retrieve all lists
this endpoint allows you to retrieve all of your recipient lists. if you don’t have any lists, an empty array will be returned.
Get subusers engagement quality scores
Get subusers engagement quality scores
Retrieve seq scores for sendgrid subusers/accounts on a specific date; expect ‘200’ with scores or ‘202’ if unavailable yet, possibly accessible later. scores range from 1-5, with higher numbers indicating better engagement.
Retrieve all of your event webhooks
Retrieve all of your event webhooks
The endpoint fetches all event webhooks as objects in an array, showing each webhook’s configuration and id, used to update, delete, or manage signature verification and oauth settings.
Retrieve all mail settings
Retrieve all mail settings
Retrieve a paginated list of mail settings with their
enabled status and descriptions. control page size with limit and list position with offset for multiple requests.Get list of segments
Get list of segments
The api endpoint retrieves segments, using
parent list ids to filter results. if no matches are found, a 200 code with an empty array is returned. filters include list ids, absence of parent ids, or specific segment ids.Remove an ip from an authenticated domain
Remove an ip from an authenticated domain
this endpoint allows you to remove an ip address from that domain’s authentication.
List all authenticated domains
List all authenticated domains
Retrieve authenticated domain lists in pages using the
limit parameter for page size and offset to start from specific list positions. multiple requests handle large lists.Retrieves inbound parse webhook statistics
Retrieves inbound parse webhook statistics
Sendgrid’s inbound parse webhook parses incoming emails, up to 30mb, and posts to a specified url, with available integrations listed in their library index.
Retrieve all branded links
Retrieve all branded links
this endpoint allows you to retrieve all branded links. you can submit this request as one of your subusers if you include their id in the
on-behalf-of header in the request.Retrieve all pending teammates
Retrieve all pending teammates
this endpoint allows you to retrieve a list of all pending teammate invitations. each teammate invitation is valid for 7 days. users may resend the invitation to refresh the expiration date.
Retrieve all parse settings
Retrieve all parse settings
this endpoint allows you to retrieve all of your current inbound parse settings.
Get a user s account information
Get a user s account information
this endpoint allows you to retrieve your user account details. your user’s account information includes the user’s account type and reputation.
Get teammate subuser access
Get teammate subuser access
Retrieve subusers accessible to a specified teammate, with available scopes. admin teammates get access to all subusers.
Get open tracking settings
Get open tracking settings
The endpoint retrieves settings for tracking email opens using an invisible image. it logs open events when images load, with data available in sendgrid’s statistics portal and event webhook.
Retrieve all reverse dns records
Retrieve all reverse dns records
The endpoint provides a paginated list of reverse dns records, with optional ip prefix search and adjustable page size using ‘limit’ and ‘offset’ parameters.
Retrieve all recent access attempts
Retrieve all recent access attempts
this endpoint allows you to retrieve a list of all of the ip addresses that recently attempted to access your account either through the user interface or the api.
Retrieve all recipients on a list
Retrieve all recipients on a list
this endpoint allows you to retrieve all recipients on the list with the given id.
Retrieve all segments
Retrieve all segments
this endpoint allows you to retrieve all of your segments.
Retrieve all scheduled sends
Retrieve all scheduled sends
The endpoint provides details of cancelled or paused scheduled sends but only if they have a
batch id. sends scheduled without a batch id via /mail/send won’t be listed and can’t be paused or cancelled later through this endpoint.Retrieve all suppressions
Retrieve all suppressions
this endpoint allows you to retrieve a list of all suppressions.
Get a user s profile
Get a user s profile
this endpoint allows you to retrieve your current profile details.
Retrieve all spam reports
Retrieve all spam reports
Retrieve spam reports in pages using
limit for page size and offset to continue from a specific list position. multiple requests handle larger lists.Get the credits for a subuser
Get the credits for a subuser
this endpoint allows you to retrieve a credits overview for a subuser.
Remove a specific ip from the allowed list
Remove a specific ip from the allowed list
This endpoint lets you delete an allowed ip address using its id, obtainable via the “retrieve allowed ips” endpoint.
Retrieve access requests
Retrieve access requests
Retrieve a list of recent access requests using pagination with
limit for page size and offset to control the start position for additional items.Retrieve all suppressions for a suppression group
Retrieve all suppressions for a suppression group
this endpoint allows you to retrieve all suppressed email addresses belonging to the given group.
Get recipient upload status
Get recipient upload status
this endpoint allows you to check the upload status of a marketing campaigns recipient.
Retrieve all campaigns
Retrieve all campaigns
Retrieve a paginated list of campaigns in reverse creation order with the api endpoint. if none exist, get an empty array. adjust page size with
limit, and fetch more with offset.Retrieve all suppression groups associated with the user
Retrieve all suppression groups associated with the user
This endpoint provides a list of user-created suppression groups and can return info for multiple groups when their ids are added to the request with
?id=123456.Get remaining ips count
Get remaining ips count
this endpoint gets amount of ip addresses that can still be created during a given period and the price of those ips.
Retrieve all suppression groups for an email address
Retrieve all suppression groups for an email address
this endpoint returns a list of all groups from which the given email address has been unsubscribed.
Retrieve all teammates
Retrieve all teammates
Retrieve a paginated list of teammates with the
limit parameter to set page size and offset to specify the starting point for additional items. make multiple requests if needed.Remove contacts from a list
Remove contacts from a list
this endpoint allows you to remove contacts from a given list. the contacts will not be deleted. only their list membership will be changed.
Get batched contacts by ids
Get batched contacts by ids
This endpoint fetches multiple contacts using their ids, allowing up to 100 ids per request for efficiency over single
get requests. regular export of contacts is advised for backup.Get sample contacts
Get sample contacts
The endpoint returns the latest 50 contacts, sorted by email, with the total count included. pagination is deprecated; regular export of contacts is advised.
Get details for an ip address
Get details for an ip address
The operation provides details for an ip address, such as its parent account status, warm-up settings, associated pools, add/modify dates, lease status, and enablement, excluding subuser info, which requires a different endpoint.
Get contacts by identifiers
Get contacts by identifiers
Use the endpoint to fetch up to 100 contacts by identifiers (email, phone number, etc.). successful queries return 200, no results return 404, and errors return 400. regular backups are advised.
Get the default authentication
Get the default authentication
This endpoint fetches the default domain authentication, used for sending all mail unless overridden by a ‘from’ address match. it provides domain details if a default is set; otherwise, it gives general authentication info.
Get contacts by emails
Get contacts by emails
Endpoint retrieves up to 100 contacts by email, ignoring case/space; simpler than sgql’s search. success returns
200, 404 for no match, 400 for invalid emails. regular contact backups recommended.Get sendgrid pre built design
Get sendgrid pre built design
The endpoint
/designs/pre-builts/\{id\} is used to fetch details about a particular pre-built design for duplication and modification.List Bulk Email Validation Jobs
List Bulk Email Validation Jobs
this endpoint returns a list of all of a user’s bulk email validation jobs.
Get the settings for a single event webhook
Get the settings for a single event webhook
Retrieve an event webhook by id to get settings, event types, and url details. without id, the oldest is returned. signatures and oauth webhooks have extra properties. use another endpoint for multiple webhook ids.
Get a list of all ip addresses on your account
Get a list of all ip addresses on your account
Fetches your account’s ip addresses with details such as pool association and warm-up status. ‘is parent assigned’ and ‘pool’ must be exclusive. pagination needs ‘limit’ and ‘before key’ or ‘after key’.
Get engagement quality scores
Get engagement quality scores
Retrieve your sendgrid engagement quality (seq) scores via api for a chosen date range. get a
200 response for available scores, or a 202 if scores haven’t been calculated yet. scores range from 1 to 5, higher indicating better engagement.Get details for an ip pool
Get details for an ip pool
This operation retrieves details of an ip pool, such as name, id, some sample ips (up to 10), and the total ip count. for more ips, use “get ips assigned to an ip pool.”
List all subusers
List all subusers
Retrieve a paginated list of subusers with filtering options. use
username to filter, limit to set page size, and offset to navigate through the list.Get design
Get design
Access a specific design’s details in your design library with a get request to
/designs/\{id\}. this endpoint is useful for obtaining info to update via patch request.List designs
List designs
The
/designs endpoint fetches a list of user’s stored designs, restricted to 100 per request by default but adjustable with page size. pre-built designs are at /designs/pre-builts.Get segment by id
Get segment by id
Get marketing campaigns segment by id
Retrieve click track settings
Retrieve click track settings
This endpoint retrieves your click tracking settings in sendgrid which tracks user engagement by redirecting and monitoring clicks on up to 1000 links per email.
Retrieve a count of recipients
Retrieve a count of recipients
this endpoint allows you to retrieve the total number of marketing campaigns recipients.
Retrieve a specific alert
Retrieve a specific alert
this endpoint allows you to retrieve a specific alert.
Retrieve forward spam mail settings
Retrieve forward spam mail settings
This endpoint retrieves current forward spam settings, listing specified email addresses receiving spam reports and showing if the feature is active.
Retrieve a bounce
Retrieve a bounce
this endpoint allows you to retrieve a specific bounce by email address.
Retrieve a list of currently allowed ips
Retrieve a list of currently allowed ips
This endpoint provides a list of authorized ip addresses for your account, each with creation, update dates, and a unique id for potential removal.
Retrieve a global suppression
Retrieve a global suppression
This endpoint retrieves global email suppressions and confirms if an email is suppressed. if suppressed, the email is returned in the response; if not, an empty json object is returned.
Retrieve all the ips in a specified pool
Retrieve all the ips in a specified pool
this endpoint allows you to get all of the ip addresses that are in a specific ip pool.
Retrieve current enforced tls settings
Retrieve current enforced tls settings
This endpoint retrieves enforced tls settings that mandate recipients to support tls 1.1+ or have a valid certificate. if not met, messages are dropped with a “tls required but not supported” block event.
Retrieve a reverse dns record
Retrieve a reverse dns record
this endpoint allows you to retrieve a reverse dns record. you can retrieve the ids associated with all your reverse dns records using the “retrieve all reverse dns records” endpoint.
Retrieve a custom field
Retrieve a custom field
this endpoint allows you to retrieve a custom field by id.
Retrieve an authenticated domain
Retrieve an authenticated domain
this endpoint allows you to retrieve a specific authenticated domain.
Retrieve an existing api key
Retrieve an existing api key
Retrieve an api key’s details with its id via this endpoint. nonexistent keys yield a 404 error. key scopes can be modified later. refer to the documentation for scope details.
Retrieve a segment
Retrieve a segment
this endpoint allows you to retrieve a single segment with the given id.
Retrieve global email statistics
Retrieve global email statistics
Retrieve your global email stats within a specific date range, with parent accounts viewing their own or a subuser’s aggregated data via the
on-behalf-of header, while subusers see only their stats.Retrieve a single transactional template
Retrieve a single transactional template
this endpoint allows you to retrieve a single transactional template.
Retrieve a list of scopes for which this user has access
Retrieve a list of scopes for which this user has access
This api endpoint lists all accessible scopes for the user’s api key, with permissions determining endpoint access. visit sendgrid documentation for more on api key permissions.
Retrieve a single campaign
Retrieve a single campaign
this endpoint allows you to retrieve a specific campaign.
Retrieve email statistics by browser
Retrieve email statistics by browser
Retrieve email stats by browser with advanced stats api, storing 7 days of data, and defaulting to 500 items per request. segment by location, device, and more. visit provided link for details.
Retrieve google analytics settings
Retrieve google analytics settings
Retrieve your google analytics settings, which are set to google’s recommended defaults, to understand user site activity. for details, use google’s guides and best practices links.
Retrieve legacy template mail settings
Retrieve legacy template mail settings
The endpoint retrieves settings for original email templates, with a guide for using and migrating from legacy to newer dynamic transactional templates.
Retrieve a specific block
Retrieve a specific block
this endpoint allows you to retrieve a specific email address from your blocks list.
Retrieve your account email address
Retrieve your account email address
this endpoint allows you to retrieve the email address currently on file for your account.
Retrieve recipients
Retrieve recipients
Retrieve all marketing campaign recipients via this endpoint. use batch deletion carefully, as it may lead to empty pages. continue iterating pages until a 404 error occurs to ensure complete retrieval.
Retrieve paged transactional templates
Retrieve paged transactional templates
this endpoint allows you to retrieve all transactional templates.
Retrieve user s authenticated domains
Retrieve user s authenticated domains
The api endpoint allows subusers to fetch up to five domains verified by the main account for sending emails, with a defined order of domain selection.
Retrieve a single list
Retrieve a single list
this endpoint allows you to retrieve a single recipient list.
Retrieve monthly stats for all subusers
Retrieve monthly stats for all subusers
Retrieve monthly subuser email stats for a date range but can’t sort by metrics like bounce drops, deferred, invalid emails, processed, spam reports, or unsubscribe drops.
Retrieve subuser reputations
Retrieve subuser reputations
This endpoint provides sender reputation scores for subusers, reflecting their email performance based on recipient responses and negative actions like bounces or spam reports.
Retrieve email statistics by client type
Retrieve email statistics by client type
Retrieve email stats by client type with endpoint; stats stored for 7 days, 500 items per request. advanced stats offer detailed insights, segmentable by location, device, and more. visit the provided link for details.
Retrieve the count of billable recipients
Retrieve the count of billable recipients
This endpoint provides the billable count of recipients for marketing campaigns, based on the highest number reached in your account.
Retrieve a specific allowed ip
Retrieve a specific allowed ip
This endpoint retrieves an allowed ip for your account using its id, with ids obtainable from the endpoint listing currently allowed ips.
Retrieve sums of email stats for each category
Retrieve sums of email stats for each category
this endpoint allows you to retrieve the total sum of each email statistic for every category over the given date range. if you do not define any query parameters, this endpoint will return a sum for each category in groups of 10.
Retrieve the default branded link
Retrieve the default branded link
The endpoint retrieves the default branded link for message sending, prioritizing user-set default, legacy, or sendgrid’s default links. subuser requests are possible with id in the header.
Retrieve recipients on a segment
Retrieve recipients on a segment
this endpoint allows you to retrieve all of the recipients in a segment with the given id.
Send a campaign
Send a campaign
this endpoint allows you to immediately send an existing campaign. normally a post request would have a body, but since this endpoint is telling us to send a resource that is already created, a request body is not needed.
Retrieve your username
Retrieve your username
this endpoint allows you to retrieve your current account username.
Retrieve your credit balance
Retrieve your credit balance
This endpoint checks an account’s base email sending credit balance, which affects per-email charges. more details at sendgrid’s billing documentation.
Search recipients
Search recipients
This endpoint searches marketing campaigns recipients. variable ‘field name’ represents custom text fields (url-encoded) or date fields (by unix timestamp) and auto-converts epoch time for ‘reserved’ date fields to a full day range.
Segment json data by specific criteria
Segment json data by specific criteria
Search json data for segments by specifying criteria for dates, text, and campaign ids using operators and boolean logic. optional list ids can refine results. used for email metrics.
Search for suppressions within a group
Search for suppressions within a group
this endpoint allows you to search a suppression group for multiple suppressions. when given a list of email addresses and a group id, this endpoint will only return the email addresses that have been unsubscribed from the given group.
Retrieve a branded link
Retrieve a branded link
this endpoint allows you to retrieve a specific branded link by providing its id. you can submit this request as one of your subusers if you include their id in the
on-behalf-of header in the request.Retrieve a single recipient
Retrieve a single recipient
this endpoint allows you to retrieve a single recipient by id from your contact database.
Singlesend csv stats retrieval
Singlesend csv stats retrieval
Export single send stats in .csv format by specifying one or multiple single send ids in the
ids query string, separated by commas. data is returned as plain text in .csv for flexible use or saving.Set up reverse dns
Set up reverse dns
this endpoint allows you to set up reverse dns.
Send a test campaign
Send a test campaign
this endpoint allows you to send a test campaign. to send to multiple addresses, use an array for the json “to” value [“one@address”,“two@address”]
Retrieve a specific invalid email
Retrieve a specific invalid email
this endpoint allows you to retrieve a specific invalid email addresses.
Retrieve reserved fields
Retrieve reserved fields
this endpoint allows you to list all fields that are reserved and can’t be used for custom field names.
Retrieve email statistics by country and state province
Retrieve email statistics by country and state province
This api endpoint offers detailed email stats by location, with up to 7 days of data stored and 500 items returned per request. more segmentation options are available. see the user guide for details.
Returns a list of all partner settings
Returns a list of all partner settings
Retrieve a paginated list of partner settings using the
limit to set page size and offset to specify the starting point for additional items. multiple requests may be needed for long lists.Retrieve the lists that a recipient is on
Retrieve the lists that a recipient is on
this endpoint allows you to retrieve the lists that a given recipient belongs to. each recipient can be on many lists. this endpoint gives you all of the lists that any one recipient has been added to.
Retrieve scheduled send
Retrieve scheduled send
this endpoint allows you to retrieve the cancel/paused scheduled send information for a specific
batch id.Send a test marketing email
Send a test marketing email
Use the endpoint to test marketing emails with a
template id and up to 10 contacts. requires a from address or sender id. supports only dynamic transactional templates. manage with sendgrid app or api.Stop warming up an ip address
Stop warming up an ip address
This endpoint removes an ip from warmup mode, returning a 204 code if successful. for warmup status details prior to removal, use the “retrieve warmup status” endpoint.
Start warming up an ip address
Start warming up an ip address
this endpoint allows you to put an ip address into warmup mode.
Schedule a campaign
Schedule a campaign
This endpoint schedules campaign emails for a specific time, recommending off-peak times like 10:53 instead of on the hour to minimize server deferrals and enhance delivery rates.
Retrieve the monthly email statistics for a single subuser
Retrieve the monthly email statistics for a single subuser
Retrieve monthly email stats for subusers with
sort by metric, excluding sorts by bounce drops, deferred, invalid emails, processed, spam report drops, spam reports, unsubscribe drops.Toggle signature verification for a single event webhook by id
Toggle signature verification for a single event webhook by id
Toggle signature verification for event webhooks via an endpoint. defaults to the oldest webhook if no id is provided. use boolean ‘enabled’ to set. returns a public key if enabled. retrieve webhook ids and public keys through specific endpoints.
This request returns a single bulk email validation job
This request returns a single bulk email validation job
this endpoint returns a specific bulk email validation job. you can use this endpoint to check on the progress of a job.
Update account offerings
Update account offerings
Updates an account’s package and attaches optional add-ons like marketing campaigns, dedicated ips, and expert services. note: accounts are limited to one package.
Update address whitelist mail settings
Update address whitelist mail settings
Update email whitelist settings by toggling
enabled. use list to replace entries - include all desired. exclude generic domains for can-spam compliance; whitelist bypasses bounces/unsubscribes for included contacts.Update an authenticated domain
Update an authenticated domain
this endpoint allows you to update the settings for an authenticated domain.
Retrieve single segment endpoint
Retrieve single segment endpoint
this endpoint allows you to retrieve a single segment by id.
Update an alert
Update an alert
this endpoint allows you to update an alert.
Retrieve email statistics by device type
Retrieve email statistics by device type
Retrieve email stats by device type with a 7-day data retention limit. the advanced stats api returns 500 items per request. device types include desktop, webmail, phone, tablet, and other. more analytics available at sendgrid’s statistics overview.
Unlink subuser domain
Unlink subuser domain
The endpoint enables removal of an authenticated domain from subusers, each limited to five domains, to allow mail sending under a parent domain.
Retrieve the warmup status for a specific ip address
Retrieve the warmup status for a specific ip address
this endpoint allows you to retrieve the warmup status for a specific ip address. you can retrieve all of your warming ips using the “retrieve all ips currently in warmup” endpoint.
Sendgrid Sum Email Stats For Subusers
Sendgrid Sum Email Stats For Subusers
this endpoint allows you to retrieve the total sums of each email statistic metric for all subusers over the given date range.
Update an ip pool name
Update an ip pool name
This operation will rename an ip pool. an ip pool name cannot start with a dot/period (.) or space.
Update api key name
Update api key name
this endpoint allows you to update the name of an existing api key. you must pass this endpoint a json request body with a
name property, which will be used to rename the key associated with the api key id passed in the url.Update a branded link
Update a branded link
this endpoint allows you to update a specific branded link. you can use this endpoint to change a branded link’s default status. you can submit this request as one of your subusers if you include their id in the
on-behalf-of header in the request.Update a list
Update a list
this endpoint allows you to update the name of one of your recipient lists.
Update a campaign
Update a campaign
this endpoint allows you to update a specific campaign. this is especially useful if you only set up the campaign using post /campaigns, but didn’t set many of the parameters.
Update a parse setting
Update a parse setting
this endpoint allows you to update a specific inbound parse setting by hostname. you can retrieve all your inbound parse settings and their associated host names with the “retrieve all parse settings” endpoint.
Retrieve tracking settings
Retrieve tracking settings
this endpoint allows you to retrieve a list of all tracking settings on your account.
Retrieve a specific parse setting
Retrieve a specific parse setting
this endpoint allows you to retrieve a specific inbound parse setting by hostname. you can retrieve all your inbound parse settings and their associated host names with the “retrieve all parse settings” endpoint.
Retrieve specific teammate
Retrieve specific teammate
this endpoint allows you to retrieve a specific teammate by username. you can retrieve the username’s for each of your teammates using the “retrieve all teammates” endpoint.
Send email with twilio sendgrid
Send email with twilio sendgrid
The mail send operation uses sendgrid’s v3 api to send emails. visit the provided link for an overview, features, limitations, quickstarts, and helper libraries.
Retrieve email statistics by mailbox provider
Retrieve email statistics by mailbox provider
Retrieve email stats by provider with advanced stats api, displaying details like location and device. only 7 days of data stored, 500 items per request. more info at sendgrid’s statistics overview.
Update api key name and scopes
Update api key name and scopes
Update an api key’s name and/or scopes using json with a
name field and scopes array. to change only scopes, reuse the existing name. for just a name update, use another endpoint. see the permissions list for scope options. (https://docs.sendgrid.com)Unschedule a scheduled campaign
Unschedule a scheduled campaign
this endpoint allows you to unschedule a campaign that has already been scheduled to be sent. a successful unschedule will return a 204. if the specified campaign is in the process of being sent, the only option is to cancel (a different method).
Update an sso integration
Update an sso integration
this endpoint allows you to modify an exisiting sso integration. you can retrieve the ids for your configurations from the response provided by the “get all sso integrations” endpoint.
Update a scheduled send
Update a scheduled send
Use this endpoint to change the status of a scheduled send by batch id. status updates fail with a 400 error if previously set with the cancel/pause endpoint.
Update a scheduled campaign
Update a scheduled campaign
this endpoint allows to you change the scheduled time and date for a campaign to be sent.
Test an event webhook s settings
Test an event webhook s settings
The endpoint tests event webhooks by sending a fake event to your url. it has unique retry logic and requires specific oauth properties to test oauth configurations. saved credentials can be retrieved except for
oauth client secret.Retrieve a specific spam report
Retrieve a specific spam report
this endpoint allows you to retrieve a specific spam report by email address.
Retrieve a subuser s branded link
Retrieve a subuser s branded link
Retrieve a subuser’s branded link, created and validated by the parent account, available through the api or twilio sendgrid’s subuser management page.
Retrieve bounce purge mail settings
Retrieve bounce purge mail settings
Retrieve and manage your bounce/purge settings for soft/hard bounce suppression lists with twilio sendgrid, either automatically or manually via the app/api.
Retrieve forward bounce mail settings
Retrieve forward bounce mail settings
This endpoint fetches the current email forwarding settings for bounce messages, including the recipient email and whether the feature is active.
Retrieve footer mail settings
Retrieve footer mail settings
Retrieve email statistics for categories
Retrieve email statistics for categories
this endpoint allows you to retrieve all of your email statistics for each of your categories. if you do not define any query parameters, this endpoint will return a sum for each category in groups of 10.
Retrieve a specific transactional template version
Retrieve a specific transactional template version
this endpoint allows you to retrieve a specific version of a template.
Retrieve subscription tracking settings
Retrieve subscription tracking settings
this endpoint allows you to retrieve your current settings for subscription tracking. subscription tracking adds links to the bottom of your emails that allows your recipients to subscribe to, or unsubscribe from, your emails.
Retrieve stats by a specific client type
Retrieve stats by a specific client type
Use advanced stats api to get email statistics by client type (e.g., phone, desktop), offering location and device details. data storage is limited to 7 days with up to 500 items per request. see statistics overview for further information.
Schedule single send
Schedule single send
Use this endpoint to send a message right away by setting
send at to now, or schedule it by specifying a future time in iso 8601 format (yyyy-mm-ddthh:mm:ssz).Retrieve bounce classification totals
Retrieve bounce classification totals
This endpoint will return the total number of bounces by classification in descending order for each day. you can retrieve the bounce classification totals in csv format by specifying
"text/csv" in the accept header.Update an account s state
Update an account s state
Update the state of the specified account.
Search contacts
Search contacts
Find contacts using this endpoint with a body containing a
query in sgql. searches must use lowercase, and only the first 50 matches are returned. queries over 20s will timeout. dates are in iso format, not unix timestamps.Retrieve email statistics for your subusers
Retrieve email statistics for your subusers
this endpoint allows you to retrieve the email statistics for the given subusers. you may retrieve statistics for up to 10 different subusers by including an additional subusers parameter for each additional subuser.
Retrieve bounce classification over time by domain stats
Retrieve bounce classification over time by domain stats
This endpoint will return the number of bounces for the classification specified in descending order for each day. you can retrieve the bounce classification totals in csv format by specifying
"text/csv" in the accept header.Update custom field definition
Update custom field definition
this endpoint allows you to update a defined custom field. only your custom fields can be modified; reserved fields cannot be updated.
Update click tracking settings
Update click tracking settings
This endpoint configures click tracking for emails, redirecting links through sendgrid or branded domains for engagement analysis, with a limit of 1000 links per email.
Update a sender identity
Update a sender identity
This api endpoint enables updates to sender identities. changing
from.email necessitates re-verification. partial updates are valid, but “required” fields must not be empty in patch requests.Validate a reverse dns record
Validate a reverse dns record
Endpoint checks reverse dns record validity via
valid in validation results.a record. if false, it’s undetermined, not necessarily invalid. check reason for explanation. retrieve ids with “retrieve all reverse dns records” endpoint.Validate a branded link
Validate a branded link
this endpoint allows you to validate a branded link. you can submit this request as one of your subusers if you include their id in the
on-behalf-of header in the request.Update a suppression group
Update a suppression group
this endpoint allows you to update or change a suppression group.
Validate a batch id
Validate a batch id
Validate a mail batch id to get a
200 status code for a valid one, or a 400 code for an invalid. a valid id simply means it’s created, not necessarily assigned to a send.Update a sender
Update a sender
This endpoint updates an existing sender. changes to
from.email need re-verification. if domain authenticated, new senders auto verify; else, verification email sent. partial updates can be made, but “required” fields in a patch must not be empty.Update a user s profile
Update a user s profile
this endpoint allows you to update your current profile details. any one or more of the parameters can be updated via the patch
/user/profile endpoint. you must include at least one when you patch.Update bounce purge mail settings
Update bounce purge mail settings
Update your bounce settings with twilio sendgrid to automatically delete contacts from suppression lists based on a set schedule in full days for both soft and hard email bounces. manage settings via their app or api.
Update a segment
Update a segment
this endpoint allows you to update a segment.
Update design
Update design
The design api enables partial design updates using patch requests, changing only specified fields, like the ‘name’ field, with no impact on other data.
Update sso certificate
Update sso certificate
this endpoint allows you to update an existing certificate by id. you can retrieve a certificate’s id from the response provided by the “get all sso integrations” endpoint.
Update details for an ip address
Update details for an ip address
The operation modifies an ip address’s settings, such as auto warm-up status, parent account assignment, and active status. the request must have one of
is auto warmup, is parent assigned, or is enabled.Validate a domain authentication
Validate a domain authentication
this endpoint allows you to validate an authenticated domain. if it fails, it will return an error message describing why the domain could not be validated.
Update a single event webhook by id
Update a single event webhook by id
Update event webhooks by id with this endpoint or without id to update the oldest one. enable or disable, set url, choose event types, give friendly names, and configure oauth. for signature verification, use a different endpoint.
Update subscription tracking settings
Update subscription tracking settings
this endpoint allows you to update your current settings for subscription tracking. subscription tracking adds links to the bottom of your emails that allows your recipients to subscribe to, or unsubscribe from, your emails.
Verify sender request
Verify sender request
this endpoint allows you to verify a sender requests. the token is generated by sendgrid and included in a verification email delivered to the address that’s pending verification.
View a sender identity
View a sender identity
this endpoint allows you to retrieve a specific sender identity.
View scheduled time of a campaign
View scheduled time of a campaign
this endpoint allows you to retrieve the date and time that a campaign has been scheduled to be sent.
Update teammate s permissions
Update teammate s permissions
This endpoint updates teammate permissions: set
is admin to true for admin rights, otherwise to false with relevant scopes. only parent users or admins can modify these settings, and admin users are limited to permission changes.Update template mail settings
Update template mail settings
The endpoint updates legacy email templates, replaced by more advanced dynamic transactional templates. legacy templates are html-wrapped email content useful for marketing. guidance is available for using and migrating from legacy templates.
Update the credits for a subuser
Update the credits for a subuser
this endpoint allows you to update the credits for a subuser.
Update the remaining credits for a subuser
Update the remaining credits for a subuser
this endpoint allows you to update the remaining credits for a subuser.
Update your account email address
Update your account email address
this endpoint allows you to update the email address currently on file for your account.
Update your password
Update your password
this endpoint allows you to update your password.
Update your username
Update your username
this endpoint allows you to update the username for your account.
Update footer mail settings
Update footer mail settings
Update enforced tls settings
Update enforced tls settings
Update tls settings through the endpoint by setting ‘require tls’ to ‘true’ for compulsory tls 1.1+ and valid certificates with recipients. messages without tls are blocked with a specific event notice.
Validate an email
Validate an email
this endpoint allows you to validate an email address.
Update forward spam mail settings
Update forward spam mail settings
Activate forward spam to send spam reports to specified emails; supports multiple addresses and authenticating domains to receive abuse/postmaster mails. configure via twilio sendgrid app.
Update forward bounce mail settings
Update forward bounce mail settings
This endpoint updates bounce forwarding mail settings, allowing users to set an email for bounce report forwards and configure spam mail forwarding in twilio sendgrid app.
Update google analytics settings
Update google analytics settings
Update your google analytics settings to track user activity on your site more effectively; defaults follow google’s recommendations. for guidance, visit google’s url builder and campaign building best practices.
Sendgrid Update Integration
Sendgrid Update Integration
This endpoint updates an existing integration.
Update open tracking settings
Update open tracking settings
Update your email settings to enable open tracking with sendgrid, which uses an invisible image to log email opens in various reports if the recipient allows images.
Update segment
Update segment
Segment
name has to be unique. a user can not create a new segment with an existing segment name.Update list
Update list
this endpoint updates the name of a list.
Update single send
Update single send
Update single send drafts using its id via this endpoint; only changed properties are affected. the ‘send at’ property sets a date but doesn’t schedule it; use schedule single send endpoint or ui to schedule.