> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# SendGrid

> How to set up the SendGrid connector, plus the actions that are available.

![SendGrid](https://stackone-logos.com/api/sendgrid/filled/svg)

v1.3.1[See changelog](https://docs.stackone.com/connectors/sendgrid/changelog.md)

[110 actions](#actions) · 1 auth method

Messaging
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/sendgrid/guides/connector-profile/api-key.md)
>
> Generate an API key from your SendGrid account settings with appropriate scopes for the operations you need.

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/sendgrid/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

110 actions

ActionDescription

Send Email`sendgrid_send_email`

Send an email through SendGrid's Mail Send API

Get Authenticated User`sendgrid_get_authenticated_user`

Retrieve information about the authenticated user

List Templates`sendgrid_list_templates`

Retrieve all transactional templates

Create Template`sendgrid_create_template`

Create a new transactional template

Get Template`sendgrid_get_template`

Retrieve a single transactional template

Update Template`sendgrid_update_template`

Edit a transactional template

Delete Template`sendgrid_delete_template`

Delete a transactional template

Create Template Version`sendgrid_create_template_version`

Create a new version of a template

Get Template Version`sendgrid_get_template_version`

Retrieve a specific version of a template

Update Template Version`sendgrid_update_template_version`

Edit the content of a template version

Delete Template Version`sendgrid_delete_template_version`

Delete a template version

Activate Template Version`sendgrid_activate_template_version`

Activate a specific version of a template

List Designs`sendgrid_list_designs`

Retrieve a list of designs from your Design Library

Get Design`sendgrid_get_design`

Retrieve a single design by ID

Create Design`sendgrid_create_design`

Create a new design

Duplicate Design`sendgrid_duplicate_design`

Duplicate an existing design

Update Design`sendgrid_update_design`

Edit an existing design

Delete Design`sendgrid_delete_design`

Delete a single design

List Pre-built Designs`sendgrid_list_prebuilt_designs`

Retrieve a list of pre-built SendGrid designs

Get Pre-built Design`sendgrid_get_prebuilt_design`

Retrieve a single pre-built SendGrid design

Duplicate Pre-built Design`sendgrid_duplicate_prebuilt_design`

Duplicate a pre-built SendGrid design

Add Or Update Contacts`sendgrid_upsert_contacts`

Add or update up to 30,000 contacts or 6MB of data

Search Contacts`sendgrid_search_contacts`

Search for contacts using SGQL query

Get Contact By ID`sendgrid_get_contact`

Retrieve a specific contact by ID

Delete Contacts`sendgrid_delete_contacts`

Delete one or more contacts by ID or all contacts

Get Contact Count`sendgrid_get_contact_count`

Get the total number of contacts in your account

List All Lists`sendgrid_list_all_lists`

Retrieve all contact lists

Create List`sendgrid_create_list`

Create a new contact list

Get List By ID`sendgrid_get_list`

Retrieve a specific list by ID

Update List`sendgrid_update_list`

Update a list's name

Delete List`sendgrid_delete_list`

Delete a contact list

List Segments`sendgrid_list_segments`

Retrieve a list of contact segments

Create Segment`sendgrid_create_segment`

Create a new dynamic contact segment

Get Segment By ID`sendgrid_get_segment`

Get Marketing Campaigns Segment by ID

Update Segment`sendgrid_update_segment`

Update a segment's name or query

Delete Segment`sendgrid_delete_segment`

Delete a contact segment

List Single Sends`sendgrid_list_single_sends`

Retrieve all single send campaigns

Create Single Send`sendgrid_create_single_send`

Create a new single send campaign

Get Single Send By ID`sendgrid_get_single_send`

Retrieve a specific single send by ID

Update Single Send`sendgrid_update_single_send`

Update a Single Send using a Single Send ID

Delete Single Send`sendgrid_delete_single_send`

Delete a single send campaign

Schedule Single Send`sendgrid_schedule_single_send`

Schedule a single send for delivery

Search Single Sends`sendgrid_search_single_sends`

Search for single sends using filters

Get Single Send Stats`sendgrid_get_single_send_stats`

Get statistics for a specific single send

Get Single Send Categories`sendgrid_get_singlesend_categories`

Retrieve all categories associated with Single Sends

List Verified Senders`sendgrid_list_verified_senders`

Retrieve all verified senders

Create Verified Sender`sendgrid_create_verified_sender`

Create a new Sender Identity

Update Verified Sender`sendgrid_update_verified_sender`

Update an existing Sender Identity

Delete Verified Sender`sendgrid_delete_verified_sender`

Delete a verified sender identity

Resend Verification Email`sendgrid_resend_verification_email`

Resend verification email to a sender

List Authenticated Domains`sendgrid_list_authenticated_domains`

Retrieve all authenticated domains

Authenticate Domain`sendgrid_authenticate_domain`

Authenticate a new domain for sending

Get Authenticated Domain`sendgrid_get_authenticated_domain`

Retrieve a specific authenticated domain

Delete Authenticated Domain`sendgrid_delete_authenticated_domain`

Delete an authenticated domain

Validate Authenticated Domain`sendgrid_validate_authenticated_domain`

Validate domain DNS records

Get Default Authenticated Domain`sendgrid_get_default_authenticated_domain`

Retrieve the default authenticated domain

List Bounces`sendgrid_list_bounces`

Retrieve a paginated list of all bounces

Get Bounce By Email`sendgrid_get_bounce`

Retrieve a specific bounce by email address

Delete Bounce By Email`sendgrid_delete_bounce`

Remove an email address from bounce list

Delete Bounces`sendgrid_delete_bounces`

Delete all emails on your bounces list

List Blocks`sendgrid_list_blocks`

Retrieve a paginated list of all email addresses that are currently on your blocks list

Get Block By Email`sendgrid_get_block`

Retrieve a specific email address from your blocks list

Delete Block By Email`sendgrid_delete_block`

Delete a specific email address from your blocks list

Delete Blocks`sendgrid_delete_blocks`

Delete all email addresses on your blocks list

List Spam Reports`sendgrid_list_spam_reports`

Retrieve a paginated list of all spam reports

Get Spam Report By Email`sendgrid_get_spam_report`

Retrieve a specific spam report by email address

Delete Spam Report By Email`sendgrid_delete_spam_report`

Delete a specific spam report by email address

Delete Spam Reports`sendgrid_delete_spam_reports`

Delete spam reports

List Invalid Emails`sendgrid_list_invalid_emails`

Retrieve a paginated list of all invalid email addresses

Get Invalid Email`sendgrid_get_invalid_email`

Retrieve a specific invalid email address

Delete Invalid Email By Address`sendgrid_delete_invalid_email`

Remove a specific email address from the invalid email address list

Delete Invalid Emails`sendgrid_delete_invalid_emails`

Remove email addresses from invalid email address list

List Global Unsubscribes`sendgrid_list_global_suppressions`

Retrieve a paginated list of all email address that are globally suppressed

List Suppression Groups`sendgrid_list_suppression_groups`

Retrieve all suppression groups associated with the account

Create Suppression Group`sendgrid_create_suppression_group`

Create a new suppression group

Get Suppression Group`sendgrid_get_suppression_group`

Retrieve a single suppression group by ID

Update Suppression Group`sendgrid_update_suppression_group`

Update or change a suppression group

Delete Suppression Group`sendgrid_delete_suppression_group`

Delete a suppression group

Get Email Statistics`sendgrid_get_email_statistics`

Retrieve email delivery statistics

Get Statistics By Category`sendgrid_get_category_statistics`

Retrieve statistics filtered by category

Get Email Activity`sendgrid_get_email_activity`

Retrieve email activity events

Get Message By ID`sendgrid_get_message_by_id`

Retrieve a specific message by its ID

Get Subuser Statistics Sums`sendgrid_get_statistics_sums`

Retrieve total sums of email statistics for all subusers

List API Keys`sendgrid_list_api_keys`

Retrieve all API keys for your account

Create API Key`sendgrid_create_api_key`

Create a new API key

Get API Key By ID`sendgrid_get_api_key`

Retrieve a specific API key by ID

Update API Key`sendgrid_update_api_key`

Update an API key's name or scopes

Update API Key Name`sendgrid_update_api_key_name`

Update only the name of an API key

Delete API Key`sendgrid_delete_api_key`

Delete an API key

Get Current API Key Scopes`sendgrid_get_api_key_scopes`

Retrieve scopes for the current API key

List Account IPs`sendgrid_list_account_ips`

Retrieve all IP addresses associated with a customer account

Add Account IPs`sendgrid_add_account_ips`

Provision and add IP addresses to a customer account

List Teammates`sendgrid_list_teammates`

Retrieve a paginated list of all current Teammates

Get Teammate`sendgrid_get_teammate`

Retrieve a specific Teammate by username

List Pending Teammates`sendgrid_list_pending_teammates`

Retrieve a list of all pending Teammate invitations

Invite Teammate`sendgrid_invite_teammate`

Invite a Teammate to your account via email

Resend Teammate Invite`sendgrid_resend_teammate_invite`

Resend a Teammate invitation

Update Teammate Permissions`sendgrid_update_teammate_permissions`

Update a teammate's permissions

Delete Teammate`sendgrid_delete_teammate`

Delete a teammate

Delete Pending Teammate`sendgrid_delete_pending_teammate`

Delete a pending teammate invite

Get Unified Credentials`sendgrid_unified_get_me`

Return the authenticated identity, granted API key scopes, and auth type for the current SendGrid connection, mapped to...

IAM Auth Test`sendgrid_auth_test`

Validate the current SendGrid API key and return the raw, unmapped /v3/scopes response (the scopes array granted to this...

List Unified Groups`sendgrid_unified_list_groups`

List every SendGrid Subuser on the connected parent account, mapped to the IAM unified group schema as workspace-style g...

Get Unified Group`sendgrid_unified_get_group`

Retrieve a single SendGrid Subuser by username, mapped to the IAM unified group schema. SendGrid has no single-subuser G...

List Unified Organizations`sendgrid_unified_list_organizations`

Return the connected SendGrid parent account as a single IAM organization. SendGrid is a single-tenant API surface from...

Get Unified Organization`sendgrid_unified_get_organization`

Retrieve the connected SendGrid parent account as a single IAM organization. SendGrid is single-tenant from the parent a...

List Unified Roles`sendgrid_unified_list_roles`

Return the three stable workspace-scoped roles (owner / admin / teammate) synthesized from the SendGrid Teammates user\_t...

Get Unified Role`sendgrid_unified_get_role`

Retrieve a single synthesized SendGrid IAM role by stable key (owner, admin, or teammate).

List Unified Users`sendgrid_unified_list_users`

List every SendGrid Teammate on the connected account, followed by its unexpired pending teammate invitations. Active te...

Get Unified User`sendgrid_unified_get_user`

Retrieve a single SendGrid Teammate by username, or a pending teammate invitation by the invitation\_\<email> id unified\_l...


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.