Skip to content
tooluse.net logotooluse.net

Twilio SendGrid

Updated View as Markdown

Send transactional email and manage the supported SendGrid mail, contact, marketing, suppression, sender and account API families. Uses a customer restricted API key and the US API origin. Email acceptance is not delivery; verified senders, scopes, plans and regional residency still apply. Unsupported binary, form and schema contracts remain explicit exclusions; EU-region accounts require a separate reviewed configuration.

What you can do (380)

What you can do

Available commands: 380 (177 read, 203 write). Enable only the commands your application needs.

Command Effect
Get all accounts — sendgrid.account_provisioning.listaccount Read
Create an account — sendgrid.account_provisioning.createaccount Write
Delete an account — sendgrid.account_provisioning.deleteaccount Write
Get account offerings — sendgrid.account_provisioning.listaccountoffering Read
Update account offerings — sendgrid.account_provisioning.updateaccountoffering Write
Get an account's state — sendgrid.account_provisioning.getaccountstate Read
Update an account's state — sendgrid.account_provisioning.updateaccountstate Write
Get all available offerings — sendgrid.account_provisioning.listoffering Read
Create a new Alert — sendgrid.alerts.createalert Write
Retrieve all alerts — sendgrid.alerts.listalert Read
Retrieve a specific alert — sendgrid.alerts.getalert Read
Delete an alert — sendgrid.alerts.deletealert Write
Update an alert — sendgrid.alerts.updatealert Write
Create API keys — sendgrid.api_keys.createapikey Write
Retrieve all API Keys belonging to the authenticated user — sendgrid.api_keys.listapikey Read
Retrieve an existing API Key — sendgrid.api_keys.getapikey Read
Update API key name — sendgrid.api_keys.updateapikeyname Write
Update API key name and scopes — sendgrid.api_keys.updateapikey Write
Delete API keys — sendgrid.api_keys.deleteapikey Write
Email DNS records to a co-worker — sendgrid.domain_authentication.emaildnsrecord Write
List all authenticated domains — sendgrid.domain_authentication.listauthenticateddomain Read
Authenticate a domain — sendgrid.domain_authentication.authenticatedomain Write
Retrieve an authenticated domain — sendgrid.domain_authentication.getauthenticateddomain Read
Update an authenticated domain — sendgrid.domain_authentication.updateauthenticateddomain Write
Delete an authenticated domain. — sendgrid.domain_authentication.deleteauthenticateddomain Write
Associate an authenticated domain with a given user. — sendgrid.domain_authentication.associatesubuserwithdomain Write
Disassociate an authenticated domain from a given user for users with up to five associated domains. — sendgrid.domain_authentication.disassociatesubuserfromdomain Write
Associate an authenticated domain with a given user, for up to five domains. — sendgrid.domain_authentication.associatesubuserwithdomainmultiple Write
Add an IP to an authenticated domain — sendgrid.domain_authentication.addiptoauthenticateddomain Write
Remove an IP from an authenticated domain. — sendgrid.domain_authentication.deleteipfromauthenticateddomain Write
Validate a domain authentication. — sendgrid.domain_authentication.validateauthenticateddomain Write
Get the default authentication — sendgrid.domain_authentication.listdefaultauthenticateddomain Read
List the authenticated domain associated with the given user. — sendgrid.domain_authentication.listauthenticateddomainwithuser Read
Disassociate an authenticated domain from a given user. — sendgrid.domain_authentication.disassociateauthenticateddomainfromuser Write
List all the authenticated domains associated with the given user. — sendgrid.domain_authentication.listallauthenticateddomainwithuser Read
Filter all messages — sendgrid.email_activity.listmessage Read
Filter messages by message ID — sendgrid.email_activity.getmessage Read
Request CSV — sendgrid.email_activity.requestcsv Write
Download CSV — sendgrid.email_activity.downloadcsv Read
Validate an email — sendgrid.email_validation.validateemail Write
Request a presigned URL and headers for Bulk Email Address Validation list upload. — sendgrid.email_validation.listemailjobforverification Write
This request lists all of a user's Bulk Email Validation Jobs. — sendgrid.email_validation.getvalidationsemailjobs Read
This request returns a single Bulk Email Validation Job. — sendgrid.email_validation.getemailjobforverification Read
Retrieve current Enforced TLS settings. — sendgrid.enforced_tls.listenforcedtlssetting Read
Update Enforced TLS settings — sendgrid.enforced_tls.updateenforcedtlssetting Write
ListIntegration — sendgrid.integrations.getintegrationsbyuser Read
CreateIntegration — sendgrid.integrations.addintegration Write
DeleteBulkIntegration — sendgrid.integrations.deleteintegration Write
GetIntegration — sendgrid.integrations.findintegrationbyid Read
UpdateIntegration — sendgrid.integrations.updateintegration Write
Retrieve all recent access attempts — sendgrid.ip_access_management.listaccessactivity Read
Add one or more IPs to the allow list — sendgrid.ip_access_management.addiptoallowlist Write
Retrieve a list of currently allowed IPs — sendgrid.ip_access_management.listallowedip Read
Remove one or more IPs from the allow list — sendgrid.ip_access_management.deleteallowedips Write
Retrieve a specific allowed IP — sendgrid.ip_access_management.getallowedip Read
Remove a specific IP from the allowed list — sendgrid.ip_access_management.deleteallowedip Write
Get a List of all IP Addresses on your Account — sendgrid.ip_address_management.listip Read
Get Details for an IP Address — sendgrid.ip_address_management.getip Read
GET all IP Pools that have Associated IPs — sendgrid.ip_address_management.listippool Read
Create an IP Pool with a Name and IP Assignments — sendgrid.ip_address_management.createippool Write
Get Details for an IP Pool — sendgrid.ip_address_management.getippool Read
Update an IP Pool Name — sendgrid.ip_address_management.updateippool Write
Delete IP Pool — sendgrid.ip_address_management.deleteippool Write
Get IPs Assigned to an IP Pool — sendgrid.ip_address_management.listipassignedtoippool Read
Add a Batch of IPs to an IP Pool — sendgrid.ip_address_management.addipstoippool Write
Delete a Batch of IPs from an IP Pool — sendgrid.ip_address_management.deleteipsfromippool Write
List Account IPs — sendgrid.ip_provisioning.listaccountips Read
Add Account IPs — sendgrid.ip_provisioning.addaccountips Write
Remove Account IPs — sendgrid.ip_provisioning.removeaccountips Write
Start warming up an IP address — sendgrid.ip_warmup.warmupip Write
Retrieve all IPs currently in warmup — sendgrid.ip_warmup.listwarmupip Read
Retrieve the warmup status for a specific IP address — sendgrid.ip_warmup.getwarmupip Read
Stop warming up an IP address — sendgrid.ip_warmup.stopipwarmup Write
Retrieve all IP addresses — sendgrid.ips.listip Read
Create an IP pool — sendgrid.ips.createippool Write
Retrieve all IP pools — sendgrid.ips.listippool Read
Retrieve all the IPs in a specified pool — sendgrid.ips.getippool Read
Rename an IP pool — sendgrid.ips.updateippool Write
Delete an IP pool — sendgrid.ips.deleteippool Write
Add an IP address to a pool — sendgrid.ips.addiptoippool Write
Remove an IP address from a pool — sendgrid.ips.deleteipfromippool Write
Get remaining IPs count — sendgrid.ips.listremainingipcount Read
Create a branded link — sendgrid.link_branding.createbrandedlink Write
Retrieve all branded links — sendgrid.link_branding.listbrandedlink Read
Retrieve a branded link — sendgrid.link_branding.getbrandedlink Read
Update a branded link — sendgrid.link_branding.updatebrandedlink Write
Delete a branded link — sendgrid.link_branding.deletebrandedlink Write
Validate a branded link — sendgrid.link_branding.validatebrandedlink Write
Associate a branded link with a subuser — sendgrid.link_branding.associatebrandedlinkwithsubuser Write
Retrieve the default branded link — sendgrid.link_branding.listdefaultbrandedlink Read
Retrieve a subuser's branded link — sendgrid.link_branding.listsubuserbrandedlink Read
Disassociate a branded link from a subuser — sendgrid.link_branding.disassociatebrandedlinkfromsubuser Write
Create a Campaign — sendgrid.lmc_campaigns.createcampaign Write
Retrieve all Campaigns — sendgrid.lmc_campaigns.listcampaign Read
Retrieve a single campaign — sendgrid.lmc_campaigns.getcampaign Read
Delete a Campaign — sendgrid.lmc_campaigns.deletecampaign Write
Update a Campaign — sendgrid.lmc_campaigns.updatecampaign Write
Schedule a Campaign — sendgrid.lmc_campaigns.schedulecampaign Write
Update a Scheduled Campaign — sendgrid.lmc_campaigns.updatescheduledcampaign Write
View Scheduled Time of a Campaign — sendgrid.lmc_campaigns.getscheduledcampaign Read
Unschedule a Scheduled Campaign — sendgrid.lmc_campaigns.unschedulecampaign Write
Send a Campaign — sendgrid.lmc_campaigns.sendcampaign Write
Send a Test Campaign — sendgrid.lmc_campaigns.sendtestcampaign Write
Create a Custom Field — sendgrid.lmc_contactdb.createcustomfield Write
Retrieve all custom fields — sendgrid.lmc_contactdb.listcustomfield Read
Retrieve a Custom Field — sendgrid.lmc_contactdb.getcustomfield Read
Delete a Custom Field — sendgrid.lmc_contactdb.deletecustomfield Write
Create a List — sendgrid.lmc_contactdb.createcontactdblist Write
Retrieve all lists — sendgrid.lmc_contactdb.listcontactdblist Read
Delete Multiple lists — sendgrid.lmc_contactdb.deletecontactdblists Write
Retrieve a single list — sendgrid.lmc_contactdb.getcontactdblist Read
Update a List — sendgrid.lmc_contactdb.updatecontactdblist Write
Delete a List — sendgrid.lmc_contactdb.deletecontactdblist Write
Retrieve all recipients on a List — sendgrid.lmc_contactdb.listrecipientsfromcontactdblist Read
Add Multiple Recipients to a List — sendgrid.lmc_contactdb.addrecipientstocontactdblist Write
Add a Single Recipient to a List — sendgrid.lmc_contactdb.addrecipienttocontactdblist Write
Delete a Single Recipient from a Single List — sendgrid.lmc_contactdb.deleterecipientfromcontactdblist Write
Add recipients — sendgrid.lmc_contactdb.addrecipient Write
Update Recipient — sendgrid.lmc_contactdb.updaterecipient Write
Delete Recipients — sendgrid.lmc_contactdb.deleterecipients Write
Retrieve recipients — sendgrid.lmc_contactdb.listrecipient Read
Retrieve a single recipient — sendgrid.lmc_contactdb.getrecipient Read
Delete a Recipient — sendgrid.lmc_contactdb.deleterecipient Write
Retrieve the lists that a recipient is on — sendgrid.lmc_contactdb.getrecipientlist Read
Retrieve the count of billable recipients — sendgrid.lmc_contactdb.getbillable Read
Retrieve a Count of Recipients — sendgrid.lmc_contactdb.listrecipientcount Read
Search recipients — sendgrid.lmc_contactdb.listsearchrecipient Read
Search recipients — sendgrid.lmc_contactdb.searchrecipient Write
Retrieve reserved fields — sendgrid.lmc_contactdb.listreservedfield Read
Create a Segment — sendgrid.lmc_contactdb.createsegment Write
Retrieve all segments — sendgrid.lmc_contactdb.listsegment Read
Retrieve a segment — sendgrid.lmc_contactdb.getsegment Read
Update a segment — sendgrid.lmc_contactdb.updatesegment Write
Delete a segment — sendgrid.lmc_contactdb.deletesegment Write
Retrieve recipients on a segment — sendgrid.lmc_contactdb.listrecipientforsegment Read
Get Recipient Upload Status — sendgrid.lmc_contactdb.liststatus Read
Export Recipients — sendgrid.lmc_contactdb.exportrecipient Write
Get All Existing Exports — sendgrid.lmc_contactdb.listexportrecipient Read
Export Recipients Status — sendgrid.lmc_contactdb.getexportrecipient Read
Create a Sender Identity — sendgrid.lmc_senders.createsender Write
Get all Sender Identities — sendgrid.lmc_senders.listsender Read
View a Sender Identity — sendgrid.lmc_senders.getsender Read
Update a Sender Identity — sendgrid.lmc_senders.updatesender Write
Delete a Sender Identity — sendgrid.lmc_senders.deletesender Write
Resend Sender Identity Verification — sendgrid.lmc_senders.resetsenderverification Write
Get all details for the specified message ID. — sendgrid.logs.getmessagebyid Read
Search all messages using the provided query filters. — sendgrid.logs.listmessagesbyfilter Write
Retrieve all mail settings — sendgrid.mail_settings.listmailsetting Read
Update address whitelist mail settings — sendgrid.mail_settings.updateaddresswhitelist Write
Retrieve address whitelist mail settings — sendgrid.mail_settings.listaddresswhitelist Read
Update Bounce Purge Mail Settings — sendgrid.mail_settings.updatebouncepurge Write
Retrieve Bounce Purge Mail Settings — sendgrid.mail_settings.listbouncepurge Read
Update footer mail settings — sendgrid.mail_settings.updatefooter Write
Retrieve footer mail settings — sendgrid.mail_settings.listfooter Read
Update forward bounce mail settings — sendgrid.mail_settings.updateforwardbounce Write
Retrieve forward bounce mail settings — sendgrid.mail_settings.listforwardbounce Read
Update forward spam mail settings — sendgrid.mail_settings.updateforwardspam Write
Retrieve forward spam mail settings — sendgrid.mail_settings.listforwardspam Read
Update template mail settings — sendgrid.mail_settings.updatetemplate Write
Retrieve legacy template mail settings — sendgrid.mail_settings.listtemplate Read
Create a batch ID. — sendgrid.mail.createmailbatch Write
Validate a batch ID. — sendgrid.mail.getmailbatch Read
Send Email with Twilio SendGrid. — sendgrid.mail.sendmail Write
Add or Update a Contact — sendgrid.mc_contacts.updatecontact Write
Delete Contacts — sendgrid.mc_contacts.deletecontact Write
Get Sample Contacts — sendgrid.mc_contacts.listcontact Read
Get a Contact by ID — sendgrid.mc_contacts.getcontact Read
Get Batched Contacts by IDs — sendgrid.mc_contacts.listbatchedcontact Write
Delete a Contact Identifier — sendgrid.mc_contacts.deletecontactidentifier Write
Get Total Contact Count — sendgrid.mc_contacts.listcontactcount Read
Export Contacts — sendgrid.mc_contacts.exportcontact Write
Get All Existing Exports — sendgrid.mc_contacts.listexportcontact Read
Export Contacts Status — sendgrid.mc_contacts.getexportcontact Read
Import Contacts — sendgrid.mc_contacts.importcontact Write
Import Contacts Status — sendgrid.mc_contacts.getimportcontact Read
Search Contacts — sendgrid.mc_contacts.searchcontact Write
Get Contacts by Emails — sendgrid.mc_contacts.listcontactbyemail Write
Get Contacts by Identifiers — sendgrid.mc_contacts.getcontactbyidentifiers Write
Create Custom Field Definition — sendgrid.mc_custom_fields.createfielddefinition Write
Get All Field Definitions — sendgrid.mc_custom_fields.listfielddefinition Read
Update Custom Field Definition — sendgrid.mc_custom_fields.updatefielddefinition Write
Delete Custom Field Definition — sendgrid.mc_custom_fields.deletefielddefinition Write
Create Design — sendgrid.mc_designs.createdesign Write
List Designs — sendgrid.mc_designs.listdesign Read
Duplicate Design — sendgrid.mc_designs.duplicatedesign Write
Get Design — sendgrid.mc_designs.getdesign Read
Update Design — sendgrid.mc_designs.updatedesign Write
Delete Design — sendgrid.mc_designs.deletedesign Write
List SendGrid Pre-built Designs — sendgrid.mc_designs.listprebuiltdesign Read
Duplicate SendGrid Pre-built Design — sendgrid.mc_designs.duplicateprebuiltdesign Write
Get SendGrid Pre-built Design — sendgrid.mc_designs.getprebuiltdesign Read
Create List — sendgrid.mc_lists.createmarketinglist Write
Get All Lists — sendgrid.mc_lists.listmarketinglist Read
Get a List by ID — sendgrid.mc_lists.getmarketinglist Read
Update List — sendgrid.mc_lists.updatemarketinglist Write
Delete a list — sendgrid.mc_lists.deletemarketinglist Write
Remove Contacts from a List — sendgrid.mc_lists.deletecontact Write
Get List Contact Count — sendgrid.mc_lists.listcontactcount Read
Create Segment — sendgrid.mc_segments_2.0.createsegment Write
Get List of Segments — sendgrid.mc_segments_2.0.listsegment Read
Update Segment — sendgrid.mc_segments_2.0.updatesegment Write
Get Segment by ID — sendgrid.mc_segments_2.0.getsegment Read
Delete segment — sendgrid.mc_segments_2.0.deletesegment Write
Manually refresh a segment — sendgrid.mc_segments_2.0.refreshsegment Write
Get List of Segments — sendgrid.mc_segments.listsegment Read
Get Segment by ID — sendgrid.mc_segments.getsegment Read
Delete Segment — sendgrid.mc_segments.deletesegment Write
Create a Sender — sendgrid.mc_senders.createsender Write
Get a list of all Senders — sendgrid.mc_senders.listsender Read
Get a specific Sender — sendgrid.mc_senders.getsender Read
Update a Sender — sendgrid.mc_senders.updatesender Write
Delete a Sender — sendgrid.mc_senders.deletesender Write
Resend a Sender verification — sendgrid.mc_senders.resetsenderverification Write
Create Single Send — sendgrid.mc_singlesends.createsinglesend Write
Get All Single Sends — sendgrid.mc_singlesends.listsinglesend Read
Bulk Delete Single Sends — sendgrid.mc_singlesends.deletesinglesends Write
Duplicate Single Send — sendgrid.mc_singlesends.duplicatesinglesend Write
Update Single Send — sendgrid.mc_singlesends.updatesinglesend Write
Get Single Send by ID — sendgrid.mc_singlesends.getsinglesend Read
Delete Single Send by ID — sendgrid.mc_singlesends.deletesinglesend Write
Schedule Single Send — sendgrid.mc_singlesends.schedulesinglesend Write
Delete Single Send Schedule — sendgrid.mc_singlesends.deletescheduledsinglesend Write
Get All Categories — sendgrid.mc_singlesends.listcategory Read
Get Single Sends Search — sendgrid.mc_singlesends.searchsinglesend Write
Get All Automation Stats — sendgrid.mc_stats.listautomationstat Read
Get Automation Stats by ID — sendgrid.mc_stats.getautomationstat Read
Get Automation Click Tracking Stats by ID — sendgrid.mc_stats.listclicktrackingstat Read
Export Single Send Stats — sendgrid.mc_stats.exportautomationstat Read
Get All Single Sends Stats — sendgrid.mc_stats.listsinglesendstat Read
Get Single Send Stats by ID — sendgrid.mc_stats.getsinglesendstat Read
Get Single Send Click Tracking Stats by ID — sendgrid.mc_stats.listsinglesendtrackingstat Read
Export Single Send Stats — sendgrid.mc_stats.exportsinglesendstat Read
Send a Test Marketing Email — sendgrid.mc_test.sendtestmarketingemail Write
Returns a list of all partner settings. — sendgrid.partner.listpartnersetting Read
Erase recipients' email data — sendgrid.recipients_data_erasure.eraserecipientemaildata Write
Set up reverse DNS — sendgrid.reverse_dns.setupreversedns Write
Retrieve all reverse DNS records — sendgrid.reverse_dns.listreversedns Read
Retrieve a reverse DNS record — sendgrid.reverse_dns.getreversedns Read
Delete a reverse DNS record — sendgrid.reverse_dns.deletereversedns Write
Validate a reverse DNS record — sendgrid.reverse_dns.validatereversedns Write
Cancel or pause a scheduled send — sendgrid.scheduled_sends.createscheduledsend Write
Retrieve all scheduled sends — sendgrid.scheduled_sends.listscheduledsend Read
Retrieve scheduled send — sendgrid.scheduled_sends.getscheduledsend Read
Update a scheduled send — sendgrid.scheduled_sends.updatescheduledsend Write
Delete a cancellation or pause from a scheduled send — sendgrid.scheduled_sends.deletescheduledsend Write
Retrieve a list of scopes for which this user has access. — sendgrid.scopes.listscope Read
Get Engagement Quality Scores — sendgrid.seq.listengagementqualityscore Read
Get Subusers' Engagement Quality Scores — sendgrid.seq.listsubuserengagementqualityscore Read
Create an SSO Certificate — sendgrid.sso.createssocertificate Write
Get an SSO Certificate — sendgrid.sso.getssocertificate Read
Update SSO Certificate — sendgrid.sso.updatessocertificate Write
Delete an SSO Certificate — sendgrid.sso.deletessocertificate Write
Create an SSO Integration — sendgrid.sso.createssointegration Write
Get All SSO Integrations — sendgrid.sso.listssointegration Read
Get an SSO Integration — sendgrid.sso.getssointegration Read
Update an SSO Integration — sendgrid.sso.updatessointegration Write
Delete an SSO Integration — sendgrid.sso.deletessointegration Write
Get All SSO Certificates by Integration — sendgrid.sso.listssointegrationcertificate Read
Edit an SSO Teammate — sendgrid.sso.updatessoteammate Write
Retrieve email statistics by browser. — sendgrid.stats.listbrowserstat Read
Retrieve all categories — sendgrid.stats.listcategory Read
Retrieve Email Statistics for Categories — sendgrid.stats.listcategorystat Read
Retrieve sums of email stats for each category. — sendgrid.stats.listcategorystatsum Read
Retrieve email statistics by client type. — sendgrid.stats.listclientstat Read
Retrieve stats by a specific client type. — sendgrid.stats.getclientstat Read
Retrieve email statistics by device type. — sendgrid.stats.listdevicestat Read
Retrieve email statistics by mailbox provider. — sendgrid.stats.listmailboxproviderstat Read
Retrieve global email statistics — sendgrid.stats.liststat Read
List all Subusers — sendgrid.subusers.listsubuser Read
Create Subuser — sendgrid.subusers.createsubuser Write
Enable/disable a subuser — sendgrid.subusers.updatesubuser Write
Delete a subuser — sendgrid.subusers.deletesubuser Write
Enable/Disable website access for a Subuser — sendgrid.subusers.updatesubuserwebsiteaccess Write
Get the Credits for a Subuser — sendgrid.subusers.getsubusercredit Read
Update the Credits for a Subuser — sendgrid.subusers.updatesubusercredit Write
Update the remaining credits for a Subuser — sendgrid.subusers.updatesubuserremainingcredit Write
Update IPs assigned to a subuser — sendgrid.subusers.updatesubuserip Write
Retrieve the monthly email statistics for a single subuser — sendgrid.subusers.listsubusermonthlystat Read
Retrieve Subuser Reputations — sendgrid.subusers.listreputation Read
Retrieve email statistics for your subusers. — sendgrid.subusers.liststat Read
Retrieve monthly stats for all subusers — sendgrid.subusers.listmonthlystat Read
Retrieve the totals for each email statistic metric for all subusers. — sendgrid.subusers.liststatsum Read
Create a new suppression group — sendgrid.suppressions.creatasmgroup Write
Retrieve all suppression groups associated with the user. — sendgrid.suppressions.listasmgroup Read
Get information on a single suppression group. — sendgrid.suppressions.getasmgroup Read
Update a suppression group. — sendgrid.suppressions.updateasmgroup Write
Delete a Suppression Group — sendgrid.suppressions.deleteasmgroup Write
Add suppressions to a suppression group — sendgrid.suppressions.addsuppressiontoasmgroup Write
Retrieve all suppressions for a suppression group — sendgrid.suppressions.listsuppressionfromasmgroup Read
Delete a suppression from a suppression group — sendgrid.suppressions.deletesuppressionfromasmgroup Write
Search for suppressions within a group — sendgrid.suppressions.searchsuppressionfromasmgroup Write
Retrieve all suppressions — sendgrid.suppressions.listasmsuppression Read
Retrieve all suppression groups for an email address — sendgrid.suppressions.getasmsuppression Read
Retrieve all blocks — sendgrid.suppressions.listsuppressionblock Read
Delete blocks — sendgrid.suppressions.deletesuppressionblocks Write
Retrieve a specific block — sendgrid.suppressions.getsuppressionblock Read
Delete a specific block — sendgrid.suppressions.deletesuppressionblock Write
Retrieve all bounces — sendgrid.suppressions.listsuppressionbounces Read
Delete bounces — sendgrid.suppressions.deletesuppressionbounces Write
Retrieve a Bounce — sendgrid.suppressions.getsuppressionbounces Read
Delete a bounce — sendgrid.suppressions.deletesuppressionbounce Write
Retrieve bounce classification totals — sendgrid.suppressions.listsuppressionbouncesclassifications Read
Retrieve bounce classification over time by domain stats — sendgrid.suppressions.getsuppressionbouncesclassifications Read
Add recipient addresses to the global suppression group. — sendgrid.suppressions.createglobalsuppression Write
Retrieve a Global Suppression — sendgrid.suppressions.getglobalsuppression Read
Delete a Global Suppression — sendgrid.suppressions.deleteglobalsuppression Write
Retrieve all invalid emails — sendgrid.suppressions.listinvalidemail Read
Delete invalid emails — sendgrid.suppressions.deleteinvalidemails Write
Retrieve a specific invalid email — sendgrid.suppressions.getinvalidemail Read
Delete a specific invalid email — sendgrid.suppressions.deleteinvalidemail Write
Retrieve all spam reports — sendgrid.suppressions.listspamreport Read
Delete spam reports — sendgrid.suppressions.deletespamreports Write
Retrieve a specific spam report — sendgrid.suppressions.getspamreport Read
Delete a specific spam report — sendgrid.suppressions.deletespamreport Write
Retrieve all global suppressions — sendgrid.suppressions.listglobalsuppression Read
Invite teammate — sendgrid.teammates.inviteteammate Write
Retrieve all teammates — sendgrid.teammates.listteammate Read
Get Teammate Subuser Access — sendgrid.teammates.listsubuserbytemplate Read
Retrieve specific teammate — sendgrid.teammates.getteammate Read
Update teammate's permissions — sendgrid.teammates.updateteammate Write
Delete teammate — sendgrid.teammates.deleteteammate Write
Retrieve all pending teammates — sendgrid.teammates.listpendingteammate Read
Delete pending teammate — sendgrid.teammates.deletependingteammate Write
Resend teammate invite — sendgrid.teammates.resendteammateinvite Write
Create a transactional template. — sendgrid.templates.createtemplate Write
Retrieve paged transactional templates. — sendgrid.templates.listtemplate Read
Duplicate a transactional template. — sendgrid.templates.duplicatetemplate Write
Retrieve a single transactional template. — sendgrid.templates.gettemplate Read
Edit a transactional template. — sendgrid.templates.updatetemplate Write
Delete a template. — sendgrid.templates.deletetemplate Write
Create a new transactional template version. — sendgrid.templates.createtemplateversion Write
Retrieve a specific transactional template version. — sendgrid.templates.gettemplateversion Read
Edit a transactional template version. — sendgrid.templates.updatetemplateversion Write
Delete a transactional template version. — sendgrid.templates.deletetemplateversion Write
Activate a transactional template version. — sendgrid.templates.activatetemplateversion Write
Retrieve Tracking Settings — sendgrid.tracking_settings.listtrackingsetting Read
Retrieve Click Track Settings — sendgrid.tracking_settings.listclicktrackingsetting Read
Update Click Tracking Settings — sendgrid.tracking_settings.updateclicktrackingsetting Write
Retrieve Google Analytics Settings — sendgrid.tracking_settings.listgoogleanalyticstrackingsetting Read
Update Google Analytics Settings — sendgrid.tracking_settings.updategoogleanalyticstrackingsetting Write
Get Open Tracking Settings — sendgrid.tracking_settings.listopentrackingsetting Read
Update Open Tracking Settings — sendgrid.tracking_settings.updateopentrackingsetting Write
Retrieve Subscription Tracking Settings — sendgrid.tracking_settings.listsubscriptiontrackingsetting Read
Update Subscription Tracking Settings — sendgrid.tracking_settings.updatesubscriptiontrackingsetting Write
Get a user's account information. — sendgrid.user.listaccount Read
Retrieve your credit balance — sendgrid.user.listcredit Read
Retrieve your account email address — sendgrid.user.listemail Read
Update your account email address — sendgrid.user.updateemail Write
Update your password — sendgrid.user.updatepassword Write
Get a user's profile — sendgrid.user.listprofile Read
Update a user's profile — sendgrid.user.updateprofile Write
Retrieve your username — sendgrid.user.listusername Read
Update your username — sendgrid.user.updateusername Write
Create Verified Sender Request — sendgrid.verified_senders.createverifiedsender Write
Get All Verified Senders — sendgrid.verified_senders.listverifiedsender Read
Edit Verified Sender — sendgrid.verified_senders.updateverifiedsender Write
Delete Verified Sender — sendgrid.verified_senders.deleteverifiedsender Write
Domain Warn List — sendgrid.verified_senders.listverifiedsenderdomain Read
Resend Verified Sender Request — sendgrid.verified_senders.resendverifiedsender Write
Completed Steps — sendgrid.verified_senders.listverifiedsenderstepscompleted Read
Verify Sender Request — sendgrid.verified_senders.verifysendertoken Read
Create a new Event Webhook — sendgrid.webhooks.createeventwebhook Write
Retrieve all of your Event Webhooks. — sendgrid.webhooks.listeventwebhook Read
Get Signed Event Webhook's Public Key — sendgrid.webhooks.getsignedeventwebhook Read
Toggle signature verification for a single Event Webhook by ID — sendgrid.webhooks.updatesignedeventwebhook Write
Test an Event Webhook's settings — sendgrid.webhooks.testeventwebhook Write
Get the settings for a single Event Webhook. — sendgrid.webhooks.geteventwebhook Read
Update a single Event Webhook by ID. — sendgrid.webhooks.updateeventwebhook Write
Delete a single Event Webhook by ID. — sendgrid.webhooks.deleteeventwebhook Write
Retrieve all parse settings — sendgrid.webhooks.listparsesetting Read
Create a parse setting — sendgrid.webhooks.createparsesetting Write
Retrieve a specific parse setting — sendgrid.webhooks.getparsesetting Read
Update a parse setting — sendgrid.webhooks.updateparsesetting Write
Delete a parse setting — sendgrid.webhooks.deleteparsesetting Write
Retrieves Inbound Parse Webhook statistics. — sendgrid.webhooks.listparsestatic Read
Create a new webhook security policy — sendgrid.webhooks.createsecuritypolicy Write
Retrieve all webhook security policies for your account — sendgrid.webhooks.listallsecuritypolicies Read
Update an existing webhook security policy — sendgrid.webhooks.updatesecuritypolicy Write
Retrieve a specific webhook security policy — sendgrid.webhooks.getsecuritypolicy Read
Delete a specific webhook security policy — sendgrid.webhooks.deletesecuritypolicy Write

