SendGrid

Tools

• Activate template version

  **this endpoint allows you to activate a version of one of your templates.**

• 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 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 an ip to an authenticated domain

  **this endpoint allows you to add an ip address to an authenticated domain.**

• Add a single recipient to a list

  **this endpoint allows you to add a single recipient to a list.**

• 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 ips

  **this endpoint is for adding a(n) ip address(es) to your account.**

• 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.

• 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 cas

• Add recipient addresses to the global suppression group

  **this endpoint allows you to add one or more email addresses to the global suppressions 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.

• Approve access request

  **this endpoint allows you to approve an access attempt.** **note:** only teammate admins may approve another teammate’s access request.

• 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

  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.

• 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.

• 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.

• 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

• 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.

• Bulk delete single sends

  destructive

  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.

• 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.

• 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 a batch id

  Create a new mail batch id to group email sends, allowing pause or cancel actions via the scheduled sends api.

• 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 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 custom field

  **this endpoint allows you to create a custom field.** **you can create up to 120 custom fields.**

• Create a list

  **this endpoint allows you to create a list for your recipients.**

• Create an account

  Creates a new account, with specified offering, under the organization.

• Create a new alert

  **this endpoint allows you to create a new alert.**

• 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 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](https://docs.sendgrid.com/api-reference/suppressions-suppressions/add-suppressions-to-a-suppression-gro

• Create a new transactional template version

  **this endpoint allows you to create a new version of a template.**

• 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

  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

  **this endpoint allows you to create an sso certificate.**

• Create an sso integration

  **this endpoint allows you to create an sso integration.**

• 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 potentia

• 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 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 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 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 a sender identity

  **this endpoint allows you to create a new sender identity.** you may create up to 100 unique sender identities.

• Create a transactional template

  **this endpoint allows you to create a transactional template.**

• 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 ca

• 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.

• Createintegration

  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 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`.

• Create segment

  Segment `name` has to be unique. a user can not create a new segment with an existing segment name.

• 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.

• Create subuser

  **this endpoint allows you to create a new subuser.**

• 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.

Works well with

How Switchy teams use it

Starter prompts

@SendGrid create a new email template called 'Welcome Series 1' with subject 'Welcome to [Company]' and a friendly onboarding message that includes a call-to-action button linking to our getting-started guide.

@SendGrid show me delivery stats for the campaign I sent yesterday — I need open rate, click rate, and any bounces or spam reports.

@SendGrid add these five email addresses to my 'Newsletter Subscribers' list: user1@example.com, user2@example.com, user3@example.com, user4@example.com, user5@example.com.

@SendGrid why did my email to support@example.com bounce? Show me the bounce reason and any error codes from the last 48 hours.

@SendGrid activate version 3 of my 'Monthly Newsletter' template and confirm it's now the default for all future sends.

Example outputs

Illustrative - representative of the model's voice and quality, not literal recordings.

Use-case deep-dives

Frequently asked