Sendgrid

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.

**this endpoint allows you to retrieve all of your recipient lists. if you don't have any lists, an empty array will be returned.**

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

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

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.

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

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.

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

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.

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.

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

**this endpoint allows you to add one or more email addresses to the global suppressions group.**

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

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

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.

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

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.

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.

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.

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.

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.

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

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.

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.

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

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

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.

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 new mail batch id to group email sends, allowing pause or cancel actions via the scheduled sends api.

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.

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.

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

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

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

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.

**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-group).

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

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.

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

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.

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

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

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.

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.

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.

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

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

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.

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

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.

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.

**this endpoint allows you to delete an alert.**

**this endpoint allows you to delete an authenticated domain.**

**this endpoint allows you to delete an ip pool.**

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

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

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

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.

This operation removes a batch of subusers from a specified ip address.

**this endpoint allows you to remove an email address from your bounce list.**

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.

**this endpoint allows you to delete a specific campaign.**

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.

**this endpoint allows you to delete a custom field by id.**

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.

**this endpoint allows you to delete a specific recipient list with the given id.**

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

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

This endpoint deletes a reverse dns record, returning a 204 code on success. retrieve record ids using the "retrieve all reverse dns records" endpoint.

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

**this endpoint allows you to delete an existing sender.**

**this endpoint allows you to delete one of your sender identities.**

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

**this endpoint allows you to delete a single recipient from a list.**

**this endpoint allows you to delete a specific email address from your blocks list.**

**this endpoint allows you to remove a specific email address from the invalid email address list.**

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.

**this endpoint allows you to delete a subuser.** this is a permanent action. once deleted, a subuser cannot be retrieved.

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.

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.

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

**this endpoint allows you to delete a transactional template version.**

This endpoint enables clearing blocked emails either by deleting all with `delete all`=true or by specifying addresses in the `emails` array.

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.

This endpoint deletes integrations.

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.

**this endpoint deletes a defined custom field.** you can delete only custom fields; reserved fields cannot be deleted.

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

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.

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.

**this endpoint allows you to delete a pending teammate invite.**

**this endpoint allows you to delete a segment 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.

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.

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.

**this endpoint allows you to delete a teammate.** **only the parent user or an admin teammate can delete another teammate.**

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.

**this endpoint allows you to deny an attempt to access your account.** **note:** only teammate admins may delete a teammate's access request.

The endpoint permits parent accounts to remove a branded link from a subuser, with successful disassociations confirmed by a 204 status code response.

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.

**this endpoint will return a presigned url that can be used to download the csv that was requested from the "request a csv" endpoint.**

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

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.

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.

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.

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.

This endpoint lets you change the name of a transactional template. for template modifications, create a new version using the provided link.

**this endpoint allows you to edit the content of your template version.**

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

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.

**this endpoint allows you to enable or disable a subuser.**

Enable/disable website access for a subuser, while still preserving email send functionality.

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.

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.

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.

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.

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.

Get all of the details about the specified message.

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.

Retrieves offering information about the specified account.

Retrieves all accounts under the organization.

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.

Retrieves offerings available under the organization.

**this endpoint allows you to retrieve all the categories associated with your single sends.** this endpoint will return your latest 1,000 categories.

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.

**this endpoint retrieves all defined custom fields and reserved fields.**

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.

**this endpoint returns an array of all of your contact lists.**

**this endpoint allows you to retrieve a list of all sender identities that have been created for your account.**

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.

Retrieve single sends stats with options for filtering by ids, pagination, and custom page sizes from 1-50. default response batch is 25.

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

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

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.

Retrieve the state of the specified account.

**this endpoint allows you to retrieve an individual sso certificate.**

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

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

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.

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