Connect and use

Connect and use

Open the integration's connection form to check the available credential source. The source has not been resolved for this documentation export. The instructions below apply when using your own provider account.

Get your provider credentials

Follow these steps for Twilio SendGrid, then enter the issued values in the connection form below.

  1. In SendGrid, open Settings → API Keys and create a Restricted Access key granting only the required endpoints. Verify sender identities or domains before enabling Mail Send. Paste the key into this connection’s SendGrid restricted API key field. This connection uses api.sendgrid.com for US-region accounts; do not use it for an EU-residency account. Start with a permitted read, then review mail recipients, marketing changes and plan limits before writes. A 202 Mail Send receipt confirms acceptance, not delivery. Save selected commands and create a separate scoped Tooluse.net API key for your AI client; keep the SendGrid key out of the MCP URL.

Official credential setup

Where to enter credentials

In the integration page, sign in, choose your workspace and open Connect. If a Credentials choice is shown, select Use my credentials. Fill the following connection fields and save. Provider credentials belong in this form, never in an MCP configuration or tool input.

Connection field Requirement
SendGrid restricted API key Required

Open API keys and create a Tooluse.net key for the enabled commands.

Set TOOLUSE_API_KEY in your client and use the shared MCP configuration.

Configure Claude Code, Codex or Cursor once

Permissions and results

If you have more than one workspace, check the selected workspace in the connection or API-key dialog before saving. Roles, enabled commands, expiry and revocation use Tooluse.net's existing permissions. Disabling a connection or revoking a key immediately prevents new calls.

Send one Claude tool_use block per request. Keep the same Idempotency-Key when retrying the same request; use a new key for a new call. The response includes the shared Tooluse.net receipt and Claude tool_result. Check both HTTP status and the returned tool result before treating a call as successful.

Your connection's daily allowance and key permissions also apply. Adding a connection does not make a provider request.

Calls return the shared execution receipt and a Claude tool_result. Provider output varies by operation; consult the provider documentation for its response fields. Unconfirmed calls should be checked before retrying.

Call from your client

Use the shared MCP configuration. Refresh your client's tool list after saving the connection or changing key permissions, then call the returned tool name with the example input below.

Configure Claude Code, Codex or Cursor once

Discover your enabled tools

List permitted tools in Claude format. Read every page using page and size (maximum 100) until all results have been received. Use the returned name, not a catalog capability identifier, in the tool_use block.

curl 'https://api.tooluse.net/v1/tools' \
  -H "Authorization: Bearer $TOOLUSE_API_KEY"

Find this command in the tool list permitted by your key. Replace svc_FROM_YOUR_TOOL_LIST with its returned name. Use a new Idempotency-Key for each new call and retain it when retrying that same call.

HTTP call

curl 'https://api.tooluse.net/v1/tool-calls' \
  -H "Authorization: Bearer $TOOLUSE_API_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: replace-with-a-new-call-id' \
  --data '{
  "type": "tool_use",
  "id": "toolu_example",
  "name": "svc_FROM_YOUR_TOOL_LIST",
  "input": {}
}'

Send one Claude tool_use block per request. Keep the same Idempotency-Key when retrying the same request; use a new key for a new call. The response includes the shared Tooluse.net receipt and Claude tool_result. Check both HTTP status and the returned tool result before treating a call as successful.

Commands

Get all accounts — sendgrid.account_provisioning.listaccount

Run Get all accounts with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.offset string Optional The last item successfully retrieved
query.limit integer Optional The number of items to return default: 10; maximum: 100

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an account — sendgrid.account_provisioning.createaccount

