Connectors Reference

SendGrid

SendGrid Connection Provider lets you send email and manage recipient lists.

 

Status: Preview

Tier: Standard

Version: 1.0

 

Actions:

Name

Summary

SendEmail (EmailRequest request)

Send email

SendEmailApiV3 (EmailRequestV3 request)

Send email (V2)

AddGlobalSuppression (AddGlobalSuppressRequestAndResponse recipient_emails)

Add a global suppression

GetGlobalSuppression (string email)

Get the global suppression

DeleteGlobalSuppression (string email)

Delete the global suppression

AddRecipientToList (string listId, string recipientId)

Add recipient to list

ListRecipientLists ()

List Recipient Lists

ListRecipients ()

List Recipients

GetScopes ()

Get list of accessible scopes

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

AddGlobalSuppressRequestAndResponse

 

EmailRequest

 

EmailRequestV3

 

EmailResponse

 

GetGlobalSuppressResponse

 

Object

 

Recipient

 

RecipientList

 

RecipientLists

 

Recipients

 

ScopeList

 

 

Actions:

SendEmail

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

EmailRequest

 

Email Request

True

 

Returns:

          Type:EmailResponse

          Description: Send Email Response

 

SendEmailApiV3

Summary: Send email (V2)

Description: Sends an email (V2). Limited to 10,000 recipients.

 

Syntax:

SendGrid.SendEmailApiV3 (EmailRequestV3 request)

 

Parameters:

Name

Type

Summary

Required

Related Action

request

EmailRequestV3

 

Email Request

True

 

Returns:

          Type:EmailResponse

          Description: Send Email Response

 

AddGlobalSuppression

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

 

GetGlobalSuppression

Summary: Get the global suppression

Description: Get the global suppression

 

Syntax:

SendGrid.GetGlobalSuppression (string email)

 

Parameters:

Name

Type

Summary

Required

Related Action

email

string

(Email)

The email to check.

True

 

Returns:

          Type:GetGlobalSuppressResponse

          Description: Add global suppress Response

 

DeleteGlobalSuppression

Summary: Delete the global suppression

Description: Delete the global suppression

 

Syntax:

SendGrid.DeleteGlobalSuppression (string email)

 

Parameters:

Name

Type

Summary

Required

Related Action

email

string

(Email)

The email to delete.

True

 

Returns:

 

AddRecipientToList

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

ListRecipientLists

recipientId

string

(Recipient id)

Unique id of the recipient.

True

ListRecipients

 

Returns:

          Type:Object

 

ListRecipientLists

Summary: List Recipient Lists

Description: Retrieves all the recipient lists.

 

Syntax:

SendGrid.ListRecipientLists ()

 

Returns:

          Type:RecipientLists

          Description: List Recipients Response Item

 

ListRecipients

Summary: List Recipients

Description: Retrieves all registered recipients.

 

Syntax:

SendGrid.ListRecipients ()

 

Returns:

          Type:Recipients

          Description: List of recipients

 

GetScopes

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

 


 

AddGlobalSuppressRequestAndResponse

Summary:

Description: Add global suppress Response

 

          Properties:

Name

Type

Summary

recipient_emails

array of (string)

Recipient email

Recipient email


 

EmailRequest

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  Values: [true, false]

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

files

array of (string)

Attachment

Attachment file content

filenames

array of (string)

Attachment file names

Attachment file names


 

EmailRequestV3

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  Values: [true, false]

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


 

EmailResponse

Summary:

Description: Send Email Response

 

          Properties:

Name

Type

Summary

message

string

Status of the email sent: success/failure

Status message from send email response


 

GetGlobalSuppressResponse

Summary:

Description: Add global suppress Response

 

          Properties:

Name

Type

Summary

recipient_email

string

Recipient email

Recipient email


 

Object

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

Recipient

Summary:

Description: SendGrid recipient

 

          Properties:

Name

Type

Summary

email

string(email)

email

Email address

last_name

string

Last

Last name

first_name

string

First

First name

id

string

Id

Unique recipient id


 

RecipientList

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


 

RecipientLists

Summary:

Description: List Recipients Response Item

 

          Properties:

Name

Type

Summary

lists

array of (RecipientList)

Recipient lists

List of recipient lists


 

Recipients

Summary:

Description: List of recipients

 

          Properties:

Name

Type

Summary

recipients

array of (Recipient)

Recipient List

List of recipients


 

ScopeList

Summary:

Description: List of scopes

 

          Properties:

Name

Type

Summary

scopes

array of (string)

Scope List

List of scopes