Sendgrid

Learn how to use Sendgrid with Composio

Overview

SLUG

SENDGRID

Description

SendGrid is a cloud-based email delivery platform providing transactional and marketing email services, with APIs for integration, analytics, and scalability

Authentication Details

generic_api_key
stringRequired

Tools

SLUG: SENDGRID_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.

Action Parameters

ip
string
pool_name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SENDGRID_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.**

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SENDGRID_ACTIVATE_TEMPLATE_VERSION

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

Action Parameters

template_id
stringRequired
version_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SENDGRID_ADD_AN_IP_TO_AN_AUTHENTICATED_DOMAIN

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

Action Parameters

id
integerRequired
ip
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SENDGRID_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.

Action Parameters

ips
arrayRequired
poolid
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SENDGRID_ADD_A_SINGLE_RECIPIENT_TO_A_LIST

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

Action Parameters

list_id
integerRequired
recipient_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SENDGRID_ADD_A_TWILIO_SEND_GRID_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.

Action Parameters

include_region
boolean
is_auto_warmup
booleanRequired
is_parent_assigned
booleanRequired
region
string
subusers
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SENDGRID_ADD_IPS

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

Action Parameters

count
integerRequired
subusers
array
warmup
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SENDGRID_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.

Action Parameters

ips
arrayRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SENDGRID_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.

Action Parameters

contacts
arrayRequired
list_ids
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SENDGRID_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.

Action Parameters

group_id
stringRequired
recipient_emails
arrayRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SENDGRID_ADD_TO_GLOBAL_SUPPRESSIONS_GROUP

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

Action Parameters

recipient_emails
arrayRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SENDGRID_APPROVE_ACCESS_REQUEST

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

Action Parameters

request_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SENDGRID_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.

Action Parameters

ip
stringRequired
subusers
arrayRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SENDGRID_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.

Action Parameters

domain_id
integerRequired
username
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SENDGRID_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

Action Parameters

accountID
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SENDGRID_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.

Action Parameters

automatic_security
boolean
custom_dkim_selector
string
custom_spf
boolean
default
boolean
domain
stringRequired
ips
array
region
string
subdomain
string
username
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SENDGRID_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.

Action Parameters

domain_id
integerRequired
username
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: SENDGRID_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.

Action Parameters

ids
array

Action Response

data
objectRequired
error
string
successful
booleanRequired