Run Create an account with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.T-Test-Account string Optional OPTIONAL Custom request header provided ONLY for a test account
body object Required CreateAccountParams
body.profile — Optional $ref: "#/definitions/AccountProvisioningProfile"
body.offerings array Required List of offering names to assign to account.
body.offerings[] — Optional $ref: "#/definitions/AccountProvisioningOfferingV1"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "profile": {
      "first_name": "Sender",
      "last_name": "Wiz",
      "company_name": "Twilio SendGrid",
      "company_website": "https://sendgrid.com",
      "email": "[email protected]",
      "timezone": "Asia/Tokyo"
    },
    "offerings": [
      {
        "name": "org.ei.free.v1",
        "type": "package",
        "quantity": 1
      }
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an account — sendgrid.account_provisioning.deleteaccount

Run Delete an account with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.accountID string Required Twilio SendGrid account ID

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "accountID": "sg2a2bcd3ef4ab5c67d8efab91c01de2fa"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get account offerings — sendgrid.account_provisioning.listaccountoffering

Run Get account offerings with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.accountID string Required Twilio SendGrid account ID

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "accountID": "sg2a2bcd3ef4ab5c67d8efab91c01de2fa"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update account offerings — sendgrid.account_provisioning.updateaccountoffering

Run Update account offerings with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.accountID string Required Twilio SendGrid account ID
body object Required OfferingsToAdd
body.offerings array Required List of offerings to assign to account.
body.offerings[] — Optional $ref: "#/definitions/AccountProvisioningOfferingV1"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "accountID": "sg2a2bcd3ef4ab5c67d8efab91c01de2fa"
  },
  "body": {
    "offerings": [
      {
        "name": "org.ei.free.v1",
        "type": "package",
        "quantity": 1
      }
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an account's state — sendgrid.account_provisioning.getaccountstate

Run Get an account's state with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.accountID string Required Twilio SendGrid account ID

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "accountID": "sg2a2bcd3ef4ab5c67d8efab91c01de2fa"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an account's state — sendgrid.account_provisioning.updateaccountstate

Run Update an account's state with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.accountID string Required Twilio SendGrid account ID
body — Required $ref: "#/definitions/AccountProvisioningStateWrite"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "accountID": "sg2a2bcd3ef4ab5c67d8efab91c01de2fa"
  },
  "body": {
    "state": "activated"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get all available offerings — sendgrid.account_provisioning.listoffering

Run Get all available offerings with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a new Alert — sendgrid.alerts.createalert

Run Create a new Alert with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.
body object Optional
body.type — Required
body.type — Required allOf[1]; $ref: "#/definitions/Type"
body.type string Required allOf[2]
body.email_to string | null Required The email address the alert will be sent to. Example: [email protected] format: "email"
body.frequency string Optional Required for stats_notification. How frequently the alert will be sent. Example: daily
body.percentage integer Optional Required for usage_limit. When this usage threshold is reached, the alert will be sent. Example: 90

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve all alerts — sendgrid.alerts.listalert

Run Retrieve all alerts with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve a specific alert — sendgrid.alerts.getalert

Run Retrieve a specific alert with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.alert_id integer Required The ID of the alert you would like to retrieve.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "alert_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an alert — sendgrid.alerts.deletealert

Run Delete an alert with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.alert_id integer Required The ID of the alert you would like to retrieve.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "alert_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an alert — sendgrid.alerts.updatealert

Run Update an alert with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.alert_id integer Required The ID of the alert you would like to retrieve.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.
body object Optional
body.email_to string Optional The new email address you want your alert to be sent to. Example: [email protected]
body.frequency string Optional The new frequency at which to send the stats_notification alert. Example: monthly
body.percentage integer Optional The new percentage threshold at which the usage_limit alert will be sent. Example: 90

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "alert_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create API keys — sendgrid.api_keys.createapikey

Run Create API keys with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.
body object Optional
body.name string Required The name you will use to describe this API Key.
body.scopes array Optional The individual permissions that you are giving to this API Key.
body.scopes[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve all API Keys belonging to the authenticated user — sendgrid.api_keys.listapikey

Run Retrieve all API Keys belonging to the authenticated user with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve an existing API Key — sendgrid.api_keys.getapikey

Run Retrieve an existing API Key with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.api_key_id string Required
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "api_key_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update API key name — sendgrid.api_keys.updateapikeyname

Run Update API key name with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.api_key_id string Required
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.
body object Optional
body.name string Required The new name of the API Key.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "api_key_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update API key name and scopes — sendgrid.api_keys.updateapikey

Run Update API key name and scopes with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.api_key_id string Required
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.
body object Optional
body.name string Required
body.scopes array Optional
body.scopes[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "api_key_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete API keys — sendgrid.api_keys.deleteapikey

Run Delete API keys with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.api_key_id string Required
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "api_key_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Email DNS records to a co-worker — sendgrid.domain_authentication.emaildnsrecord

Run Email DNS records to a co-worker with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body object Optional
body.link_id integer Required The ID of the branded link. minimum: 0
body.domain_id integer Required The ID of your SendGrid domain record. minimum: 0
body.email string Required The email address to send the DNS information to. format: "email"
body.message string Optional A custom text block to include in the email body sent with the records. default: "Please set these DNS records in our hosting solution."

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List all authenticated domains — sendgrid.domain_authentication.listauthenticateddomain

Run List all authenticated domains with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional limit sets the page size, i.e. maximum number of items from the list to be returned for a single API request. If omitted, the default page size is used.
query.offset integer Optional The number of items in the list to skip over before starting to retrieve the items for the requested page. The default offset of 0 represents the beginning of the list, i.e. the start of the first page. To request the second page of the list, set the offset to the page size as determined by limit. Use multiples of the page size as your offset to request further consecutive pages. E.g. assume your page size is set to 10. An offset of 10 requests the second page, an offset of 20 requests the third page and so on, provided there are sufficiently many items in your list. default: 0; minimum: 0
query.exclude_subusers boolean Optional Exclude subuser domains from the result.
query.username string Optional The username associated with an authenticated domain.
query.domain string Optional Search for authenticated domains.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Authenticate a domain — sendgrid.domain_authentication.authenticatedomain

Run Authenticate a domain with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.
body object Optional
body.domain string Required Domain being authenticated.
body.subdomain string Optional The subdomain or custom return-path to use for this authenticated domain.
body.username string Optional The username associated with this domain.
body.ips array Optional The IP addresses that will be included in the custom SPF record for this authenticated domain.
body.ips[] string Optional
body.custom_spf boolean Optional Specify whether to use a custom SPF or allow SendGrid to manage your SPF. This option is only available to authenticated domains set up for manual security.
body.default boolean Optional Whether to use this authenticated domain as the fallback if no authenticated domains match the sender's domain.
body.automatic_security boolean Optional Whether to allow SendGrid to manage your SPF records, DKIM keys, and DKIM key rotation.
body.custom_dkim_selector string Optional Add a custom DKIM selector. Accepts three letters or numbers.
body.region string Optional The region of the domain. Allowed values are global and eu. The default value is global.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve an authenticated domain — sendgrid.domain_authentication.getauthenticateddomain

Run Retrieve an authenticated domain with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.domain_id string Required
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "domain_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an authenticated domain — sendgrid.domain_authentication.updateauthenticateddomain

Run Update an authenticated domain with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.domain_id string Required
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.
body object Optional
body.default boolean Optional Indicates whether this is the default authenticated domain. default: false
body.custom_spf boolean Optional Indicates whether to generate a custom SPF record for manual security. default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "domain_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an authenticated domain. — sendgrid.domain_authentication.deleteauthenticateddomain

Run Delete an authenticated domain. with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.domain_id string Required
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "domain_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Associate an authenticated domain with a given user. — sendgrid.domain_authentication.associatesubuserwithdomain

Run Associate an authenticated domain with a given user. with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.domain_id integer Required ID of the authenticated domain to associate with the subuser.
body object Optional
body.username string Required Username to associate with the authenticated domain.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "domain_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Disassociate an authenticated domain from a given user for users with up to five associated domains. — sendgrid.domain_authentication.disassociatesubuserfromdomain

Run Disassociate an authenticated domain from a given user for users with up to five associated domains. with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.username string Optional Username for the subuser to find associated authenticated domain.
path object Required additionalProperties: false
path.domain_id integer Required ID of the authenticated domain to be disassociated with the subuser.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "domain_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Associate an authenticated domain with a given user, for up to five domains. — sendgrid.domain_authentication.associatesubuserwithdomainmultiple

Run Associate an authenticated domain with a given user, for up to five domains. with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.domain_id integer Required ID of the authenticated domain to associate with the subuser.
body object Optional
body.username string Required Username to associate with the authenticated domain.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "domain_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add an IP to an authenticated domain — sendgrid.domain_authentication.addiptoauthenticateddomain

Run Add an IP to an authenticated domain with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id integer Required ID of the domain to which you are adding an IP
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.
body object Optional
body.ip string Required IP to associate with the domain. Used for manually specifying IPs for custom SPF.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove an IP from an authenticated domain. — sendgrid.domain_authentication.deleteipfromauthenticateddomain

Run Remove an IP from an authenticated domain. with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id integer Required ID of the domain to delete the IP from.
path.ip string Required IP to remove from the domain.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": 1,
    "ip": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Validate a domain authentication. — sendgrid.domain_authentication.validateauthenticateddomain

Run Validate a domain authentication. with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id integer Required ID of the domain to validate.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the default authentication — sendgrid.domain_authentication.listdefaultauthenticateddomain

Run Get the default authentication with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.domain string Optional The domain to find a default authentication.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List the authenticated domain associated with the given user. — sendgrid.domain_authentication.listauthenticateddomainwithuser

Run List the authenticated domain associated with the given user. with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.username string Required Username for the subuser to find associated authenticated domain.

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Disassociate an authenticated domain from a given user. — sendgrid.domain_authentication.disassociateauthenticateddomainfromuser

Run Disassociate an authenticated domain from a given user. with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.username string Optional Username for the subuser to find associated authenticated domain.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List all the authenticated domains associated with the given user. — sendgrid.domain_authentication.listallauthenticateddomainwithuser

Run List all the authenticated domains associated with the given user. with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.username string Required Username for the subuser to find associated authenticated domains.

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Filter all messages — sendgrid.email_activity.listmessage

Run Filter all messages with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.query string Required Use the query syntax to filter your email activity. Combine up to 160 filter conditions per request.
query.limit number Optional The number of messages returned. This parameter must be greater than 0 and less than or equal to 1000 default: 10; minimum: 1; maximum: 1000

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "query": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Filter messages by message ID — sendgrid.email_activity.getmessage

Run Filter messages by message ID with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.msg_id string Required The ID of the message you are requesting details for.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "msg_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Request CSV — sendgrid.email_activity.requestcsv

Run Request CSV with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.query string Optional Uses a SQL like syntax to indicate which messages to include in the CSV

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Download CSV — sendgrid.email_activity.downloadcsv

Run Download CSV with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.download_uuid string Required UUID used to locate the download csv request entry in the DB. This is the UUID provided in the email sent to the user when their csv file is ready to download format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "download_uuid": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Validate an email — sendgrid.email_validation.validateemail

Run Validate an email with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body object Optional
body.email string Required The email address that you want to validate.
body.source string Optional A one-word classifier for where this validation originated.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Request a presigned URL and headers for Bulk Email Address Validation list upload. — sendgrid.email_validation.listemailjobforverification

Run Request a presigned URL and headers for Bulk Email Address Validation list upload. with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body object Optional
body.file_type — Required
body.file_type — Required allOf[1]; $ref: "#/definitions/FileType"
body.file_type string Required allOf[2]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

This request lists all of a user's Bulk Email Validation Jobs. — sendgrid.email_validation.getvalidationsemailjobs

Run This request lists all of a user's Bulk Email Validation Jobs. with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

This request returns a single Bulk Email Validation Job. — sendgrid.email_validation.getemailjobforverification

Run This request returns a single Bulk Email Validation Job. with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.job_id string Required The ID of the Bulk Email Address Validation Job you wish to retrieve.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "job_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve current Enforced TLS settings. — sendgrid.enforced_tls.listenforcedtlssetting

Run Retrieve current Enforced TLS settings. with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Enforced TLS settings — sendgrid.enforced_tls.updateenforcedtlssetting

Run Update Enforced TLS settings with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.
body — Optional $ref: "#/definitions/EnforcedTlsRequestResponse"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

ListIntegration — sendgrid.integrations.getintegrationsbyuser

Run ListIntegration with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

CreateIntegration — sendgrid.integrations.addintegration

Run CreateIntegration with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required $ref: "#/definitions/IntegrationInput"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "destination": "Segment",
    "filters": {
      "email_events": []
    },
    "properties": {
      "write_key": "1234-abc",
      "destination_region": "EU"
    }
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

DeleteBulkIntegration — sendgrid.integrations.deleteintegration

Run DeleteBulkIntegration with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.ids array Required Comma-delimited Integration IDs for the Integrations to delete.
query.ids[] — Optional $ref: "#/definitions/Id"

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "ids": []
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

GetIntegration — sendgrid.integrations.findintegrationbyid

Run GetIntegration with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required The ID of the Integration you would like to retrieve.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

UpdateIntegration — sendgrid.integrations.updateintegration

Run UpdateIntegration with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required The ID of the Integration you would like to update.
body — Required $ref: "#/definitions/IntegrationPatch"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve all recent access attempts — sendgrid.ip_access_management.listaccessactivity

Run Retrieve all recent access attempts with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional Limits the number of IPs to return. default: 20
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add one or more IPs to the allow list — sendgrid.ip_access_management.addiptoallowlist

Run Add one or more IPs to the allow list with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.
body object Optional
body.ips array Required An array containing the IP(s) you want to allow.
body.ips[] object Optional
body.ips[].ip string Required An IP address that you want to allow.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve a list of currently allowed IPs — sendgrid.ip_access_management.listallowedip

Run Retrieve a list of currently allowed IPs with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove one or more IPs from the allow list — sendgrid.ip_access_management.deleteallowedips

Run Remove one or more IPs from the allow list with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.
body object Optional
body.ids array Optional An array of the IDs of the IP address that you want to remove from your allow list.
body.ids[] integer Optional

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve a specific allowed IP — sendgrid.ip_access_management.getallowedip

Run Retrieve a specific allowed IP with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.rule_id string Required The ID of the allowed IP address that you want to retrieve.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "rule_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove a specific IP from the allowed list — sendgrid.ip_access_management.deleteallowedip

Run Remove a specific IP from the allowed list with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.rule_id string Required The ID of the allowed IP address that you want to retrieve.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "rule_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a List of all IP Addresses on your Account — sendgrid.ip_address_management.listip

Run Get a List of all IP Addresses on your Account with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.ip string Optional Specifies an IP address. The ip query parameter can be used to filter results by IP address.
query.limit integer Optional Specifies the number of results to be returned by the API. This parameter can be used in combination with the before_key or after_key parameters to iterate through paginated results.
query.after_key integer Optional Specifies which items to be returned by the API. When the after_key is specified, the API will return items beginning from the first item after the item specified. This parameter can be used in combination with limit to iterate through paginated results.
query.before_key string Optional Specifies which items to be returned by the API. When the before_key is specified, the API will return items beginning from the first item before the item specified. This parameter can be used in combination with limit to iterate through paginated results.
query.is_leased boolean Optional Indicates whether an IP address is leased from Twilio SendGrid. If false, the IP address is not a Twilio SendGrid IP; it is a customer's own IP that has been added to their Twilio SendGrid account.
query.is_enabled boolean Optional Indicates if the IP address is billed and able to send email. This parameter applies to non-Twilio SendGrid APIs that been added to your Twilio SendGrid account. This parameter's value is null for Twilio SendGrid IP addresses.
query.is_parent_assigned boolean Optional A parent must be assigned to an IP address before the parent can send mail from the IP and before the address can be assigned to an IP pool. Set this parameter value to true to allow the parent to send mail from the IP and make the IP eligible for IP pool assignment using the IP pool endpoints.
query.pool string Optional Specifies the unique ID for an IP Pool. When included, only IP addresses belonging to the specified Pool will be returned.
query.start_added_at integer Optional The start_added_at and end_added_at parameters are used to set a time window. IP addresses that were added to your account in the specified time window will be returned. The start_added_at parameter sets the beginning of the time window.
query.end_added_at integer Optional The start_added_at and end_added_at parameters are used to set a time window. IP addresses that were added to your account in the specified time window will be returned. The end_added_at parameter sets the end of the time window.
query.region — Optional Allowed values are all, eu, and us. If you provide a specific region, results will include all pools that have at least one IP in the filtered region. If all, pools with at least one IP (regardless of region) will be returned. If the region filter is not provided, the query returns all pools, including empty ones.
query.region — Optional allOf[1]; $ref: "#/definitions/Region7"
query.region string Optional allOf[2]
query.include_region boolean Optional Boolean indicating whether or not to return the IP Pool's region information in the response. default: false

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Details for an IP Address — sendgrid.ip_address_management.getip

Run Get Details for an IP Address with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.ip string Required The ip path parameter specifies an IP address to make the request against.
query object Optional additionalProperties: false
query.include_region boolean Optional Boolean indicating whether or not to return the IP Pool's region information in the response. default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "ip": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

GET all IP Pools that have Associated IPs — sendgrid.ip_address_management.listippool

Run GET all IP Pools that have Associated IPs with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional Specifies the number of results to be returned by the API. This parameter can be used in combination with the before_key or after_key parameters to iterate through paginated results.
query.after_key integer Optional Specifies which items to be returned by the API. When the after_key is specified, the API will return items beginning from the first item after the item specified. This parameter can be used in combination with limit to iterate through paginated results.
query.ip string Optional Specifies an IP address. The ip query parameter can be used to filter results by IP address.
query.region — Optional Allowed values are all, eu, and us. If you provide a specific region, results will include all pools that have at least one IP in the filtered region. If all, pools with at least one IP (regardless of region) will be returned. If the region filter is not provided, the query returns all pools, including empty ones.
query.region — Optional allOf[1]; $ref: "#/definitions/Region7"
query.region string Optional allOf[2]
query.include_region boolean Optional Boolean indicating whether or not to return the IP Pool's region information in the response. default: false

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an IP Pool with a Name and IP Assignments — sendgrid.ip_address_management.createippool

Run Create an IP Pool with a Name and IP Assignments with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body object Optional
body.name string Required The name to assign to the IP Pool. An IP Pool name cannot begin with a space or period.
body.ips array Optional An array of IP addresses to assign to the IP Pool. All assignments must succeed. maxItems: 100
body.ips[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Details for an IP Pool — sendgrid.ip_address_management.getippool

Run Get Details for an IP Pool with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.poolid string Required Specifies the unique ID for an IP Pool.
query object Optional additionalProperties: false
query.include_region boolean Optional Boolean indicating whether or not to return the IP Pool's region information in the response. default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "poolid": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an IP Pool Name — sendgrid.ip_address_management.updateippool

Run Update an IP Pool Name with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.poolid string Required Specifies the unique ID for an IP Pool.
body object Optional
body.name string Required The name to assign to the IP Pool. An IP Pool name cannot begin with a space or period.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "poolid": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete IP Pool — sendgrid.ip_address_management.deleteippool

Run Delete IP Pool with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.poolid string Required Specifies the unique ID for an IP Pool.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "poolid": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get IPs Assigned to an IP Pool — sendgrid.ip_address_management.listipassignedtoippool

Run Get IPs Assigned to an IP Pool with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.poolid string Required Specifies the unique ID for an IP Pool.
query object Optional additionalProperties: false
query.limit integer Optional Specifies the number of results to be returned by the API. This parameter can be used in combination with the before_key or after_key parameters to iterate through paginated results.
query.after_key integer Optional Specifies which items to be returned by the API. When the after_key is specified, the API will return items beginning from the first item after the item specified. This parameter can be used in combination with limit to iterate through paginated results.
query.include_region boolean Optional Boolean indicating whether or not to return the IP Pool's region information in the response. default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "poolid": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add a Batch of IPs to an IP Pool — sendgrid.ip_address_management.addipstoippool

Run Add a Batch of IPs to an IP Pool with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.poolid string Required Specifies the unique ID for an IP Pool.
body object Optional
body.ips array Required An array of IP addresses to assign to the specified IP Pool. All assignments must succeed.
body.ips[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "poolid": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a Batch of IPs from an IP Pool — sendgrid.ip_address_management.deleteipsfromippool

Run Delete a Batch of IPs from an IP Pool with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.poolid string Required Specifies the unique ID for an IP Pool.
body object Optional
body.ips array Required An array of IP addresses to remove from the specified IP Pool.
body.ips[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "poolid": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Account IPs — sendgrid.ip_provisioning.listaccountips

Run List Account IPs with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.accountID string Required Twilio SendGrid account ID
query object Optional additionalProperties: false
query.limit integer Optional Number of items to return default: 10; minimum: 1; maximum: 5000
query.offset string Optional The last item successfully retrieved format: "ipv4"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "accountID": "sg1a2bcd3ef4ab5c67d8efab91c01de2fa"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add Account IPs — sendgrid.ip_provisioning.addaccountips

Run Add Account IPs with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.accountID string Required Twilio SendGrid account ID
body object Required Request to add IP addresses to an account. Maximum of 10 IPs per request, all from the same region.
body.count integer Required Number of IPs to add (maximum 10 per request) minimum: 1; maximum: 10
body.region — Required
body.region — Required allOf[1]; $ref: "#/definitions/Region1"
body.region string Required allOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "accountID": "sg1a2bcd3ef4ab5c67d8efab91c01de2fa"
  },
  "body": {
    "count": 2,
    "region": "us"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove Account IPs — sendgrid.ip_provisioning.removeaccountips

Run Remove Account IPs with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.accountID string Required Twilio SendGrid account ID
body object Required RemoveAccountIPsRequest
body.ips array Required List of specific IP addresses to remove (maximum 10 per request) minItems: 1; maxItems: 10
body.ips[] string Optional format: "ipv4"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "accountID": "sg1a2bcd3ef4ab5c67d8efab91c01de2fa"
  },
  "body": {
    "ips": [
      "174.0.0.3",
      "192.0.0.1"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Start warming up an IP address — sendgrid.ip_warmup.warmupip

Run Start warming up an IP address with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body object Optional
body.ip string Optional The IP address that you want to begin warming up.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve all IPs currently in warmup — sendgrid.ip_warmup.listwarmupip

Run Retrieve all IPs currently in warmup with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve the warmup status for a specific IP address — sendgrid.ip_warmup.getwarmupip

Run Retrieve the warmup status for a specific IP address with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.ip_address string Required The IP address that you want to retrieve the warmup status for.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "ip_address": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Stop warming up an IP address — sendgrid.ip_warmup.stopipwarmup

Run Stop warming up an IP address with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.ip_address string Required The IP address that you want to retrieve the warmup status for.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "ip_address": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve all IP addresses — sendgrid.ips.listip

Run Retrieve all IP addresses with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.ip string Optional The IP address to get
query.exclude_whitelabels boolean Optional Should we exclude reverse DNS records (whitelabels)?
query.limit integer Optional limit sets the page size, i.e. maximum number of items from the list to be returned for a single API request. If omitted, the default page size is used. default: 10; minimum: 1
query.offset integer Optional The number of items in the list to skip over before starting to retrieve the items for the requested page. The default offset of 0 represents the beginning of the list, i.e. the start of the first page. To request the second page of the list, set the offset to the page size as determined by limit. Use multiples of the page size as your offset to request further consecutive pages. E.g. assume your page size is set to 10. An offset of 10 requests the second page, an offset of 20 requests the third page and so on, provided there are sufficiently many items in your list. default: 0; minimum: 0
query.subuser string Optional The subuser you are requesting for.
query.sort_by_direction — Optional The direction to sort the results.
query.sort_by_direction — Optional allOf[1]; $ref: "#/definitions/SortByDirection"
query.sort_by_direction string Optional allOf[2]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an IP pool — sendgrid.ips.createippool

Run Create an IP pool with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body object Optional
body.name string Required The name of your new IP pool. maxLength: 64

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve all IP pools — sendgrid.ips.listippool

Run Retrieve all IP pools with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve all the IPs in a specified pool — sendgrid.ips.getippool

Run Retrieve all the IPs in a specified pool with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.pool_name string Required The name of the IP pool that you want to retrieve the IP addresses for.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "pool_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Rename an IP pool — sendgrid.ips.updateippool

Run Rename an IP pool with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.pool_name string Required The name of the IP pool that you want to retrieve the IP addresses for.
body object Optional
body.name string Optional The new name for your IP pool. maxLength: 64

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "pool_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an IP pool — sendgrid.ips.deleteippool

Run Delete an IP pool with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.pool_name string Required The name of the IP pool that you want to retrieve the IP addresses for.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "pool_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add an IP address to a pool — sendgrid.ips.addiptoippool

Run Add an IP address to a pool with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.pool_name string Required The name of the IP pool you want to add the address to. If the name contains spaces, they must be URL encoded (e.g., "Test Pool" becomes "Test%20Pool").
body object Optional
body.ip string Optional The IP address that you want to add to the named pool.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "pool_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove an IP address from a pool — sendgrid.ips.deleteipfromippool

Run Remove an IP address from a pool with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.pool_name string Required The name of the IP pool that you are removing the IP address from.
path.ip string Required The IP address that you wish to remove.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "pool_name": "example",
    "ip": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get remaining IPs count — sendgrid.ips.listremainingipcount

Run Get remaining IPs count with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a Campaign — sendgrid.lmc_campaigns.createcampaign

Run Create a Campaign with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.
body — Optional $ref: "#/definitions/PostCampaignsRequest"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve all Campaigns — sendgrid.lmc_campaigns.listcampaign

Run Retrieve all Campaigns with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional limit sets the page size, i.e. maximum number of items from the list to be returned for a single API request. If omitted, the default page size is used. default: 10; minimum: 1
query.offset integer Optional The number of items in the list to skip over before starting to retrieve the items for the requested page. The default offset of 0 represents the beginning of the list, i.e. the start of the first page. To request the second page of the list, set the offset to the page size as determined by limit. Use multiples of the page size as your offset to request further consecutive pages. E.g. assume your page size is set to 10. An offset of 10 requests the second page, an offset of 20 requests the third page and so on, provided there are sufficiently many items in your list. default: 0; minimum: 0
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve a single campaign — sendgrid.lmc_campaigns.getcampaign

Run Retrieve a single campaign with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.campaign_id integer Required The id of the campaign you would like to retrieve.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "campaign_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a Campaign — sendgrid.lmc_campaigns.deletecampaign

Run Delete a Campaign with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.campaign_id integer Required The id of the campaign you would like to retrieve.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "campaign_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a Campaign — sendgrid.lmc_campaigns.updatecampaign

Run Update a Campaign with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.campaign_id integer Required The id of the campaign you would like to retrieve.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.
body object Optional Update a Campaign request
body.title string Required The title of the campaign.
body.subject string Required The subject line for your campaign.
body.categories array Required The categories you want to tag on this campaign.
body.categories[] string Optional
body.html_content string Required The HTML content of this campaign.
body.plain_content string Required The plain content of this campaign.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "campaign_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Schedule a Campaign — sendgrid.lmc_campaigns.schedulecampaign

Run Schedule a Campaign with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.campaign_id integer Required
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.
body object Optional Schedule a Campaign request
body.send_at integer Required The unix timestamp for the date and time you would like your campaign to be sent out.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "campaign_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a Scheduled Campaign — sendgrid.lmc_campaigns.updatescheduledcampaign

Run Update a Scheduled Campaign with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.campaign_id integer Required
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.
body object Optional Update a Scheduled Campaign request
body.send_at integer Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "campaign_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

View Scheduled Time of a Campaign — sendgrid.lmc_campaigns.getscheduledcampaign

Run View Scheduled Time of a Campaign with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.campaign_id integer Required
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "campaign_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Unschedule a Scheduled Campaign — sendgrid.lmc_campaigns.unschedulecampaign

Run Unschedule a Scheduled Campaign with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.campaign_id integer Required
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "campaign_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Send a Campaign — sendgrid.lmc_campaigns.sendcampaign

Run Send a Campaign with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.campaign_id integer Required
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "campaign_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Send a Test Campaign — sendgrid.lmc_campaigns.sendtestcampaign

Run Send a Test Campaign with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.campaign_id integer Required
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.
body object Optional
body.to string Required The email address that should receive the test campaign. format: "email"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "campaign_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a Custom Field — sendgrid.lmc_contactdb.createcustomfield

Run Create a Custom Field with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.
body object Optional
body.name string Optional
body.type string Optional

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve all custom fields — sendgrid.lmc_contactdb.listcustomfield

Run Retrieve all custom fields with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve a Custom Field — sendgrid.lmc_contactdb.getcustomfield

Run Retrieve a Custom Field with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.custom_field_id integer Required The ID of the custom field that you want to retrieve.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "custom_field_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a Custom Field — sendgrid.lmc_contactdb.deletecustomfield

Run Delete a Custom Field with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.custom_field_id integer Required The ID of the custom field that you want to retrieve.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "custom_field_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a List — sendgrid.lmc_contactdb.createcontactdblist

Run Create a List with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.
body object Optional Create a List request
body.name string Required

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve all lists — sendgrid.lmc_contactdb.listcontactdblist

Run Retrieve all lists with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Multiple lists — sendgrid.lmc_contactdb.deletecontactdblists

Run Delete Multiple lists with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.
body array Optional
body[] integer Optional

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve a single list — sendgrid.lmc_contactdb.getcontactdblist

Run Retrieve a single list with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.list_id integer Required
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "list_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a List — sendgrid.lmc_contactdb.updatecontactdblist

Run Update a List with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.list_id integer Required
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.
body object Optional Update a List request
body.name string Required The new name for your list.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "list_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a List — sendgrid.lmc_contactdb.deletecontactdblist

Run Delete a List with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.list_id integer Required
query object Optional additionalProperties: false
query.delete_contacts — Optional Adds the ability to delete all contacts on the list in addition to deleting the list.
query.delete_contacts — Optional allOf[1]; $ref: "#/definitions/DeleteContacts"
query.delete_contacts boolean Optional allOf[2]
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "list_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve all recipients on a List — sendgrid.lmc_contactdb.listrecipientsfromcontactdblist

Run Retrieve all recipients on a List with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.list_id integer Required The id of the list of recipients you want to retrieve.
query object Optional additionalProperties: false
query.page integer Optional Page index of first recipient to return (must be a positive integer)
query.page_size integer Optional Number of recipients to return at a time (must be a positive integer between 1 and 1000)
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "list_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add Multiple Recipients to a List — sendgrid.lmc_contactdb.addrecipientstocontactdblist

Run Add Multiple Recipients to a List with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.list_id integer Required The id of the list of recipients you want to retrieve.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.
body array Optional
body[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "list_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add a Single Recipient to a List — sendgrid.lmc_contactdb.addrecipienttocontactdblist

Run Add a Single Recipient to a List with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.list_id integer Required The ID of the list that you want to add the recipient to.
path.recipient_id string Required The ID of the recipient you are adding to the list.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "list_id": 1,
    "recipient_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a Single Recipient from a Single List — sendgrid.lmc_contactdb.deleterecipientfromcontactdblist

Run Delete a Single Recipient from a Single List with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.list_id integer Required The ID of the list that you want to add the recipient to.
path.recipient_id string Required The ID of the recipient you are adding to the list.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "list_id": 1,
    "recipient_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add recipients — sendgrid.lmc_contactdb.addrecipient

Run Add recipients with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.
body array Optional
body[] object Optional
body[].email string Required The email address of the recipient. format: "email"
body[].first_name string Optional The first name of the recipient.
body[].last_name string Optional The last name of the recipient.
body[].age integer Optional

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Recipient — sendgrid.lmc_contactdb.updaterecipient

Run Update Recipient with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.
body array Optional
body[] object Optional
body[].email string Required format: "email"
body[].last_name string Optional The last name of the recipient. This is one of the default custom fields.
body[].first_name string Optional The first name of the recipient. This is one of the default custom fields.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Recipients — sendgrid.lmc_contactdb.deleterecipients

Run Delete Recipients with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.
body array Optional
body[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve recipients — sendgrid.lmc_contactdb.listrecipient

Run Retrieve recipients with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.page integer Optional Page index of first recipients to return (must be a positive integer)
query.page_size integer Optional Number of recipients to return at a time (must be a positive integer between 1 and 1000)
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve a single recipient — sendgrid.lmc_contactdb.getrecipient

Run Retrieve a single recipient with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.recipient_id string Required The ID of the recipient that you want to retrieve.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "recipient_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a Recipient — sendgrid.lmc_contactdb.deleterecipient

Run Delete a Recipient with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.recipient_id string Required The ID of the recipient that you want to retrieve.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "recipient_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve the lists that a recipient is on — sendgrid.lmc_contactdb.getrecipientlist

Run Retrieve the lists that a recipient is on with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.recipient_id string Required The ID of the recipient for whom you are retrieving lists.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "recipient_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve the count of billable recipients — sendgrid.lmc_contactdb.getbillable

Run Retrieve the count of billable recipients with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve a Count of Recipients — sendgrid.lmc_contactdb.listrecipientcount

Run Retrieve a Count of Recipients with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Search recipients — sendgrid.lmc_contactdb.listsearchrecipient

Run Search recipients with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.{field_name} string Optional
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Search recipients — sendgrid.lmc_contactdb.searchrecipient

Run Search recipients with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body object Optional
body.list_id integer Required
body.conditions array Required The conditions by which this segment should be created.
body.conditions[] — Optional $ref: "#/definitions/ContactdbSegmentsConditions"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve reserved fields — sendgrid.lmc_contactdb.listreservedfield

Run Retrieve reserved fields with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a Segment — sendgrid.lmc_contactdb.createsegment

Run Create a Segment with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.
body — Optional $ref: "#/definitions/ContactdbSegments"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve all segments — sendgrid.lmc_contactdb.listsegment

Run Retrieve all segments with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve a segment — sendgrid.lmc_contactdb.getsegment

Run Retrieve a segment with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.segment_id integer Required
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "segment_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a segment — sendgrid.lmc_contactdb.updatesegment

Run Update a segment with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.segment_id integer Required
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.
body object Optional
body.name string Required
body.list_id number Optional The list ID you would like this segment to be built from.
body.conditions array Optional The conditions by which this segment should be created.
body.conditions[] — Optional $ref: "#/definitions/ContactdbSegmentsConditions"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "segment_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a segment — sendgrid.lmc_contactdb.deletesegment

Run Delete a segment with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.segment_id integer Required
query object Optional additionalProperties: false
query.delete_contacts boolean Optional True to delete all contacts matching the segment in addition to deleting the segment
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "segment_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve recipients on a segment — sendgrid.lmc_contactdb.listrecipientforsegment

Run Retrieve recipients on a segment with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.segment_id integer Required The ID of the segment from which you want to retrieve recipients.
query object Optional additionalProperties: false
query.page integer Optional
query.page_size integer Optional
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "segment_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Recipient Upload Status — sendgrid.lmc_contactdb.liststatus

Run Get Recipient Upload Status with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Export Recipients — sendgrid.lmc_contactdb.exportrecipient

Run Export Recipients with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body object Optional
body.list_ids array Optional IDs of the recipient lists you want to export.
body.list_ids[] integer Optional
body.segment_ids array Optional IDs of the recipient segments you want to export.
body.segment_ids[] integer Optional
body.notifications object Optional
body.notifications.email boolean Optional
body.file_type — Optional
body.file_type — Optional allOf[1]; $ref: "#/definitions/FileType"
body.file_type string Optional allOf[2]; default: "csv"
body.max_file_size integer Optional The maximum size of an export file in MB. Note that when this option is specified, multiple output files may be returned from the export. default: 5000

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get All Existing Exports — sendgrid.lmc_contactdb.listexportrecipient

Run Get All Existing Exports with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Export Recipients Status — sendgrid.lmc_contactdb.getexportrecipient

Run Export Recipients Status with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a Sender Identity — sendgrid.lmc_senders.createsender

Run Create a Sender Identity with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.
body object Optional
body.nickname string Required A nickname for the sender identity. Not used for sending.
body.from object Optional
body.reply_to object Optional
body.address string Required The physical address of the sender identity.
body.address_2 string Optional Additional sender identity address information.
body.city string Required The city of the sender identity.
body.state string Optional The state of the sender identity.
body.zip string Optional The zipcode of the sender identity.
body.country string Required The country of the sender identity.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get all Sender Identities — sendgrid.lmc_senders.listsender

Run Get all Sender Identities with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

View a Sender Identity — sendgrid.lmc_senders.getsender

Run View a Sender Identity with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.sender_id integer Required The ID of the sender identity that you want to retrieve.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "sender_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a Sender Identity — sendgrid.lmc_senders.updatesender

Run Update a Sender Identity with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.sender_id integer Required The ID of the sender identity that you want to retrieve.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.
body — Optional $ref: "#/definitions/SenderIdRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "sender_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a Sender Identity — sendgrid.lmc_senders.deletesender

Run Delete a Sender Identity with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.sender_id integer Required The ID of the sender identity that you want to retrieve.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "sender_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Resend Sender Identity Verification — sendgrid.lmc_senders.resetsenderverification

Run Resend Sender Identity Verification with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.sender_id integer Required The ID of the sender identity for which you would like to resend a verification email.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "sender_id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get all details for the specified message ID. — sendgrid.logs.getmessagebyid

Run Get all details for the specified message ID. with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.sg_message_id string Required The ID of the message you are requesting details for.
query object Optional additionalProperties: false
query.subuser string Optional For requests authenticated as the parent account, this argument must be passed if the desired message belongs to a subuser.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "sg_message_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Search all messages using the provided query filters. — sendgrid.logs.listmessagesbyfilter

Run Search all messages using the provided query filters. with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required $ref: "#/definitions/EmailLogsGetMessagesByFilterRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {}
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve all mail settings — sendgrid.mail_settings.listmailsetting

Run Retrieve all mail settings with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional limit sets the page size, i.e. maximum number of items from the list to be returned for a single API request. If omitted, the default page size is used.
query.offset integer Optional The number of items in the list to skip over before starting to retrieve the items for the requested page. The default offset of 0 represents the beginning of the list, i.e. the start of the first page. To request the second page of the list, set the offset to the page size as determined by limit. Use multiples of the page size as your offset to request further consecutive pages. E.g. assume your page size is set to 10. An offset of 10 requests the second page, an offset of 20 requests the third page and so on, provided there are sufficiently many items in your list. default: 0; minimum: 0
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update address whitelist mail settings — sendgrid.mail_settings.updateaddresswhitelist

Run Update address whitelist mail settings with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.
body object Optional
body.enabled boolean Optional Indicates if your email address whitelist is enabled.
body.list array Optional Either a single email address that you want whitelisted or a domain, for which all email addresses belonging to this domain will be whitelisted.
body.list[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve address whitelist mail settings — sendgrid.mail_settings.listaddresswhitelist

Run Retrieve address whitelist mail settings with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Bounce Purge Mail Settings — sendgrid.mail_settings.updatebouncepurge

Run Update Bounce Purge Mail Settings with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.
body — Optional $ref: "#/definitions/MailSettingsBouncePurge"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve Bounce Purge Mail Settings — sendgrid.mail_settings.listbouncepurge

Run Retrieve Bounce Purge Mail Settings with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update footer mail settings — sendgrid.mail_settings.updatefooter

Run Update footer mail settings with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.
body — Optional $ref: "#/definitions/MailSettingsFooter"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve footer mail settings — sendgrid.mail_settings.listfooter

Run Retrieve footer mail settings with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update forward bounce mail settings — sendgrid.mail_settings.updateforwardbounce

Run Update forward bounce mail settings with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.
body — Optional $ref: "#/definitions/MailSettingsForwardBounce"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve forward bounce mail settings — sendgrid.mail_settings.listforwardbounce

Run Retrieve forward bounce mail settings with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update forward spam mail settings — sendgrid.mail_settings.updateforwardspam

Run Update forward spam mail settings with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.
body — Optional $ref: "#/definitions/MailSettingsForwardSpam"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve forward spam mail settings — sendgrid.mail_settings.listforwardspam

Run Retrieve forward spam mail settings with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update template mail settings — sendgrid.mail_settings.updatetemplate

Run Update template mail settings with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.
body object Optional
body.enabled boolean Optional Indicates if you want to enable the legacy email template mail setting.
body.html_content string Optional The new HTML content for your legacy email template.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve legacy template mail settings — sendgrid.mail_settings.listtemplate

Run Retrieve legacy template mail settings with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a batch ID. — sendgrid.mail.createmailbatch

Run Create a batch ID. with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional Use the on-behalf-of header to make API calls for a particular Subuser through the parent account. You can use this header to automate bulk updates or to administer a Subuser without changing the authentication in your code. You will use the parent account's API key when using this header.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Validate a batch ID. — sendgrid.mail.getmailbatch

Run Validate a batch ID. with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.batch_id string Required Set this parameter to the batch ID that's associated with the mail send you want to retrieve.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional Use the on-behalf-of header to make API calls for a particular Subuser through the parent account. You can use this header to automate bulk updates or to administer a Subuser without changing the authentication in your code. You will use the parent account's API key when using this header.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "batch_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Send Email with Twilio SendGrid. — sendgrid.mail.sendmail

Run Send Email with Twilio SendGrid. with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.Content-Encoding — Optional Use this header when sending a gzip compressed mail body. Mail body compression is available to some high volume accounts. Submit a request to support to have gzip enabled on your account.
headers.Content-Encoding — Optional allOf[1]; $ref: "#/definitions/ContentEncoding"
headers.Content-Encoding string Optional allOf[2]
body object Optional
body.personalizations array Required An array of messages and their metadata. Each object within the personalizations array can be thought of as a mail envelope—it defines who should receive an individual message and how that message should be handled. See Personalizations for more information. maxItems: 1000; uniqueItems: false
body.personalizations[] object Optional
body.personalizations[].from — Optional $ref: "#/definitions/MailFrom"
body.personalizations[].to array Required An array of recipients to whom the email will be sent. Each object in this array must contain a recipient's email address. Each object in the array may optionally contain a recipient's name.
body.personalizations[].to[] — Optional $ref: "#/definitions/MailTo"
body.personalizations[].cc array Optional An array of recipients to whom a copy of the email will be sent. Each object in this array must contain a recipient's email address. Each object in the array may optionally contain a recipient's name. maxItems: 1000
body.personalizations[].cc[] — Optional $ref: "#/definitions/MailTo"
body.personalizations[].bcc array Optional An array of recipients to whom a blind carbon copy of your email will be sent. Each object in this array must contain a recipient's email address. Each object in the array may optionally contain a recipient's name. maxItems: 1000
body.personalizations[].bcc[] — Optional $ref: "#/definitions/MailTo"
body.personalizations[].subject string Optional The subject of your email. See line length limits specified in RFC 2822 for guidance on subject line character limits. minLength: 1
body.personalizations[].headers object Optional A collection of JSON property name and property value pairs allowing you to specify handling instructions for your email. You may not override the following headers: x-sg-id, x-sg-eid, received, dkim-signature, Content-Type, Content-Transfer-Encoding, To, From, Subject, Reply-To, CC, BCC.
body.personalizations[].substitutions object Optional A collection property names that will be substituted by their corresponding property values in the subject, reply-to and content portions of your message. Name and value pairs follow the pattern "substitution_tag":"value to substitute". The total collective size of your substitutions may not exceed 100,000 bytes per personalization object. Substitutions allow you to insert data without using SendGrid's Dynamic Templates. This property should not be used in combination with a Dynamic Template, which can be identified by a template_id starting with d-. See Substitution Tags for more information. maxProperties: 10000; additionalProperties: {"type":"string"}
body.personalizations[].dynamic_template_data object Optional A collection property names that will be substituted by their corresponding property values in the subject, reply-to and content portions of a SendGrid Dynamic Template. Dynamic template data is available in a template using Handlebars syntax. This property should be used in combination with a Dynamic Template, which can be identified by a template_id starting with d-. See How to Send an Email with Dynamic Templates for more information.
body.personalizations[].custom_args object Optional Values that are specific to this personalization that will be carried along with the email and its activity data. Substitutions will not be made on custom arguments, so any string that is assigned to this property will be assumed to be the custom argument that you would like to be used. This field may not exceed 10,000 bytes. maxProperties: 10000
body.personalizations[].send_at integer Optional A unix timestamp allowing you to specify when your email should be sent. A send cannot be scheduled more than 72 hours in advance.
body.from — Required $ref: "#/definitions/MailFrom"
body.reply_to — Optional $ref: "#/definitions/MailTo"
body.reply_to_list array Optional An array of recipients to whom replies will be sent. Each object in this array must contain a recipient's email address. Each object in the array may optionally contain a recipient's name. You can use either the reply_to property or reply_to_list property but not both. maxItems: 1000; uniqueItems: true
body.reply_to_list[] — Optional $ref: "#/definitions/MailTo"
body.subject string Optional The global or message level subject of your email. Subject lines set in personalizations objects will override this global subject line. See line length limits specified in RFC 2822 for guidance on subject line character limits. minLength: 1
body.content array Optional An array of objects, each containing a message body's content and MIME type. You must specify at least one MIME type and may include multiple. To include more than one MIME type, add an object for each type to the array.
body.content[] object Optional
body.content[].type string Required The MIME type of the content assigned in the value property of this object (e.g., text/plain or text/html). minLength: 1
body.content[].value string Required The content of your message in the specified MIME type assigned in the type property of this object. minLength: 1
body.attachments array Optional An array of objects where you can define any attachments to be included with the message. Each object contains a content property, which must be a Base64 encoded string of the attachment itself, and type, filename, disposition, and content_id properties that tell SendGrid how to handle the attachment.
body.attachments[] object Optional
body.attachments[].content string Required The Base64 encoded content of the attachment. minLength: 1
body.attachments[].type string Optional The MIME type of the content you are attaching (e.g., image/jpeg or application/pdf). minLength: 1
body.attachments[].filename string Required The attachment's filename, including the file extension.
body.attachments[].disposition — Optional
body.attachments[].disposition — Optional allOf[1]; $ref: "#/definitions/Disposition"
body.attachments[].disposition string Optional allOf[2]; default: "attachment"
body.attachments[].content_id string Optional The attachment's content ID. The content_id is used when the disposition is set to inline and the attachment is an image, allowing the file to be displayed within the body of the email.
body.template_id string Optional An email template ID. A template that contains a subject and content—either text or html—will override any subject and content values specified at the personalizations or message level. If a template ID begins with d-, it is a dynamic template and will work with the dynamic_template_data property. If the template ID does not begin with d-, it is a standard SendGrid template and will work with the substitutions property. See How to Send an Email with Dynamic Templates for more information about working with templates.
body.headers object Optional A collection of JSON property name and property value pairs allowing you to specify handling instructions for your email. You may not override the following headers: x-sg-id, x-sg-eid, received, dkim-signature, Content-Type, Content-Transfer-Encoding, To, From, Subject, Reply-To, CC, BCC.
body.categories array Optional An array of category names assigned to this message. Categories allow you to group messages by categories you define. Categories should be used sparingly to create general groups that are relevant to you. Categories are not meant to be used to track individual mail sends. For more granular categorization and tracking, use the custom_args property. A category name cannot exceed 255 characters. See Working with Categories for more information. maxItems: 10; uniqueItems: true
body.categories[] string Optional maxLength: 255
body.custom_args string Optional Values that are specific to the entire send that will be carried along with the email and its activity data. Substitutions will not be made on custom arguments, so any string that is assigned to this property will be assumed to be the custom argument that you would like to be used. This parameter is overridden by custom_args set at the personalizations level. Total custom_args size may not exceed 10,000 bytes.
body.send_at integer Optional A unix timestamp allowing you to specify when your email should be sent. A send cannot be scheduled more than 72 hours in advance. This property may be overridden by the send_at property set at the personalizations level.
body.batch_id string Optional An ID representing a batch of emails to be sent at the same time. Including a batch_id in your request allows you to include this email in that batch. It also enables you to cancel or pause the delivery of that batch. See the Scheduled Sends API for more information about scheduling your email.
body.asm object Optional An object allowing you to specify how to handle unsubscribes. With SendGrid, an unsubscribe is the action an email recipient takes when they opt-out of receiving your messages. A suppression is the action you take as a sender to filter or suppress an unsubscribed address from your email send. From the perspective of the recipient, your suppression is the result of their unsubscribe. See Suppression Groups for more information.
body.asm.group_id integer Required The unsubscribe group to associate with this email. See the Suppressions API to manage unsubscribe group IDs.
body.asm.groups_to_display array Optional An array containing the unsubscribe groups that you would like to be displayed to a recipient on the unsubscribe preferences page. This page is displayed in the recipient's browser when they click the unsubscribe link in your message. maxItems: 25
body.asm.groups_to_display[] integer Optional
body.ip_pool_name string Optional The IP Pool that you would like to send this email from. IP Pools allow you to group your dedicated Twilio SendGrid IP addresses in order to have more control over your deliverability. See IP Pools for more information. minLength: 2; maxLength: 64
body.mail_settings object Optional A collection of different mail settings that you can use to specify how you would like this email to be handled. Mail settings provide extra functionality to your mail send. See Mail Settings for more information.
body.mail_settings.bypass_list_management object Optional Allows you to bypass all unsubscribe groups and suppressions to ensure that the email is delivered to every single recipient. This should only be used in emergencies when it is absolutely necessary that every recipient receives your email. This filter cannot be combined with any other bypass filters. See the the "Bypass suppressions" section of our Suppressions Overview for more about bypass filters.
body.mail_settings.bypass_list_management.enable boolean Optional Indicates if this setting is enabled.
body.mail_settings.bypass_spam_management object Optional Allows you to bypass the spam report list to ensure that the email is delivered to recipients. Bounce and unsubscribe lists will still be checked; addresses on these other lists will not receive the message. This filter cannot be combined with the bypass_list_management filter. See the the "Bypass suppressions" section of our Suppressions Overview for more about bypass filters.
body.mail_settings.bypass_spam_management.enable boolean Optional Indicates if this setting is enabled.
body.mail_settings.bypass_bounce_management object Optional Allows you to bypass the bounce list to ensure that the email is delivered to recipients. Spam report and unsubscribe lists will still be checked; addresses on these other lists will not receive the message. This filter cannot be combined with the bypass_list_management filter. See the the "Bypass suppressions" section of our Suppressions Overview for more about bypass filters.
body.mail_settings.bypass_bounce_management.enable boolean Optional Indicates if this setting is enabled.
body.mail_settings.bypass_unsubscribe_management object Optional Allows you to bypass the global unsubscribe list to ensure that the email is delivered to recipients. Bounce and spam report lists will still be checked; addresses on these other lists will not receive the message. This filter applies only to global unsubscribes and will not bypass group unsubscribes. This filter cannot be combined with the bypass_list_management filter. See the the "Bypass suppressions" section of our Suppressions Overview for more about bypass filters.
body.mail_settings.bypass_unsubscribe_management.enable boolean Optional Indicates if this setting is enabled.
body.mail_settings.footer object Optional Inserts a custom footer at the bottom of the text and HTML bodies of your messages. Use the html and text properties to include the content of the footers to be inserted.
body.mail_settings.footer.enable boolean Optional Indicates if this setting is enabled.
body.mail_settings.footer.text string Optional The plain text content of your footer.
body.mail_settings.footer.html string Optional The HTML content of your footer.
body.mail_settings.sandbox_mode object Optional Sandbox Mode allows you to send a test email to ensure that your request body is valid and formatted correctly.
body.mail_settings.sandbox_mode.enable boolean Optional Indicates if this setting is enabled.
body.tracking_settings object Optional Settings to determine how you would like to track the metrics of how your recipients interact with your email. See Tracking Settings for more information.
body.tracking_settings.click_tracking object Optional Allows you to track if a recipient clicked a link in your email.
body.tracking_settings.click_tracking.enable boolean Optional Indicates if this setting is enabled.
body.tracking_settings.click_tracking.enable_text boolean Optional Indicates if this setting should be included in the text/plain portion of your email.
body.tracking_settings.open_tracking object Optional Allows you to track if the email was opened by including a single transparent pixel image in the body of the message content. When the message is opened, a request for the pixel is sent. That request indicates to Twilio SendGrid that the message was opened.
body.tracking_settings.open_tracking.enable boolean Optional Indicates if this setting is enabled.
body.tracking_settings.open_tracking.substitution_tag string Optional Allows you to specify a substitution tag that you can insert in the body of your email at a location that you desire. This tag will be replaced by the open tracking pixel.
body.tracking_settings.subscription_tracking object Optional Allows you to insert a subscription management link at the bottom of the text and HTML bodies of your email. If you would like to specify the location of the link within your email, you may use the substitution_tag property.
body.tracking_settings.subscription_tracking.enable boolean Optional Indicates if this setting is enabled.
body.tracking_settings.subscription_tracking.text string Optional Text to be appended to the email with the subscription tracking link.
body.tracking_settings.subscription_tracking.html string Optional HTML to be appended to the email with the subscription tracking link.
body.tracking_settings.subscription_tracking.substitution_tag string Optional A tag that will be replaced with the unsubscribe URL. If this property is used, it will override both the text and html properties. The URL of the link will be placed at the substitution tag's location in the message body with no additional formatting.
body.tracking_settings.ganalytics object Optional Allows you to enable tracking provided by Google Analytics. See Google Analytics and SendGrid Statistics for more information about this property.
body.tracking_settings.ganalytics.enable boolean Optional Indicates if this setting is enabled.
body.tracking_settings.ganalytics.utm_source string Optional Name of the referrer source. (e.g., Google, SomeDomain.com, or Marketing Email)
body.tracking_settings.ganalytics.utm_medium string Optional Name of the marketing medium. (e.g., Email)
body.tracking_settings.ganalytics.utm_term string Optional Used to identify any paid keywords.
body.tracking_settings.ganalytics.utm_content string Optional Used to differentiate your campaign from advertisements.
body.tracking_settings.ganalytics.utm_campaign string Optional The name of the campaign.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add or Update a Contact — sendgrid.mc_contacts.updatecontact

Run Add or Update a Contact with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body object Optional
body.list_ids array Optional An array of List ID strings that this contact will be added to.
body.list_ids[] string Optional format: "uuid"
body.contacts array Required One or more contacts objects that you intend to upsert. Each contact needs to include at least one of email, phone_number_id, external_id, or anonymous_id as an identifier. minItems: 1; maxItems: 30000
body.contacts[] — Optional $ref: "#/definitions/ContactRequest"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Contacts — sendgrid.mc_contacts.deletecontact

Run Delete Contacts with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.delete_all_contacts string Optional Must be set to "true" to delete all contacts.
query.ids string Optional A comma-separated list of contact IDs.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Sample Contacts — sendgrid.mc_contacts.listcontact

Run Get Sample Contacts with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a Contact by ID — sendgrid.mc_contacts.getcontact

Run Get a Contact by ID with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Batched Contacts by IDs — sendgrid.mc_contacts.listbatchedcontact

Run Get Batched Contacts by IDs with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body object Optional Array of IDs
body.ids array Required maxItems: 100
body.ids[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a Contact Identifier — sendgrid.mc_contacts.deletecontactidentifier

Run Delete a Contact Identifier with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.contact_id string Required Must be set to the contact_id of the contact you want to remove the identifier from.
body object Optional
body.identifier_type — Required
body.identifier_type — Required allOf[1]; $ref: "#/definitions/IdentifierType"
body.identifier_type string Required allOf[2]
body.identifier_value string Required The value of the identifier you want to remove from the contact.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "contact_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Total Contact Count — sendgrid.mc_contacts.listcontactcount

Run Get Total Contact Count with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Export Contacts — sendgrid.mc_contacts.exportcontact

Run Export Contacts with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body object Optional
body.list_ids array Optional IDs of the contact lists you want to export.
body.list_ids[] string Optional format: "uuid"
body.segment_ids array Optional IDs of the contact segments you want to export.
body.segment_ids[] string Optional
body.notifications object Optional
body.notifications.email boolean Optional
body.file_type — Optional
body.file_type — Optional allOf[1]; $ref: "#/definitions/FileType"
body.file_type string Optional allOf[2]; default: "csv"
body.max_file_size integer Optional The maximum size of an export file in MB. Note that when this option is specified, multiple output files may be returned from the export. default: 5000

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get All Existing Exports — sendgrid.mc_contacts.listexportcontact

Run Get All Existing Exports with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Export Contacts Status — sendgrid.mc_contacts.getexportcontact

Run Export Contacts Status with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Import Contacts — sendgrid.mc_contacts.importcontact

Run Import Contacts with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body object Optional
body.list_ids array Optional All contacts will be added to each of the specified lists.
body.list_ids[] string Optional
body.file_type — Required
body.file_type — Required allOf[1]; $ref: "#/definitions/FileType1"
body.file_type string Required allOf[2]
body.field_mappings array Required Import file header to reserved/custom field mapping. minItems: 1; uniqueItems: false
body.field_mappings[] string | null Optional

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Import Contacts Status — sendgrid.mc_contacts.getimportcontact

Run Import Contacts Status with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Search Contacts — sendgrid.mc_contacts.searchcontact

Run Search Contacts with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body object Optional
body.query string Required An SGQL search string or other pattern.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Contacts by Emails — sendgrid.mc_contacts.listcontactbyemail

Run Get Contacts by Emails with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body object Optional
body.emails array Required One or more primary and/or alternate email addresses to search for in your Marketing Campaigns contacts.
body.emails[] string Optional maxLength: 100
body.phone_number_id string Optional The contact's Phone Number ID. This is required to be a valid phone number.
body.external_id string Optional The contact's External ID. maxLength: 254
body.anonymous_id string Optional The contact's Anonymous ID. maxLength: 254

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Contacts by Identifiers — sendgrid.mc_contacts.getcontactbyidentifiers

Run Get Contacts by Identifiers with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.identifier_type — Required The type of identifier to search for. You can use only one type of identifier per search.
path.identifier_type — Required allOf[1]; $ref: "#/definitions/IdentifierType1"
path.identifier_type string Required allOf[2]
body object Optional
body.identifiers array Required One or more more identifier values of the given identifier type to search for in your Marketing Campaigns contacts.
body.identifiers[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "identifier_type": "email"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Custom Field Definition — sendgrid.mc_custom_fields.createfielddefinition

Run Create Custom Field Definition with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body object Optional
body.name string Required minLength: 1; maxLength: 100
body.field_type — Required
body.field_type — Required allOf[1]; $ref: "#/definitions/FieldType"
body.field_type string Required allOf[2]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get All Field Definitions — sendgrid.mc_custom_fields.listfielddefinition

Run Get All Field Definitions with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Custom Field Definition — sendgrid.mc_custom_fields.updatefielddefinition

Run Update Custom Field Definition with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.custom_field_id string Required
body object Optional
body.name string Required minLength: 1; maxLength: 100

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "custom_field_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Custom Field Definition — sendgrid.mc_custom_fields.deletefielddefinition

Run Delete Custom Field Definition with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.custom_field_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "custom_field_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Design — sendgrid.mc_designs.createdesign

Run Create Design with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Optional $ref: "#/definitions/DesignInput"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

List Designs — sendgrid.mc_designs.listdesign

Run List Designs with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.page_size integer Optional number of results to return default: 100; minimum: 0
query.page_token string Optional token corresponding to a specific page of results, as provided by metadata
query.summary boolean Optional set to false to return all fields default: true

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Duplicate Design — sendgrid.mc_designs.duplicatedesign

Run Duplicate Design with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required The ID of the Design you want to duplicate. format: "uuid"
body — Optional $ref: "#/definitions/DesignDuplicateInput"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Design — sendgrid.mc_designs.getdesign

Run Get Design with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required The ID of the Design you want to duplicate. format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Design — sendgrid.mc_designs.updatedesign

Run Update Design with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required The ID of the Design you want to duplicate. format: "uuid"
body object Optional
body.name string Optional Name of the Design. default: "My Design"; maxLength: 100
body.html_content string Optional The HTML content of the Design. maxLength: 1048576
body.plain_content string Optional Plain text content of the Design. default: "<generated from html_content if left empty>"; maxLength: 1048576
body.generate_plain_content boolean Optional If true, plain_content is always generated from html_content. If false, plain_content is not altered. default: true
body.subject string Optional Subject of the Design. maxLength: 5000
body.categories array Optional The list of categories applied to the design maxItems: 10; uniqueItems: true
body.categories[] string Optional maxLength: 255

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Design — sendgrid.mc_designs.deletedesign

Run Delete Design with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required The ID of the Design you want to duplicate. format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List SendGrid Pre-built Designs — sendgrid.mc_designs.listprebuiltdesign

Run List SendGrid Pre-built Designs with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.page_size integer Optional number of results to return default: 100; minimum: 0
query.page_token string Optional token corresponding to a specific page of results, as provided by metadata
query.summary boolean Optional set to false to return all fields default: true

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Duplicate SendGrid Pre-built Design — sendgrid.mc_designs.duplicateprebuiltdesign

Run Duplicate SendGrid Pre-built Design with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required The ID of the pre-built Design you want to duplicate. format: "uuid"
body — Optional $ref: "#/definitions/DesignDuplicateInput"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get SendGrid Pre-built Design — sendgrid.mc_designs.getprebuiltdesign

Run Get SendGrid Pre-built Design with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required The ID of the pre-built Design you want to duplicate. format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create List — sendgrid.mc_lists.createmarketinglist

Run Create List with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body object Optional
body.name string Required Your name for your list minLength: 1; maxLength: 100

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get All Lists — sendgrid.mc_lists.listmarketinglist

Run Get All Lists with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.page_size number Optional Maximum number of elements to return. Defaults to 100, returns 1000 max default: 100; minimum: 1; maximum: 1000
query.page_token string Optional

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a List by ID — sendgrid.mc_lists.getmarketinglist

Run Get a List by ID with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required The ID of the list on which you want to perform the operation.
query object Optional additionalProperties: false
query.contact_sample boolean Optional Setting this parameter to the true will cause the contact_sample to be returned default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update List — sendgrid.mc_lists.updatemarketinglist

Run Update List with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required The ID of the list on which you want to perform the operation.
body object Optional
body.name string Optional Your name for your list.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a list — sendgrid.mc_lists.deletemarketinglist

Run Delete a list with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required The ID of the list on which you want to perform the operation.
query object Optional additionalProperties: false
query.delete_contacts boolean Optional Flag indicates that all contacts on the list are also to be deleted. default: false

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Remove Contacts from a List — sendgrid.mc_lists.deletecontact

Run Remove Contacts from a List with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required The ID of the list on which you want to perform the operation.
query object Required additionalProperties: false
query.contact_ids string Required Comma separated list of contact IDs that you want to remove from the specified contacts list. minLength: 1

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "example"
  },
  "query": {
    "contact_ids": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get List Contact Count — sendgrid.mc_lists.listcontactcount

Run Get List Contact Count with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Segment — sendgrid.mc_segments_2.0.createsegment

Run Create Segment with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Optional $ref: "#/definitions/SegmentWriteV2"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get List of Segments — sendgrid.mc_segments_2.0.listsegment

Run Get List of Segments with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.ids array Optional A list of segment IDs to retrieve. When this parameter is included, the no_parent_list_ids and parent_list_ids parameters are ignored and only segments with given IDs are returned.
query.ids[] string Optional
query.parent_list_ids string Optional A comma separated list up to 50 in size, to filter segments on. Only segments that have any of these list ids as the parent list will be retrieved. This is different from the parameter of the same name used when creating a segment.
query.no_parent_list_id boolean Optional If set to true, segments with an empty value of parent_list_id will be returned in the filter. If the value is not present, it defaults to 'false'. default: false

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Segment — sendgrid.mc_segments_2.0.updatesegment

Run Update Segment with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.segment_id string Required
body — Optional $ref: "#/definitions/SegmentUpdate"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "segment_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Segment by ID — sendgrid.mc_segments_2.0.getsegment

Run Get Segment by ID with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.segment_id string Required
query object Optional additionalProperties: false
query.contacts_sample boolean Optional Defaults to true. Set to false to exclude the contacts_sample in the response.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "segment_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete segment — sendgrid.mc_segments_2.0.deletesegment

Run Delete segment with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.segment_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "segment_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Manually refresh a segment — sendgrid.mc_segments_2.0.refreshsegment

Run Manually refresh a segment with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.segment_id string Required minLength: 36; maxLength: 36; format: "uuid"
body — Required $ref: "#/definitions/SegmentRefreshRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "segment_id": "00000000-0000-4000-8000-000000000000"
  },
  "body": {
    "user_time_zone": "America/Chicago"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get List of Segments — sendgrid.mc_segments.listsegment

Run Get List of Segments with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.ids array Optional A list of segment IDs to retrieve. When this parameter is included, the no_parent_list_ids and parent_list_ids parameters are ignored and only segments with given IDs are returned.
query.ids[] string Optional
query.parent_list_ids string Optional A comma separated list of list ids to be used when searching for segments with the specified parent_list_id, no more than 50 is allowed
query.no_parent_list_id boolean Optional If set to true segments with an empty value of parent_list_id will be returned in the filter. If the value is not present it defaults to 'false'. default: false

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Segment by ID — sendgrid.mc_segments.getsegment

Run Get Segment by ID with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.segment_id string Required minLength: 36; maxLength: 36; format: "uuid"
query object Optional additionalProperties: false
query.query_json boolean Optional Defaults to false. Set to true to return the parsed SQL AST as a JSON object in the field query_json

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "segment_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Segment — sendgrid.mc_segments.deletesegment

Run Delete Segment with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.segment_id string Required minLength: 36; maxLength: 36; format: "uuid"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "segment_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a Sender — sendgrid.mc_senders.createsender

Run Create a Sender with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.
body object Optional
body.nickname string Required A nickname for the Sender. Not used for sending.
body.from object Required
body.from.email string Required The email address from which your recipient will receive emails.
body.from.name string Required The name appended to the from email field. Typically your name or company name.
body.reply_to object Required
body.reply_to.email string Required The email address to which your recipient will reply.
body.reply_to.name string Optional The name appended to the reply to email field. Typically your name or company name.
body.address string Required The physical address of the Sender.
body.address_2 string Optional Additional Sender address information.
body.city string Required The city of the Sender.
body.state string Optional The state of the Sender.
body.zip string Optional The zipcode of the Sender.
body.country string Required The country of the Sender.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a list of all Senders — sendgrid.mc_senders.listsender

Run Get a list of all Senders with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a specific Sender — sendgrid.mc_senders.getsender

Run Get a specific Sender with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.
path object Required additionalProperties: false
path.id integer Required The unique identifier of the Sender.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a Sender — sendgrid.mc_senders.updatesender

Run Update a Sender with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.
path object Required additionalProperties: false
path.id integer Required The unique identifier of the Sender.
body — Optional $ref: "#/definitions/SenderRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a Sender — sendgrid.mc_senders.deletesender

Run Delete a Sender with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.
path object Required additionalProperties: false
path.id integer Required The unique identifier of the Sender.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Resend a Sender verification — sendgrid.mc_senders.resetsenderverification

Run Resend a Sender verification with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.
path object Required additionalProperties: false
path.id integer Required The unique identifier of the Sender.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Single Send — sendgrid.mc_singlesends.createsinglesend

Run Create Single Send with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Optional $ref: "#/definitions/SinglesendRequest"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get All Single Sends — sendgrid.mc_singlesends.listsinglesend

Run Get All Single Sends with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.page_size integer Optional
query.page_token string Optional

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Bulk Delete Single Sends — sendgrid.mc_singlesends.deletesinglesends

Run Bulk Delete Single Sends with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.ids array Optional Single Send IDs to delete minItems: 1; maxItems: 50
query.ids[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Duplicate Single Send — sendgrid.mc_singlesends.duplicatesinglesend

Run Duplicate Single Send with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required
body object Optional
body.name string Optional The name of the duplicate Single Send. If you choose to leave the name field blank, your duplicate will be assigned the name of the Single Send it was copied from with the text 'Copy of ' prepended to it. The end of the new Single Send name, including 'Copy of ', will be trimmed if the name exceeds the character limit. minLength: 1; maxLength: 100

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Single Send — sendgrid.mc_singlesends.updatesinglesend

Run Update Single Send with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required
body — Optional $ref: "#/definitions/SinglesendRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Single Send by ID — sendgrid.mc_singlesends.getsinglesend

Run Get Single Send by ID with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Single Send by ID — sendgrid.mc_singlesends.deletesinglesend

Run Delete Single Send by ID with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Schedule Single Send — sendgrid.mc_singlesends.schedulesinglesend

Run Schedule Single Send with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required
body object Optional
body.send_at string Required The ISO 8601 time at which to send the Single Send. This must be in future or the string now. SendGrid Mail Send emails can be scheduled up to 72 hours in advance. However, this scheduling constraint does not apply to emails sent via Marketing Campaigns. format: "date-time"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Single Send Schedule — sendgrid.mc_singlesends.deletescheduledsinglesend

Run Delete Single Send Schedule with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get All Categories — sendgrid.mc_singlesends.listcategory

Run Get All Categories with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Single Sends Search — sendgrid.mc_singlesends.searchsinglesend

Run Get Single Sends Search with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.page_size integer Optional
query.page_token string Optional
body — Optional $ref: "#/definitions/SinglesendSearch"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get All Automation Stats — sendgrid.mc_stats.listautomationstat

Run Get All Automation Stats with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.automation_ids array Optional This endpoint returns all automation IDs if no automation_ids are specified. minItems: 1; maxItems: 25
query.automation_ids[] string Optional
query.page_size integer Optional The number of elements you want returned on each page. default: 25; minimum: 1; maximum: 50
query.page_token string Optional The stats endpoints are paginated. To get the next page, call the passed _metadata.next URL. If _metadata.prev doesn't exist, you're at the first page. Similarly, if _metadata.next is not present, you're at the last page.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Automation Stats by ID — sendgrid.mc_stats.getautomationstat

Run Get Automation Stats by ID with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required The ID of the Automation for which you want to retrieve statistics.
query object Optional additionalProperties: false
query.group_by array Optional Automations can have multiple steps. Including step_id as a group_by metric allows further granularity of stats.
query.group_by[] — Optional
query.group_by[] — Optional allOf[1]; $ref: "#/definitions/Items"
query.group_by[] string Optional allOf[2]
query.step_ids array Optional Comma-separated list of step_ids that you want the link stats for. uniqueItems: true
query.step_ids[] string Optional format: "uuid"
query.aggregated_by — Optional Dictates how the stats are time-sliced. Currently, "total" and "day" are supported.
query.aggregated_by — Optional allOf[1]; $ref: "#/definitions/AggregatedBy"
query.aggregated_by string Optional allOf[2]; default: "total"
query.start_date string Optional Format: YYYY-MM-DD. If this parameter is included, the stats' start date is included in the search. default: "2021-01-01"; format: "date"
query.end_date string Optional Format: YYYY-MM-DD.If this parameter is included, the stats' end date is included in the search. default: "2021-12-31"; format: "date"
query.timezone string Optional IANA Area/Region string representing the timezone in which the stats are to be presented, e.g., "America/Chicago". default: "UTC"
query.page_size integer Optional The number of elements you want returned on each page. default: 25; minimum: 1; maximum: 50
query.page_token string Optional The stats endpoints are paginated. To get the next page, call the passed _metadata.next URL. If _metadata.prev doesn't exist, you're at the first page. Similarly, if _metadata.next is not present, you're at the last page.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Automation Click Tracking Stats by ID — sendgrid.mc_stats.listclicktrackingstat

Run Get Automation Click Tracking Stats by ID with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required The ID of the Automation you want to get click tracking stats for. format: "uuid"
query object Optional additionalProperties: false
query.group_by array Optional Automations can have multiple steps. Including step_id as a group_by metric allows further granularity of stats.
query.group_by[] — Optional
query.group_by[] — Optional allOf[1]; $ref: "#/definitions/Items"
query.group_by[] string Optional allOf[2]
query.step_ids array Optional Comma-separated list of step_ids that you want the link stats for. uniqueItems: true
query.step_ids[] string Optional format: "uuid"
query.page_size integer Optional The number of elements you want returned on each page. default: 25; minimum: 1; maximum: 50
query.page_token string Optional The stats endpoints are paginated. To get the next page, call the passed _metadata.next URL. If _metadata.prev doesn't exist, you're at the first page. Similarly, if _metadata.next is not present, you're at the last page.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Export Single Send Stats — sendgrid.mc_stats.exportautomationstat

Run Export Single Send Stats with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.ids array Optional The IDs of Single Sends for which to export stats. minItems: 1; maxItems: 50
query.ids[] string Optional
query.timezone string Optional The IANA Area/Region string representing the timezone in which the stats are to be presented; i.e. "America/Chicago". This parameter changes the timezone format only; it does not alter which stats are returned. default: "UTC"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get All Single Sends Stats — sendgrid.mc_stats.listsinglesendstat

Run Get All Single Sends Stats with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.singlesend_ids array Optional This endpoint returns all Single Send IDs if no IDs are included in singlesend_ids. minItems: 1; maxItems: 25
query.singlesend_ids[] string Optional
query.page_size integer Optional The number of elements you want returned on each page. default: 25; minimum: 1; maximum: 50
query.page_token string Optional The stats endpoints are paginated. To get the next page, call the passed _metadata.next URL. If _metadata.prev doesn't exist, you're at the first page. Similarly, if _metadata.next is not present, you're at the last page.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Single Send Stats by ID — sendgrid.mc_stats.getsinglesendstat

Run Get Single Send Stats by ID with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required The ID of Single Send for which you want to retrieve stats.
query object Optional additionalProperties: false
query.aggregated_by — Optional Dictates how the stats are time-sliced. Currently, "total" and "day" are supported.
query.aggregated_by — Optional allOf[1]; $ref: "#/definitions/AggregatedBy"
query.aggregated_by string Optional allOf[2]; default: "total"
query.start_date string Optional Format: YYYY-MM-DD. If this parameter is included, the stats' start date is included in the search. default: "2021-01-01"; format: "date"
query.end_date string Optional Format: YYYY-MM-DD.If this parameter is included, the stats' end date is included in the search. default: "2021-12-31"; format: "date"
query.timezone string Optional IANA Area/Region string representing the timezone in which the stats are to be presented, e.g., "America/Chicago". default: "UTC"
query.page_size integer Optional The number of elements you want returned on each page. default: 25; minimum: 1; maximum: 50
query.page_token string Optional The stats endpoints are paginated. To get the next page, call the passed _metadata.next URL. If _metadata.prev doesn't exist, you're at the first page. Similarly, if _metadata.next is not present, you're at the last page.
query.group_by array Optional A/B Single Sends have multiple variation IDs and phase IDs. Including these additional fields allows further granularity of stats by these fields.
query.group_by[] — Optional
query.group_by[] — Optional allOf[1]; $ref: "#/definitions/Items1"
query.group_by[] string Optional allOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Single Send Click Tracking Stats by ID — sendgrid.mc_stats.listsinglesendtrackingstat

Run Get Single Send Click Tracking Stats by ID with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required The ID of Single Send for which you want to retrieve link stats.
query object Optional additionalProperties: false
query.page_size integer Optional The number of elements you want returned on each page. default: 25; minimum: 1; maximum: 50
query.page_token string Optional The stats endpoints are paginated. To get the next page, call the passed _metadata.next URL. If _metadata.prev doesn't exist, you're at the first page. Similarly, if _metadata.next is not present, you're at the last page.
query.group_by array Optional A/B Single Sends have multiple variation IDs and phase IDs. Including these additional fields allows further granularity of stats by these fields.
query.group_by[] — Optional
query.group_by[] — Optional allOf[1]; $ref: "#/definitions/Items2"
query.group_by[] string Optional allOf[2]
query.ab_variation_id string Optional format: "uuid"
query.ab_phase_id — Optional
query.ab_phase_id — Optional allOf[1]; $ref: "#/definitions/AbPhaseId"
query.ab_phase_id string Optional allOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Export Single Send Stats — sendgrid.mc_stats.exportsinglesendstat

Run Export Single Send Stats with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.ids array Optional The IDs of Single Sends for which to export stats. minItems: 1; maxItems: 50
query.ids[] string Optional
query.timezone string Optional The IANA Area/Region string representing the timezone in which the stats are to be presented; i.e. "America/Chicago". This parameter changes the timezone format only; it does not alter which stats are returned. default: "UTC"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Send a Test Marketing Email — sendgrid.mc_test.sendtestmarketingemail

Run Send a Test Marketing Email with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body object Optional
body.template_id string Required The ID of the template that you would like to use. If you use a template that contains a subject and content (either text or HTML), then those values specified at the personalizations or message level will not be used. format: "uuid"
body.version_id_override string Optional You can override the active template with an alternative template version by passing the version ID in this field. If this field is blank, the active template version will be used. format: "uuid"
body.sender_id integer Optional This ID must belong to a verified sender. Alternatively, you may supply a from_address email.
body.custom_unsubscribe_url string Optional A custom unsubscribe URL.
body.suppression_group_id integer Optional
body.emails array Required An array of email addresses you want to send the test message to. minItems: 1; maxItems: 10; uniqueItems: true
body.emails[] string Optional format: "email"
body.from_address string Optional You can either specify this address or specify a verified sender ID. format: "email"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Returns a list of all partner settings. — sendgrid.partner.listpartnersetting

Run Returns a list of all partner settings. with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional limit sets the page size, i.e. maximum number of items from the list to be returned for a single API request. If omitted, the default page size is used.
query.offset integer Optional The number of items in the list to skip over before starting to retrieve the items for the requested page. The default offset of 0 represents the beginning of the list, i.e. the start of the first page. To request the second page of the list, set the offset to the page size as determined by limit. Use multiples of the page size as your offset to request further consecutive pages. E.g. assume your page size is set to 10. An offset of 10 requests the second page, an offset of 20 requests the third page and so on, provided there are sufficiently many items in your list. default: 0; minimum: 0
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Erase recipients' email data — sendgrid.recipients_data_erasure.eraserecipientemaildata

Run Erase recipients' email data with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.
body — Required $ref: "#/definitions/RecipientsDataErasureEraseRecipientsRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "email_addresses": [
      "[email protected]",
      "[email protected]"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Set up reverse DNS — sendgrid.reverse_dns.setupreversedns

Run Set up reverse DNS with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.
body object Optional
body.ip string Required The IP address for which you want to set up reverse DNS.
body.subdomain string Optional The subdomain that will be used to send emails from the IP address. This should be the same as the subdomain used to set up an authenticated domain.
body.domain string Required The root, or sending, domain that will be used to send message from the IP address.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve all reverse DNS records — sendgrid.reverse_dns.listreversedns

Run Retrieve all reverse DNS records with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional limit sets the page size, i.e. maximum number of items from the list to be returned for a single API request. If omitted, the default page size is used.
query.offset integer Optional The number of items in the list to skip over before starting to retrieve the items for the requested page. The default offset of 0 represents the beginning of the list, i.e. the start of the first page. To request the second page of the list, set the offset to the page size as determined by limit. Use multiples of the page size as your offset to request further consecutive pages. E.g. assume your page size is set to 10. An offset of 10 requests the second page, an offset of 20 requests the third page and so on, provided there are sufficiently many items in your list. default: 0; minimum: 0
query.ip string Optional The IP address segment that you'd like to use in a prefix search.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve a reverse DNS record — sendgrid.reverse_dns.getreversedns

Run Retrieve a reverse DNS record with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required The ID of the reverse DNS record that you would like to retrieve.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a reverse DNS record — sendgrid.reverse_dns.deletereversedns

Run Delete a reverse DNS record with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required The ID of the reverse DNS record that you would like to retrieve.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Validate a reverse DNS record — sendgrid.reverse_dns.validatereversedns

Run Validate a reverse DNS record with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required The ID of the reverse DNS record that you would like to validate.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Cancel or pause a scheduled send — sendgrid.scheduled_sends.createscheduledsend

Run Cancel or pause a scheduled send with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.
body object Optional Cancel or pause a scheduled send request
body.batch_id string Required The batch ID is the identifier that your scheduled mail sends share. pattern: "^[a-zA-Z0-9]"
body.status — Required
body.status — Required allOf[1]; $ref: "#/definitions/Status"
body.status string Required allOf[2]; default: "pause"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve all scheduled sends — sendgrid.scheduled_sends.listscheduledsend

Run Retrieve all scheduled sends with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve scheduled send — sendgrid.scheduled_sends.getscheduledsend

Run Retrieve scheduled send with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.batch_id string Required
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "batch_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a scheduled send — sendgrid.scheduled_sends.updatescheduledsend

Run Update a scheduled send with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.batch_id string Required
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.
body object Optional
body.status — Required
body.status — Required allOf[1]; $ref: "#/definitions/Status1"
body.status string Required allOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "batch_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a cancellation or pause from a scheduled send — sendgrid.scheduled_sends.deletescheduledsend

Run Delete a cancellation or pause from a scheduled send with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.batch_id string Required
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "batch_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve a list of scopes for which this user has access. — sendgrid.scopes.listscope

Run Retrieve a list of scopes for which this user has access. with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Engagement Quality Scores — sendgrid.seq.listengagementqualityscore

Run Get Engagement Quality Scores with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.
query object Required additionalProperties: false
query.from string Required The starting date in YYYY-MM-DD format (UTC) for which you want to retrieve scores. format: "date"
query.to string Required The ending date in YYYY-MM-DD format (UTC) for which you want to retrieve scores. format: "date"

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "from": "2006-01-02",
    "to": "2006-01-02"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Subusers' Engagement Quality Scores — sendgrid.seq.listsubuserengagementqualityscore

Run Get Subusers' Engagement Quality Scores with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.
query object Required additionalProperties: false
query.limit integer Optional Specifies the number of results to be returned by the API. This parameter can be used to limit the results returned or in combination with the after_key parameter to iterate through paginated results. default: 1000; minimum: 0; maximum: 1000
query.date string Required The date in YYYY-MM-DD format (UTC) for which you want to retrieve a SendGrid Engagement Quality score. format: "date"
query.after_key integer Optional Specifies which items to be returned by the API. When the after_key is specified, the API will return items beginning from the first item after the item specified. This parameter can be used in combination with limit to iterate through paginated results.

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "date": "2026-01-01"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an SSO Certificate — sendgrid.sso.createssocertificate

Run Create an SSO Certificate with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body object Optional
body.public_certificate string Required This public certificate allows SendGrid to verify that SAML requests it receives are signed by an IdP that it recognizes.
body.enabled boolean Optional Indicates if the certificate is enabled.
body.integration_id string Required An ID that matches a certificate to a specific IdP integration. This is the id returned by the "Get All SSO Integrations" endpoint.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an SSO Certificate — sendgrid.sso.getssocertificate

Run Get an SSO Certificate with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.cert_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "cert_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update SSO Certificate — sendgrid.sso.updatessocertificate

Run Update SSO Certificate with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.cert_id string Required
body object Optional
body.public_certificate string Optional This public certificate allows SendGrid to verify that SAML requests it receives are signed by an IdP that it recognizes.
body.enabled boolean Optional Indicates whether or not the certificate is enabled.
body.integration_id string Optional An ID that matches a certificate to a specific IdP integration.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "cert_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an SSO Certificate — sendgrid.sso.deletessocertificate

Run Delete an SSO Certificate with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.cert_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "cert_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create an SSO Integration — sendgrid.sso.createssointegration

Run Create an SSO Integration with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Optional $ref: "#/definitions/PostPatchIntegrationRequest"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get All SSO Integrations — sendgrid.sso.listssointegration

Run Get All SSO Integrations with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.si boolean Optional If this parameter is set to true, the response will include the completed_integration field.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get an SSO Integration — sendgrid.sso.getssointegration

Run Get an SSO Integration with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required
query object Optional additionalProperties: false
query.si boolean Optional If this parameter is set to true, the response will include the completed_integration field.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an SSO Integration — sendgrid.sso.updatessointegration

Run Update an SSO Integration with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required
query object Optional additionalProperties: false
query.si boolean Optional If this parameter is set to true, the response will include the completed_integration field.
body — Optional $ref: "#/definitions/PostPatchIntegrationRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete an SSO Integration — sendgrid.sso.deletessointegration

Run Delete an SSO Integration with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get All SSO Certificates by Integration — sendgrid.sso.listssointegrationcertificate

Run Get All SSO Certificates by Integration with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.integration_id string Required An ID that matches a certificate to a specific IdP integration.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "integration_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Edit an SSO Teammate — sendgrid.sso.updatessoteammate

Run Edit an SSO Teammate with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required Set this parameter to the Teammate's email address. This address must be the same address assigned to the Teammate in your IdP. format: "email"
body — Optional $ref: "#/definitions/PatchSsoTeammatesRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "[email protected]"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve email statistics by browser. — sendgrid.stats.listbrowserstat

Run Retrieve email statistics by browser. with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.browsers string Optional The browsers to get statistics for. You can include up to 10 different browsers by including this parameter multiple times.
query.aggregated_by — Optional How to group the statistics. Must be either "day", "week", or "month".
query.aggregated_by — Optional allOf[1]; $ref: "#/definitions/AggregatedBy3"
query.aggregated_by string Optional allOf[2]
query.start_date string Required The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.
query.end_date string Optional The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "start_date": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve all categories — sendgrid.stats.listcategory

Run Retrieve all categories with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional limit sets the page size, i.e. maximum number of items from the list to be returned for a single API request. If omitted, the default page size is used. default: 50; minimum: 1
query.category string Optional Allows you to perform a prefix search on this particular category.
query.offset integer Optional The number of items in the list to skip over before starting to retrieve the items for the requested page. The default offset of 0 represents the beginning of the list, i.e. the start of the first page. To request the second page of the list, set the offset to the page size as determined by limit. Use multiples of the page size as your offset to request further consecutive pages. E.g. assume your page size is set to 10. An offset of 10 requests the second page, an offset of 20 requests the third page and so on, provided there are sufficiently many items in your list. default: 0; minimum: 0
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve Email Statistics for Categories — sendgrid.stats.listcategorystat

Run Retrieve Email Statistics for Categories with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.start_date string Required The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD
query.end_date string Optional The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD.
query.categories string Required The individual categories that you want to retrieve statistics for. You may include up to 10 different categories.
query.aggregated_by — Optional How to group the statistics. Must be either "day", "week", or "month".
query.aggregated_by — Optional allOf[1]; $ref: "#/definitions/AggregatedBy"
query.aggregated_by string Optional allOf[2]
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "start_date": "example",
    "categories": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve sums of email stats for each category. — sendgrid.stats.listcategorystatsum

Run Retrieve sums of email stats for each category. with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.sort_by_metric string Optional The metric that you want to sort by. Must be a single metric. default: "delivered"
query.sort_by_direction — Optional The direction you want to sort.
query.sort_by_direction — Optional allOf[1]; $ref: "#/definitions/SortByDirection"
query.sort_by_direction string Optional allOf[2]; default: "desc"
query.start_date string Required The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.
query.end_date string Optional The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD.
query.limit integer Optional Limits the number of results returned. default: 5
query.offset integer Optional The point in the list to begin retrieving results. default: 0
query.aggregated_by — Optional How to group the statistics. Must be either "day", "week", or "month".
query.aggregated_by — Optional allOf[1]; $ref: "#/definitions/AggregatedBy1"
query.aggregated_by string Optional allOf[2]
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "start_date": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve email statistics by client type. — sendgrid.stats.listclientstat

Run Retrieve email statistics by client type. with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.
query object Required additionalProperties: false
query.start_date string Required The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.
query.end_date string Optional The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD.
query.aggregated_by — Optional How to group the statistics. Must be either "day", "week", or "month".
query.aggregated_by — Optional allOf[1]; $ref: "#/definitions/AggregatedBy2"
query.aggregated_by string Optional allOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "start_date": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve stats by a specific client type. — sendgrid.stats.getclientstat

Run Retrieve stats by a specific client type. with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.client_type — Required Specifies the type of client to retrieve stats for. Must be either "phone", "tablet", "webmail", or "desktop".
path.client_type — Required allOf[1]; $ref: "#/definitions/ClientType"
path.client_type string Required allOf[2]
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.
query object Required additionalProperties: false
query.start_date string Required The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.
query.end_date string Optional The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD.
query.aggregated_by — Optional How to group the statistics. Must be either "day", "week", or "month".
query.aggregated_by — Optional allOf[1]; $ref: "#/definitions/AggregatedBy2"
query.aggregated_by string Optional allOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "client_type": "phone"
  },
  "query": {
    "start_date": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve email statistics by device type. — sendgrid.stats.listdevicestat

Run Retrieve email statistics by device type. with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.
query object Required additionalProperties: false
query.aggregated_by — Optional How to group the statistics. Must be either "day", "week", or "month".
query.aggregated_by — Optional allOf[1]; $ref: "#/definitions/AggregatedBy3"
query.aggregated_by string Optional allOf[2]
query.start_date string Required The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.
query.end_date string Optional The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD.

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "start_date": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve email statistics by mailbox provider. — sendgrid.stats.listmailboxproviderstat

Run Retrieve email statistics by mailbox provider. with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.mailbox_providers string Optional The mail box providers to get statistics for. You can include up to 10 by including this parameter multiple times.
query.aggregated_by — Optional How to group the statistics. Must be either "day", "week", or "month".
query.aggregated_by — Optional allOf[1]; $ref: "#/definitions/AggregatedBy3"
query.aggregated_by string Optional allOf[2]
query.start_date string Required The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.
query.end_date string Optional The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "start_date": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve global email statistics — sendgrid.stats.liststat

Run Retrieve global email statistics with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.
query object Required additionalProperties: false
query.aggregated_by — Optional How to group the statistics. Must be either "day", "week", or "month".
query.aggregated_by — Optional allOf[1]; $ref: "#/definitions/AggregatedBy3"
query.aggregated_by string Optional allOf[2]
query.start_date string Required The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.
query.end_date string Optional The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD.

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "start_date": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

List all Subusers — sendgrid.subusers.listsubuser

Run List all Subusers with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.username string Optional The username of this subuser.
query.limit integer Optional limit sets the page size, i.e. maximum number of items from the list to be returned for a single API request. If omitted, the default page size is used.
query.region — Optional Filter for Subusers in this region. If not provided, all Subusers will be returned. All users can also be explicitly requested by using the filter all. Users who are not pinned to a region will be displayed as global.
query.region — Optional allOf[1]; $ref: "#/definitions/Region"
query.region string Optional allOf[2]; default: "all"
query.include_region boolean Optional Optional flag to include the regions of the Subusers in the response. If not provided, the region will be omitted from the response. default: false
query.offset integer Optional The number of items in the list to skip over before starting to retrieve the items for the requested page. The default offset of 0 represents the beginning of the list, i.e. the start of the first page. To request the second page of the list, set the offset to the page size as determined by limit. Use multiples of the page size as your offset to request further consecutive pages. E.g. assume your page size is set to 10. An offset of 10 requests the second page, an offset of 20 requests the third page and so on, provided there are sufficiently many items in your list. default: 0; minimum: 0

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Subuser — sendgrid.subusers.createsubuser

Run Create Subuser with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body object Optional
body.username string Required The username for this subuser.
body.email string Required The email address of the subuser. format: "email"
body.password string Required The password this subuser will use when logging into SendGrid.
body.ips array Required The IP addresses that should be assigned to this subuser.
body.ips[] string Optional format: "ipv4"
body.region — Optional
body.region — Optional allOf[1]; $ref: "#/definitions/Region1"
body.region string Optional allOf[2]; default: "global"
body.include_region boolean Optional A flag that determines if the Subuser's region should be returned in the response. (Regional email is in Public Beta and requires SendGrid Pro plan or above.) default: false

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Enable/disable a subuser — sendgrid.subusers.updatesubuser

Run Enable/disable a subuser with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.subuser_name string Required The username of the Subuser.
body object Optional
body.disabled boolean Optional Whether or not this subuser is disabled. true means disabled, false means enabled.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "subuser_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a subuser — sendgrid.subusers.deletesubuser

Run Delete a subuser with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.subuser_name string Required The username of the Subuser.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "subuser_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Enable/Disable website access for a Subuser — sendgrid.subusers.updatesubuserwebsiteaccess

Run Enable/Disable website access for a Subuser with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.subuser_name string Required
body object Optional
body.disabled boolean Optional Whether or not to disable website access to the Subuser. true means disabled, false means enabled.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "subuser_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the Credits for a Subuser — sendgrid.subusers.getsubusercredit

Run Get the Credits for a Subuser with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.subuser_name string Required The username of the Subuser.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "subuser_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update the Credits for a Subuser — sendgrid.subusers.updatesubusercredit

Run Update the Credits for a Subuser with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.subuser_name string Required The username of the Subuser.
body — Required $ref: "#/definitions/SubuserCreditsRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "subuser_name": "example"
  },
  "body": {
    "type": "unlimited"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update the remaining credits for a Subuser — sendgrid.subusers.updatesubuserremainingcredit

Run Update the remaining credits for a Subuser with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.subuser_name string Required The username of the Subuser.
body object Required
body.allocation_update integer Required The number of credits to add to or subtract from the current remaining credits for the Subuser. Use a positive number to increase the remaining credits or a negative number to reduce the remaining credits.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "subuser_name": "example"
  },
  "body": {
    "allocation_update": 99
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update IPs assigned to a subuser — sendgrid.subusers.updatesubuserip

Run Update IPs assigned to a subuser with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.subuser_name string Required The username of the Subuser.
body array Optional The IP addresses you would like to assign to the subuser.
body[] string Optional format: "ipv4"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "subuser_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve the monthly email statistics for a single subuser — sendgrid.subusers.listsubusermonthlystat

Run Retrieve the monthly email statistics for a single subuser with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.subuser_name string Required The username of the Subuser.
query object Required additionalProperties: false
query.date string Required The date of the month to retrieve statistics for. Must be formatted YYYY-MM-DD
query.sort_by_metric string Optional The metric that you want to sort by. Metrics that you can sort by are: blocks, bounces, clicks, delivered, opens, requests, unique_clicks, unique_opens, and unsubscribes.' default: "delivered"
query.sort_by_direction — Optional The direction you want to sort.
query.sort_by_direction — Optional allOf[1]; $ref: "#/definitions/SortByDirection"
query.sort_by_direction string Optional allOf[2]; default: "desc"
query.limit integer Optional Optional field to limit the number of results returned. default: 5
query.offset integer Optional Optional beginning point in the list to retrieve from. default: 0

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "subuser_name": "example"
  },
  "query": {
    "date": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve Subuser Reputations — sendgrid.subusers.listreputation

Run Retrieve Subuser Reputations with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.usernames string Optional

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve email statistics for your subusers. — sendgrid.subusers.liststat

Run Retrieve email statistics for your subusers. with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.limit integer Optional Limits the number of results returned per page.
query.offset integer Optional The point in the list to begin retrieving results from.
query.aggregated_by — Optional How to group the statistics. Must be either "day", "week", or "month".
query.aggregated_by — Optional allOf[1]; $ref: "#/definitions/AggregatedBy"
query.aggregated_by string Optional allOf[2]
query.subusers string Required The subuser you want to retrieve statistics for. You may include this parameter up to 10 times to retrieve statistics for multiple subusers.
query.start_date string Required The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.
query.end_date string Optional The end date of the statistics to retrieve. Defaults to today.

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "subusers": "example",
    "start_date": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve monthly stats for all subusers — sendgrid.subusers.listmonthlystat

Run Retrieve monthly stats for all subusers with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.date string Required The date of the month to retrieve statistics for. Must be formatted YYYY-MM-DD
query.subuser string Optional A substring search of your subusers.
query.sort_by_metric — Optional The metric that you want to sort by. Metrics that you can sort by are: blocks, bounces, clicks, delivered, opens, requests, unique_clicks, unique_opens, and unsubscribes.'
query.sort_by_metric — Optional allOf[1]; $ref: "#/definitions/SortByMetric"
query.sort_by_metric string Optional allOf[2]; default: "delivered"
query.sort_by_direction — Optional The direction you want to sort.
query.sort_by_direction — Optional allOf[1]; $ref: "#/definitions/SortByDirection1"
query.sort_by_direction string Optional allOf[2]; default: "desc"
query.limit integer Optional Optional field to limit the number of results returned. default: 5
query.offset integer Optional Optional beginning point in the list to retrieve from. default: 0

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "date": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve the totals for each email statistic metric for all subusers. — sendgrid.subusers.liststatsum

Run Retrieve the totals for each email statistic metric for all subusers. with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.sort_by_direction — Optional The direction you want to sort.
query.sort_by_direction — Optional allOf[1]; $ref: "#/definitions/SortByDirection2"
query.sort_by_direction string Optional allOf[2]; default: "desc"
query.start_date string Required The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.
query.end_date string Optional The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD.
query.limit integer Optional Limits the number of results returned per page. default: 5
query.offset integer Optional The point in the list to begin retrieving results from. default: 0
query.aggregated_by string Optional How to group the statistics. Defaults to today. Must follow format YYYY-MM-DD.
query.sort_by_metric string Optional The metric that you want to sort by. Must be a single metric. default: "delivered"

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "start_date": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a new suppression group — sendgrid.suppressions.creatasmgroup

Run Create a new suppression group with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the on-behalf-of header. See On Behalf Of for more information.
body — Optional $ref: "#/definitions/SuppressionGroupRequestBaseProps"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve all suppression groups associated with the user. — sendgrid.suppressions.listasmgroup

Run Retrieve all suppression groups associated with the user. with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.id integer Optional The ID of the suppression group(s) you want to retrieve.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the on-behalf-of header. See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get information on a single suppression group. — sendgrid.suppressions.getasmgroup

Run Get information on a single suppression group. with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.group_id string Required The ID of the suppression group you would like to retrieve.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the on-behalf-of header. See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "group_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a suppression group. — sendgrid.suppressions.updateasmgroup

Run Update a suppression group. with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.group_id string Required The ID of the suppression group you would like to retrieve.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the on-behalf-of header. See On Behalf Of for more information.
body object Optional
body.name string Optional The name of your suppression group. Required when creating a group. maxLength: 30
body.description string Optional A brief description of your suppression group. Required when creating a group. maxLength: 100
body.is_default boolean Optional Indicates if you would like this to be your default suppression group.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "group_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a Suppression Group — sendgrid.suppressions.deleteasmgroup

Run Delete a Suppression Group with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.group_id string Required The ID of the suppression group you would like to retrieve.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the on-behalf-of header. See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "group_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add suppressions to a suppression group — sendgrid.suppressions.addsuppressiontoasmgroup

Run Add suppressions to a suppression group with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.group_id string Required The id of the unsubscribe group that you are adding suppressions to.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the on-behalf-of header. See On Behalf Of for more information.
body — Optional $ref: "#/definitions/SuppressionsRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "group_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve all suppressions for a suppression group — sendgrid.suppressions.listsuppressionfromasmgroup

Run Retrieve all suppressions for a suppression group with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.group_id string Required The id of the unsubscribe group that you are adding suppressions to.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the on-behalf-of header. See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "group_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a suppression from a suppression group — sendgrid.suppressions.deletesuppressionfromasmgroup

Run Delete a suppression from a suppression group with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.group_id string Required The id of the suppression group that you are removing an email address from.
path.email string Required The email address that you want to remove from the suppression group.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the on-behalf-of header. See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "group_id": "example",
    "email": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Search for suppressions within a group — sendgrid.suppressions.searchsuppressionfromasmgroup

Run Search for suppressions within a group with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.group_id string Required The ID of the suppression group that you would like to search.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the on-behalf-of header. See On Behalf Of for more information.
body — Optional $ref: "#/definitions/SuppressionsRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "group_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve all suppressions — sendgrid.suppressions.listasmsuppression

Run Retrieve all suppressions with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the on-behalf-of header. See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve all suppression groups for an email address — sendgrid.suppressions.getasmsuppression

Run Retrieve all suppression groups for an email address with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.email string Required The email address that you want to search suppression groups for.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the on-behalf-of header. See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "email": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve all blocks — sendgrid.suppressions.listsuppressionblock

Run Retrieve all blocks with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.start_time integer Optional The start of the time range when a blocked email was created (inclusive). This is a unix timestamp.
query.end_time integer Optional The end of the time range when a blocked email was created (inclusive). This is a unix timestamp.
query.limit integer Optional limit sets the page size, i.e. maximum number of items from the list to be returned for a single API request. If omitted, the default page size is used. The maximum page size for this endpoint is 500 items per page. minimum: 1; maximum: 500
query.offset integer Optional The number of items in the list to skip over before starting to retrieve the items for the requested page. The default offset of 0 represents the beginning of the list, i.e. the start of the first page. To request the second page of the list, set the offset to the page size as determined by limit. Use multiples of the page size as your offset to request further consecutive pages. E.g. assume your page size is set to 10. An offset of 10 requests the second page, an offset of 20 requests the third page and so on, provided there are sufficiently many items in your list. default: 0; minimum: 0
query.email string Optional Specifies which records to return based on the records' associated email addresses. For example, sales returns records with email addresses that start with 'sales', such as [email protected] or [email protected]. You can also use %25 as a wildcard. For example, %25market returns records containing email addresses with the string 'market' anywhere in the email address, and %25market%25tree returns records containing email addresses with the string 'market' followed by the string 'tree'. Any reserved characters should be percent-encoded, e.g., the @ symbol should be encoded as %40.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the on-behalf-of header. See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete blocks — sendgrid.suppressions.deletesuppressionblocks

Run Delete blocks with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the on-behalf-of header. See On Behalf Of for more information.
body object Optional
body.delete_all boolean Optional Indicates if you want to delete all blocked email addresses.
body.emails array Optional The specific blocked email addresses that you want to delete.
body.emails[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve a specific block — sendgrid.suppressions.getsuppressionblock

Run Retrieve a specific block with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.email string Required The email address of the specific block. format: "email"
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the on-behalf-of header. See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "email": "[email protected]"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a specific block — sendgrid.suppressions.deletesuppressionblock

Run Delete a specific block with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.email string Required The email address of the specific block. format: "email"
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the on-behalf-of header. See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "email": "[email protected]"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve all bounces — sendgrid.suppressions.listsuppressionbounces

Run Retrieve all bounces with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.start_time integer Optional Refers start of the time range in unix timestamp when a bounce was created (inclusive).
query.end_time integer Optional Refers end of the time range in unix timestamp when a bounce was created (inclusive).
query.limit integer Optional limit sets the page size, i.e. maximum number of items from the list to be returned for a single API request. If omitted, the default page size is used. The maximum page size for this endpoint is 500 items per page. minimum: 1; maximum: 500
query.offset integer Optional The number of items in the list to skip over before starting to retrieve the items for the requested page. The default offset of 0 represents the beginning of the list, i.e. the start of the first page. To request the second page of the list, set the offset to the page size as determined by limit. Use multiples of the page size as your offset to request further consecutive pages. E.g. assume your page size is set to 10. An offset of 10 requests the second page, an offset of 20 requests the third page and so on, provided there are sufficiently many items in your list. default: 0; minimum: 0
query.email string Optional Specifies which records to return based on the records' associated email addresses. For example, sales returns records with email addresses that start with 'sales', such as [email protected] or [email protected]. You can also use %25 as a wildcard. For example, %25market returns records containing email addresses with the string 'market' anywhere in the email address, and %25market%25tree returns records containing email addresses with the string 'market' followed by the string 'tree'. Any reserved characters should be percent-encoded, e.g., the @ symbol should be encoded as %40.
headers object Required additionalProperties: false
headers.Accept string Required default: "application/json"
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the on-behalf-of header. See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "headers": {
    "Accept": "application/json"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete bounces — sendgrid.suppressions.deletesuppressionbounces

Run Delete bounces with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the on-behalf-of header. See On Behalf Of for more information.
body object Optional
body.delete_all boolean Optional This parameter allows you to delete every email in your bounce list. This should not be used with the emails parameter.
body.emails array Optional Delete multiple emails from your bounce list at the same time. This should not be used with the delete_all parameter.
body.emails[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve a Bounce — sendgrid.suppressions.getsuppressionbounces

Run Retrieve a Bounce with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.email string Required The email address of the specific bounce you would like to retrieve format: "email"
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the on-behalf-of header. See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "email": "[email protected]"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a bounce — sendgrid.suppressions.deletesuppressionbounce

Run Delete a bounce with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.email string Required The email address you would like to remove from the bounce list. format: "email"
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the on-behalf-of header. See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "email": "[email protected]"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve bounce classification totals — sendgrid.suppressions.listsuppressionbouncesclassifications

Run Retrieve bounce classification totals with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Required additionalProperties: false
headers.Accept — Required Specifies the content type to be returned by this endpoint. You can choose to receive CSV-formatted data by passing "text/csv" in the header.
headers.Accept — Required allOf[1]; $ref: "#/definitions/Accept"
headers.Accept string Required allOf[2]; default: "application/json"
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the on-behalf-of header. See On Behalf Of for more information.
query object Optional additionalProperties: false
query.start_date string Optional The start of the time range, in YYYY-MM-DD format, when a bounce was created (inclusive).
query.end_date string Optional The end of the time range, in YYYY-MM-DD format, when a bounce was created (inclusive).

Full JSON Schema

Full JSON Schema

Example input

{
  "headers": {
    "Accept": "application/json"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve bounce classification over time by domain stats — sendgrid.suppressions.getsuppressionbouncesclassifications

Run Retrieve bounce classification over time by domain stats with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Required additionalProperties: false
headers.Accept — Required Specifies the content type to be returned by this endpoint. You can choose to receive CSV-formatted data by passing "text/csv" in the header.
headers.Accept — Required allOf[1]; $ref: "#/definitions/Accept1"
headers.Accept string Required allOf[2]; default: "application/json"
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the on-behalf-of header. See On Behalf Of for more information.
path object Required additionalProperties: false
path.classification — Required The classification you want to filter by. Possible values are: Content, Frequency or Volume Too High, Invalid Address, Mailbox Unavailable, Reputation, Technical Failure, Unclassified.
path.classification — Required allOf[1]; $ref: "#/definitions/Classification1"
path.classification string Required allOf[2]
query object Optional additionalProperties: false
query.start_date string Optional The start of the time range, in YYYY-MM-DD format, when a bounce was created (inclusive).
query.end_date string Optional The end of the time range, in YYYY-MM-DD format, when a bounce was created (inclusive).

Full JSON Schema

Full JSON Schema

Example input

{
  "headers": {
    "Accept": "application/json"
  },
  "path": {
    "classification": "Content"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Add recipient addresses to the global suppression group. — sendgrid.suppressions.createglobalsuppression

Run Add recipient addresses to the global suppression group. with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the on-behalf-of header. See On Behalf Of for more information.
body — Optional $ref: "#/definitions/SuppressionsRequest"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve a Global Suppression — sendgrid.suppressions.getglobalsuppression

Run Retrieve a Global Suppression with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.email string Required The email address of the global suppression you want to retrieve. Or, if you want to check if an email address is on the global suppressions list, enter that email address here.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the on-behalf-of header. See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "email": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a Global Suppression — sendgrid.suppressions.deleteglobalsuppression

Run Delete a Global Suppression with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.email string Required The email address of the global suppression you want to retrieve. Or, if you want to check if an email address is on the global suppressions list, enter that email address here.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the on-behalf-of header. See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "email": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve all invalid emails — sendgrid.suppressions.listinvalidemail

Run Retrieve all invalid emails with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.start_time integer Optional Refers start of the time range in unix timestamp when an invalid email was created (inclusive).
query.end_time integer Optional Refers end of the time range in unix timestamp when an invalid email was created (inclusive).
query.limit integer Optional limit sets the page size, i.e. maximum number of items from the list to be returned for a single API request. If omitted, the default page size is used. The maximum page size for this endpoint is 500 items per page. minimum: 1; maximum: 500
query.offset integer Optional The number of items in the list to skip over before starting to retrieve the items for the requested page. The default offset of 0 represents the beginning of the list, i.e. the start of the first page. To request the second page of the list, set the offset to the page size as determined by limit. Use multiples of the page size as your offset to request further consecutive pages. E.g. assume your page size is set to 10. An offset of 10 requests the second page, an offset of 20 requests the third page and so on, provided there are sufficiently many items in your list. default: 0; minimum: 0
query.email string Optional This parameter allows you to filter results by email address. Only invalid addresses matching an address passed in this parameter will be returned.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the on-behalf-of header. See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete invalid emails — sendgrid.suppressions.deleteinvalidemails

Run Delete invalid emails with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the on-behalf-of header. See On Behalf Of for more information.
body object Optional
body.delete_all boolean Optional Indicates if you want to remove all email address from the invalid emails list.
body.emails array Optional The list of specific email addresses that you want to remove.
body.emails[] string Optional format: "email"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve a specific invalid email — sendgrid.suppressions.getinvalidemail

Run Retrieve a specific invalid email with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.email string Required The specific email address of the invalid email entry that you want to retrieve.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the on-behalf-of header. See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "email": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a specific invalid email — sendgrid.suppressions.deleteinvalidemail

Run Delete a specific invalid email with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.email string Required The specific email address of the invalid email entry that you want to retrieve.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the on-behalf-of header. See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "email": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve all spam reports — sendgrid.suppressions.listspamreport

Run Retrieve all spam reports with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.start_time integer Optional The start of the time range when a spam report was created (inclusive). This is a unix timestamp.
query.end_time integer Optional The end of the time range when a spam report was created (inclusive). This is a unix timestamp.
query.limit integer Optional limit sets the page size, i.e. maximum number of items from the list to be returned for a single API request. If omitted, the default page size is used. The maximum page size for this endpoint is 500 items per page. minimum: 1; maximum: 500
query.offset integer Optional The number of items in the list to skip over before starting to retrieve the items for the requested page. The default offset of 0 represents the beginning of the list, i.e. the start of the first page. To request the second page of the list, set the offset to the page size as determined by limit. Use multiples of the page size as your offset to request further consecutive pages. E.g. assume your page size is set to 10. An offset of 10 requests the second page, an offset of 20 requests the third page and so on, provided there are sufficiently many items in your list. default: 0; minimum: 0
query.email string Optional Specifies which records to return based on the records' associated email addresses. For example, sales returns records with email addresses that start with 'sales', such as [email protected] or [email protected]. You can also use %25 as a wildcard. For example, %25market returns records containing email addresses with the string 'market' anywhere in the email address, and %25market%25tree returns records containing email addresses with the string 'market' followed by the string 'tree'. Any reserved characters should be percent-encoded, e.g., the @ symbol should be encoded as %40.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the on-behalf-of header. See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete spam reports — sendgrid.suppressions.deletespamreports

Run Delete spam reports with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the on-behalf-of header. See On Behalf Of for more information.
body object Optional
body.delete_all boolean Optional Indicates if you want to delete all email addresses on the spam report list.
body.emails array Optional A list of specific email addresses that you want to remove from the spam report list.
body.emails[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve a specific spam report — sendgrid.suppressions.getspamreport

Run Retrieve a specific spam report with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.email string Required The email address of a specific spam report that you want to retrieve. format: "email"
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the on-behalf-of header. See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "email": "[email protected]"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a specific spam report — sendgrid.suppressions.deletespamreport

Run Delete a specific spam report with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.email string Required The email address of a specific spam report that you want to retrieve. format: "email"
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the on-behalf-of header. See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "email": "[email protected]"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve all global suppressions — sendgrid.suppressions.listglobalsuppression

Run Retrieve all global suppressions with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.start_time integer Optional Refers start of the time range in unix timestamp when an unsubscribe email was created (inclusive).
query.end_time integer Optional Refers end of the time range in unix timestamp when an unsubscribe email was created (inclusive).
query.limit integer Optional limit sets the page size, i.e. maximum number of items from the list to be returned for a single API request. If omitted, the default page size is used. The maximum page size for this endpoint is 500 items per page. minimum: 1; maximum: 500
query.offset integer Optional The number of items in the list to skip over before starting to retrieve the items for the requested page. The default offset of 0 represents the beginning of the list, i.e. the start of the first page. To request the second page of the list, set the offset to the page size as determined by limit. Use multiples of the page size as your offset to request further consecutive pages. E.g. assume your page size is set to 10. An offset of 10 requests the second page, an offset of 20 requests the third page and so on, provided there are sufficiently many items in your list. default: 0; minimum: 0
query.email string Optional Specifies which records to return based on the records' associated email addresses. For example, sales returns records with email addresses that start with 'sales', such as [email protected] or [email protected]. You can also use %25 as a wildcard. For example, %25market returns records containing email addresses with the string 'market' anywhere in the email address, and %25market%25tree returns records containing email addresses with the string 'market' followed by the string 'tree'. Any reserved characters should be percent-encoded, e.g., the @ symbol should be encoded as %40.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). It is important to use the Base URL that corresponds to the region of the account or Subuser you specify in the on-behalf-of header. See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Invite teammate — sendgrid.teammates.inviteteammate

Run Invite teammate with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.
body object Optional
body.email string Required New teammate's email minLength: 5; maxLength: 255; pattern: "^.*@.*\\..*"
body.scopes array Required Set to specify list of scopes that teammate should have. Should be empty if teammate is an admin.
body.scopes[] string Optional
body.is_admin boolean Required Set to true if teammate should be an admin user default: false

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve all teammates — sendgrid.teammates.listteammate

Run Retrieve all teammates with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional limit sets the page size, i.e. maximum number of items from the list to be returned for a single API request. If omitted, the default page size is used. The maximum page size for this endpoint is 500 items per page. default: 500; minimum: 0; maximum: 500
query.offset integer Optional The number of items in the list to skip over before starting to retrieve the items for the requested page. The default offset of 0 represents the beginning of the list, i.e. the start of the first page. To request the second page of the list, set the offset to the page size as determined by limit. Use multiples of the page size as your offset to request further consecutive pages. E.g. assume your page size is set to 10. An offset of 10 requests the second page, an offset of 20 requests the third page and so on, provided there are sufficiently many items in your list. default: 0; minimum: 0
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Teammate Subuser Access — sendgrid.teammates.listsubuserbytemplate

Run Get Teammate Subuser Access with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.teammate_name string Required The username of the Teammate for whom you want to retrieve Subuser access information.
query object Optional additionalProperties: false
query.after_subuser_id integer Optional The Subuser ID from which the API request will begin retrieving Subusers. This query parameter can be used in successive API calls to retrieve additional Subusers.
query.limit integer Optional Limit the number of Subusers to be returned. The default limit is 100 per request. default: 100
query.username string Optional A Subuser's username that will be used to filter the returned result.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "teammate_name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve specific teammate — sendgrid.teammates.getteammate

Run Retrieve specific teammate with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The username of the teammate that you want to retrieve.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update teammate's permissions — sendgrid.teammates.updateteammate

Run Update teammate's permissions with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The username of the teammate that you want to retrieve.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.
body object Optional
body.scopes array Required Provide list of scopes that should be given to teammate. If specifying list of scopes, is_admin should be set to False.
body.scopes[] string Optional
body.is_admin boolean Required Set to True if this teammate should be promoted to an admin user. If True, scopes should be an empty array.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete teammate — sendgrid.teammates.deleteteammate

Run Delete teammate with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.username string Required The username of the teammate that you want to retrieve.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "username": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve all pending teammates — sendgrid.teammates.listpendingteammate

Run Retrieve all pending teammates with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete pending teammate — sendgrid.teammates.deletependingteammate

Run Delete pending teammate with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.token string Required The token for the invite you want to delete.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "token": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Resend teammate invite — sendgrid.teammates.resendteammateinvite

Run Resend teammate invite with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.token string Required The token for the invite that you want to resend.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "token": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a transactional template. — sendgrid.templates.createtemplate

Run Create a transactional template. with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.
body object Optional
body.name string Required The name for the new transactional template. maxLength: 100
body.generation — Optional
body.generation — Optional allOf[1]; $ref: "#/definitions/Generation"
body.generation string Optional allOf[2]; default: "legacy"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve paged transactional templates. — sendgrid.templates.listtemplate

Run Retrieve paged transactional templates. with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.generations — Optional Comma-delimited list specifying which generations of templates to return. Options are legacy, dynamic or legacy,dynamic.
query.generations — Optional allOf[1]; $ref: "#/definitions/Generations"
query.generations string Optional allOf[2]; default: "legacy"
query.page_size number Required The number of templates to be returned in each page of results minimum: 1; maximum: 200
query.page_token string Optional A token corresponding to a specific page of results, as provided by metadata
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "page_size": 1
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Duplicate a transactional template. — sendgrid.templates.duplicatetemplate

Run Duplicate a transactional template. with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.template_id string Required
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.
body object Optional
body.name string Optional The name for the new transactional template. maxLength: 100

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "template_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve a single transactional template. — sendgrid.templates.gettemplate

Run Retrieve a single transactional template. with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.template_id string Required
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "template_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Edit a transactional template. — sendgrid.templates.updatetemplate

Run Edit a transactional template. with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.template_id string Required
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.
body object Optional
body.name string Optional The name of the transactional template. maxLength: 100

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "template_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a template. — sendgrid.templates.deletetemplate

Run Delete a template. with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.template_id string Required
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "template_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a new transactional template version. — sendgrid.templates.createtemplateversion

Run Create a new transactional template version. with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.template_id string Required format: "uuid"
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.
body — Optional $ref: "#/definitions/TransactionalTemplateVersionCreate"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "template_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve a specific transactional template version. — sendgrid.templates.gettemplateversion

Run Retrieve a specific transactional template version. with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.template_id string Required The ID of the original template format: "uuid"
path.version_id string Required The ID of the template version format: "uuid"
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "template_id": "00000000-0000-4000-8000-000000000000",
    "version_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Edit a transactional template version. — sendgrid.templates.updatetemplateversion

Run Edit a transactional template version. with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.template_id string Required The ID of the original template format: "uuid"
path.version_id string Required The ID of the template version format: "uuid"
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.
body — Optional $ref: "#/definitions/TransactionalTemplateVersionCreate"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "template_id": "00000000-0000-4000-8000-000000000000",
    "version_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a transactional template version. — sendgrid.templates.deletetemplateversion

Run Delete a transactional template version. with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.template_id string Required The ID of the original template format: "uuid"
path.version_id string Required The ID of the template version format: "uuid"
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "template_id": "00000000-0000-4000-8000-000000000000",
    "version_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Activate a transactional template version. — sendgrid.templates.activatetemplateversion

Run Activate a transactional template version. with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.template_id string Required The ID of the original template format: "uuid"
path.version_id string Required The ID of the template version format: "uuid"
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "template_id": "00000000-0000-4000-8000-000000000000",
    "version_id": "00000000-0000-4000-8000-000000000000"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve Tracking Settings — sendgrid.tracking_settings.listtrackingsetting

Run Retrieve Tracking Settings with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve Click Track Settings — sendgrid.tracking_settings.listclicktrackingsetting

Run Retrieve Click Track Settings with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Click Tracking Settings — sendgrid.tracking_settings.updateclicktrackingsetting

Run Update Click Tracking Settings with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.
body object Optional
body.enabled boolean Optional The setting you want to use for click tracking.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve Google Analytics Settings — sendgrid.tracking_settings.listgoogleanalyticstrackingsetting

Run Retrieve Google Analytics Settings with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Google Analytics Settings — sendgrid.tracking_settings.updategoogleanalyticstrackingsetting

Run Update Google Analytics Settings with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.
body — Optional $ref: "#/definitions/GoogleAnalyticsSettings"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Open Tracking Settings — sendgrid.tracking_settings.listopentrackingsetting

Run Get Open Tracking Settings with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Open Tracking Settings — sendgrid.tracking_settings.updateopentrackingsetting

Run Update Open Tracking Settings with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.
body object Optional
body.enabled boolean Optional The new status that you want to set for open tracking.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve Subscription Tracking Settings — sendgrid.tracking_settings.listsubscriptiontrackingsetting

Run Retrieve Subscription Tracking Settings with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update Subscription Tracking Settings — sendgrid.tracking_settings.updatesubscriptiontrackingsetting

Run Update Subscription Tracking Settings with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.
body — Optional $ref: "#/definitions/SubscriptionTrackingSettings"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a user's account information. — sendgrid.user.listaccount

Run Get a user's account information. with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve your credit balance — sendgrid.user.listcredit

Run Retrieve your credit balance with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve your account email address — sendgrid.user.listemail

Run Retrieve your account email address with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update your account email address — sendgrid.user.updateemail

Run Update your account email address with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.
body object Optional
body.email string Optional The new email address that you would like to use for your account.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update your password — sendgrid.user.updatepassword

Run Update your password with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.
body object Optional
body.new_password string Required The new password you would like to use for your account.
body.old_password string Required The old password for your account.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get a user's profile — sendgrid.user.listprofile

Run Get a user's profile with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a user's profile — sendgrid.user.updateprofile

Run Update a user's profile with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.
body — Optional $ref: "#/definitions/UserProfile"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve your username — sendgrid.user.listusername

Run Retrieve your username with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update your username — sendgrid.user.updateusername

Run Update your username with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.
body object Optional
body.username string Optional The new username you would like to use for your account.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create Verified Sender Request — sendgrid.verified_senders.createverifiedsender

Run Create Verified Sender Request with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Optional $ref: "#/definitions/VerifiedSenderRequest"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get All Verified Senders — sendgrid.verified_senders.listverifiedsender

Run Get All Verified Senders with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit number Optional Specifies the number of results to be returned by the API. This parameter can be used to limit the results returned or in combination with the lastSeenID parameter to iterate through paginated results.
query.lastSeenID number Optional Returns senders with an ID number occurring after the passed in ID. In other words, the lastSeenID provides a starting point from which SendGrid will iterate to find Sender Identities associated with your account.
query.id integer Optional Returns information about only the Sender Identity passed in the request.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Edit Verified Sender — sendgrid.verified_senders.updateverifiedsender

Run Edit Verified Sender with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required
body — Optional $ref: "#/definitions/VerifiedSenderRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete Verified Sender — sendgrid.verified_senders.deleteverifiedsender

Run Delete Verified Sender with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Domain Warn List — sendgrid.verified_senders.listverifiedsenderdomain

Run Domain Warn List with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Resend Verified Sender Request — sendgrid.verified_senders.resendverifiedsender

Run Resend Verified Sender Request with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Completed Steps — sendgrid.verified_senders.listverifiedsenderstepscompleted

Run Completed Steps with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Verify Sender Request — sendgrid.verified_senders.verifysendertoken

Run Verify Sender Request with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.token string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "token": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a new Event Webhook — sendgrid.webhooks.createeventwebhook

Run Create a new Event Webhook with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.
body — Optional $ref: "#/definitions/EventWebhookRequest"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve all of your Event Webhooks. — sendgrid.webhooks.listeventwebhook

Run Retrieve all of your Event Webhooks. with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.
query object Optional additionalProperties: false
query.include string Optional Use this to include optional fields in the response payload. When this is set to include=account_status_change, the account_status_change field will be part of the response payload and set to false by default. See Update an event webhook for enabling this webhook notification which lets you subscribe to account status change events related to compliance action taken by SendGrid.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get Signed Event Webhook's Public Key — sendgrid.webhooks.getsignedeventwebhook

Run Get Signed Event Webhook's Public Key with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.
path object Required additionalProperties: false
path.id string Required The ID of the Event Webhook you want to retrieve.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Toggle signature verification for a single Event Webhook by ID — sendgrid.webhooks.updatesignedeventwebhook

Run Toggle signature verification for a single Event Webhook by ID with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.
path object Required additionalProperties: false
path.id string Required The ID of the Event Webhook you want to retrieve.
body object Optional
body.enabled boolean Required Enable or disable the webhook by setting this property to true or false, respectively.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Test an Event Webhook's settings — sendgrid.webhooks.testeventwebhook

Run Test an Event Webhook's settings with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.
body — Optional $ref: "#/definitions/EventWebhookTestRequest"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Get the settings for a single Event Webhook. — sendgrid.webhooks.geteventwebhook

Run Get the settings for a single Event Webhook. with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.
path object Required additionalProperties: false
path.id string Required The ID of the Event Webhook you want to retrieve.
query object Optional additionalProperties: false
query.include string Optional Use this to include optional fields in the response payload. When this is set to include=account_status_change, the account_status_change field will be part of the response payload and set to false by default. See Update an event webhook for enabling this webhook notification which lets you subscribe to account status change events related to compliance action taken by SendGrid.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a single Event Webhook by ID. — sendgrid.webhooks.updateeventwebhook

Run Update a single Event Webhook by ID. with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.
path object Required additionalProperties: false
path.id string Required The ID of the Event Webhook you want to retrieve.
query object Optional additionalProperties: false
query.include string Optional Use this to include optional fields in the response payload. When this is set to include=account_status_change, the account_status_change field will be part of the response payload and set to false by default. See Update an event webhook for enabling this webhook notification which lets you subscribe to account status change events related to compliance action taken by SendGrid.
body — Optional $ref: "#/definitions/EventWebhookRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a single Event Webhook by ID. — sendgrid.webhooks.deleteeventwebhook

Run Delete a single Event Webhook by ID. with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.
path object Required additionalProperties: false
path.id string Required The ID of the Event Webhook you want to retrieve.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve all parse settings — sendgrid.webhooks.listparsesetting

Run Retrieve all parse settings with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a parse setting — sendgrid.webhooks.createparsesetting

Run Create a parse setting with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.
body — Optional $ref: "#/definitions/ParseSetting"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve a specific parse setting — sendgrid.webhooks.getparsesetting

Run Retrieve a specific parse setting with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.hostname string Required The hostname associated with the inbound parse setting that you would like to retrieve.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "hostname": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update a parse setting — sendgrid.webhooks.updateparsesetting

Run Update a parse setting with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.hostname string Required The hostname associated with the inbound parse setting that you would like to retrieve.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.
body — Optional $ref: "#/definitions/ParseSetting"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "hostname": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a parse setting — sendgrid.webhooks.deleteparsesetting

Run Delete a parse setting with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.hostname string Required The hostname associated with the inbound parse setting that you would like to retrieve.
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "hostname": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieves Inbound Parse Webhook statistics. — sendgrid.webhooks.listparsestatic

Run Retrieves Inbound Parse Webhook statistics. with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.limit string Optional The number of statistics to return on each page.
query.offset string Optional The number of statistics to skip.
query.aggregated_by — Optional How you would like the statistics to by grouped.
query.aggregated_by — Optional allOf[1]; $ref: "#/definitions/AggregatedBy"
query.aggregated_by string Optional allOf[2]
query.start_date string Required The starting date of the statistics you want to retrieve. Must be in the format YYYY-MM-DD
query.end_date string Optional The end date of the statistics you want to retrieve. Must be in the format YYYY-MM-DD default: "The day the request is made."
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "start_date": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Create a new webhook security policy — sendgrid.webhooks.createsecuritypolicy

Run Create a new webhook security policy with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.
body object Optional
body.name string Optional User-defined policy name
body.oauth object Optional
body.oauth.client_id string Optional
body.oauth.client_secret string Optional
body.oauth.token_url string Optional
body.oauth.scopes array Optional
body.oauth.scopes[] string Optional
body.signature object Optional
body.signature.enabled boolean Optional

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve all webhook security policies for your account — sendgrid.webhooks.listallsecuritypolicies

Run Retrieve all webhook security policies for your account with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 30 seconds.

Update an existing webhook security policy — sendgrid.webhooks.updatesecuritypolicy

Run Update an existing webhook security policy with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.
body object Optional
body.name string Optional User-defined policy name
body.oauth object Optional
body.oauth.client_id string Optional
body.oauth.client_secret string Optional
body.oauth.token_url string Optional
body.oauth.scopes array Optional
body.oauth.scopes[] string Optional
body.signature object Optional
body.signature.enabled boolean Optional

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Retrieve a specific webhook security policy — sendgrid.webhooks.getsecuritypolicy

Run Retrieve a specific webhook security policy with Twilio SendGrid. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Delete a specific webhook security policy — sendgrid.webhooks.deletesecuritypolicy

Run Delete a specific webhook security policy with Twilio SendGrid. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required
query object Optional additionalProperties: false
query.force boolean Optional
headers object Optional additionalProperties: false
headers.on-behalf-of string Optional The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id &lt;account-id&gt;). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: &lt;subuser-username&gt;). See On Behalf Of for more information.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Errors

Check the key's expiry, revocation, workspace and allowed operations.

Reuse the same idempotency key only for the same request.

The connection or provider limit has been reached. Check the receipt before retrying.

Test the connection

Open the integration's commands below to inspect parameters and examples. Start with a read command for an account or resource you can access. Refresh your client's tool list, use the returned tool name, and check the execution result and usage. Provider charges and permissions still apply. Never test a write against production data without reviewing it.

Official provider documentation

Navigation

Type to search…

↑↓ navigate↵ selectEsc close