Connectors Reference
SendGrid Connection Provider lets you send email and manage recipient lists.
|
Status: Production |
Tier: Standard |
Version: 1.0 |
|
Name |
Summary |
|
Send email |
|
|
Send email (V2) |
|
|
Send email (V3) |
|
|
Send email (V4) |
|
|
AddGlobalSuppression (AddGlobalSuppressRequestAndResponse recipient_emails) |
Add a global suppression |
|
Get the global suppression |
|
|
Delete the global suppression |
|
|
Add recipient to list |
|
|
List Recipient Lists |
|
|
List Recipients |
|
|
Get list of accessible scopes |
|
|
Get bounce for an email |
|
|
Delete an email from bounce list |
|
|
Check if email is in unsubscribed email list |
|
Name |
Summary |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
Email Is Unsubscribed Response |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Send email
Description: Sends an email using SendGrid API. (Deprecated version).
Syntax:
SendGrid.SendEmail (EmailRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
Email Request |
True |
Returns:
Type:EmailResponse
Description: Send Email Response
Summary: Send email (V2)
Description: Sends an email (V2). Limited to 1000 recipients.
Syntax:
SendGrid.SendEmailApiV3 (EmailRequestV3 request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
Email Request |
True |
Returns:
Type:Object
Summary: Send email (V3)
Description: Sends an email (V3). Limited to 1000 recipients.
Syntax:
SendGrid.SendEmailV3 (EmailRequestV4 request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
Email Request (V4) |
True |
Returns:
Type:Object
Summary: Send email (V4)
Description: Sends an email (V4). Limited to 1000 recipients.
Syntax:
SendGrid.SendEmailV4 (EmailRequestV5 request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
Include multipart attachments |
True |
Returns:
Type:Object
Summary: Add a global suppression
Description: Add a global suppression
Syntax:
SendGrid.AddGlobalSuppression (AddGlobalSuppressRequestAndResponse recipient_emails)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
recipient_emails |
AddGlobalSuppressRequestAndResponse
|
Add global suppress Response |
True |
Returns:
Type:AddGlobalSuppressRequestAndResponse
Description: Add global suppress Response
Summary: Get the global suppression
Description: Get the global suppression
Syntax:
SendGrid.GetGlobalSuppression (string email)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
|
string (Email) |
The email to check. |
True |
Returns:
Type:GetGlobalSuppressResponse
Description: Add global suppress Response
Summary: Delete the global suppression
Description: Delete the global suppression
Syntax:
SendGrid.DeleteGlobalSuppression (string email)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
|
string (Email) |
The email to delete. |
True |
Returns:
Summary: Add recipient to list
Description: Add an individual recipient to a recipient list.
Syntax:
SendGrid.AddRecipientToList (string listId, string recipientId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
listId |
string (List id) |
Unique id of the recipient list. |
True |
|
|
recipientId |
string (Recipient id) |
Unique id of the recipient. |
True |
Returns:
Type:Object
Summary: List Recipient Lists
Description: Retrieves all the recipient lists.
Syntax:
SendGrid.ListRecipientLists ()
Returns:
Type:RecipientLists
Description: List Recipients Response Item
Summary: List Recipients
Description: Retrieves all registered recipients.
Syntax:
SendGrid.ListRecipients ()
Returns:
Type:Recipients
Description: List of recipients
Summary: Get list of accessible scopes
Description: Retrieve a list of scopes for which that user has access.
Syntax:
SendGrid.GetScopes ()
Returns:
Type:ScopeList
Description: List of scopes
Summary: Get bounce for an email
Description: Get a specific bounce for a given email address.
Syntax:
SendGrid.GetBounce (string email)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
|
string (Email) |
The email to check. |
True |
Returns:
Type:array of (Bounce)
Summary: Bounce List
Description: List of bounces
Summary: Delete an email from bounce list
Description: Delete an email address from your bounce list.
Syntax:
SendGrid.DeleteBounce (string email)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
|
string (Email) |
The email to delete. |
True |
Returns:
Summary: Check if email is in unsubscribed email list
Description: Check if email is in unsubscribed email list.
Syntax:
SendGrid.CheckEmailIsInUnsubscribesList (string email)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
|
string (Email) |
The email to check. |
True |
Returns:
Type:EmailIsUnsubscribedResponse
Summary: Email Is Unsubscribed Response
Description: Email Is Unsubscribed Response
Summary:
Description: Add global suppress Response
Properties:
|
Name |
Type |
Summary |
|
recipient_emails |
array of (string) Recipient email |
Recipient email |
Summary:
Description: Get Bounce Response
Properties:
|
Name |
Type |
Summary |
|
created |
integer(int32) Created |
Created |
|
|
string |
|
|
reason |
string Reason |
Reason |
|
status |
string Status |
Status |
Summary:
Description: Attachment
Properties:
|
Name |
Type |
Summary |
|
content |
string(byte) Content |
Attachment file content |
|
filename |
string Name |
Attachment file name |
|
contenttype |
string ContentType |
Type of content in the attachment. |
Summary: Email Is Unsubscribed Response
Description: Email Is Unsubscribed Response
Properties:
|
Name |
Type |
Summary |
|
isUnsubscribed |
boolean Is Email Unsubscribed |
Is Email Unsubscribed |
Summary:
Description: Email Request
Properties:
|
Name |
Type |
Summary |
|
from |
string From |
Origination address of your email. Must be a valid email address from your domain |
|
fromname |
string From name |
Origination name of your email |
|
to |
string(email) To |
Receiving address of your email. Must include one or more valid comma separated email addresses |
|
toname |
string To names |
Comma separated receiving names of your email. Must match the number of "to" email addresses if specified |
|
subject |
string Subject |
Subject of your email |
|
body |
string Email body |
Content of your email. Supported formats include plain text and HTML |
|
ishtml |
boolean Is Html |
Specify whether the content of the email is HTML or plain text |
|
cc |
string(email) CC |
CC'ed addresses of your email. Must include one or more valid comma separated email addresses |
|
ccname |
string CC names |
Comma separated names of the cc'ed recipients |
|
bcc |
string(email) Bcc |
Bcc addresses of your email. Must include one or more valid comma separated email addresses |
|
bccname |
string Bcc names |
Comma separated names of the Bcc'ed recipients. |
|
replyto |
string(email) Reply to |
Reply To address of your email. Must be a valid email address |
|
date |
string(date-time) Date header |
Specify the date header of your email (Example: “Thu, 21 Dec 2000 16:01:07 +0200”). Must be a valid date |
|
headers |
string Custom headers |
Custom email headers in json format |
Summary:
Description: Email Request
Properties:
|
Name |
Type |
Summary |
|
from |
string(email) From |
Origination address of your email. Must be a valid email address from your domain |
|
fromname |
string From name |
Origination name of your email |
|
to |
string(email) To |
Valid email addresses separated by a semicolon or comma |
|
toname |
string To names |
A display name for each email address separated by a semicolon or comma |
|
subject |
string Subject |
Subject of your email |
|
text |
string Email body |
Content of your email |
|
ishtml |
boolean Is Html |
Specify whether the content of the email is HTML or plain text |
|
cc |
string(email) CC |
Valid email addresses separated by a semicolon or comma |
|
ccname |
string CC names |
A display name for each CC email address separated by a semicolon or comma |
|
bcc |
string(email) Bcc |
Valid email addresses separated by a semicolon or comma |
|
bccname |
string BCC names |
A display name for each BCC email address separated by a semicolon or comma |
|
file |
string(byte) Attachment |
Attachment file content |
|
filename |
string Attachment file name |
Attachment file name |
Summary:
Description: Email Request (V4)
Properties:
|
Name |
Type |
Summary |
|
from |
string(email) From |
Origination address of your email. Must be a valid email address from your domain |
|
fromname |
string From name |
Origination name of your email |
|
to |
string(email) To |
Valid email addresses separated by a semicolon or comma |
|
toname |
string To names |
A display name for each email address separated by a semicolon or comma |
|
subject |
string Subject |
Subject of your email |
|
text |
string(html) Email body |
Content of your email |
|
ishtml |
boolean Is Html |
Specify whether the content of the email is HTML or plain text |
|
cc |
string(email) CC |
Valid email addresses separated by a semicolon or comma |
|
ccname |
string CC names |
A display name for each CC email address separated by a semicolon or comma |
|
bcc |
string(email) Bcc |
Valid email addresses separated by a semicolon or comma |
|
bccname |
string BCC names |
A display name for each BCC email address separated by a semicolon or comma |
|
file |
string(byte) Attachment |
Attachment file content |
|
filename |
string Attachment file name |
Attachment file name |
Summary:
Description: Include multipart attachments
Properties:
|
Name |
Type |
Summary |
|
attachments |
array of (EmailAttachment) Attachment |
Attachments |
|
from |
string(email) From |
Origination address of your email. Must be a valid email address from your domain |
|
fromname |
string From name |
Origination name of your email |
|
to |
string(email) To |
Valid email addresses separated by a semicolon or comma |
|
toname |
string To names |
A display name for each email address separated by a semicolon or comma |
|
subject |
string Subject |
Subject of your email |
|
text |
string(html) Email body |
Content of your email |
|
ishtml |
boolean Is Html |
Specify whether the content of the email is HTML or plain text |
|
cc |
string(email) CC |
Valid email addresses separated by a semicolon or comma |
|
ccname |
string CC names |
A display name for each CC email address separated by a semicolon or comma |
|
bcc |
string(email) Bcc |
Valid email addresses separated by a semicolon or comma |
|
bccname |
string BCC names |
A display name for each BCC email address separated by a semicolon or comma |
Summary:
Description: Send Email Response
Properties:
|
Name |
Type |
Summary |
|
message |
string Status of the email sent: success/failure |
Status message from send email response |
Summary:
Description: Add global suppress Response
Properties:
|
Name |
Type |
Summary |
|
recipient_email |
string Recipient email |
Recipient email |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description: SendGrid recipient
Properties:
|
Name |
Type |
Summary |
|
|
string(email) |
Email address |
|
last_name |
string Last |
Last name |
|
first_name |
string First |
First name |
|
id |
string Id |
Unique recipient id |
Summary:
Description: Recipient list
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32) id |
Unique list id |
|
name |
string name |
Name |
|
recipient_count |
integer(int32) Recipient count |
Recipient count |
Summary:
Description: List Recipients Response Item
Properties:
|
Name |
Type |
Summary |
|
lists |
array of (RecipientList) Recipient lists |
List of recipient lists |
Summary:
Description: List of recipients
Properties:
|
Name |
Type |
Summary |
|
recipients |
array of (Recipient) Recipient List |
List of recipients |
Summary:
Description: List of scopes
Properties:
|
Name |
Type |
Summary |
|
scopes |
array of (string) Scope List |
List of scopes |