Connectors Reference

SparkPost

SparkPost API allows you to manage email recipient lists and send emails.

 

Status: Preview

Tier: Standard

Version: 1.0

 

Actions:

Name

Summary

ListRecipientLists ()

Get all the lists

CreateRecipientList (RecipientList recipientList)

Create recipient list

AddUserToRecipientList (string recipientListId, AddUserToRecipientListRequest addUserToRecipientListRequest)

Add user to recipient list

ListTemplates ()

Get all the stored templates

DeleteUserFromRecipientList (string recipientListId, DeleteUserFromRecipientListRequest deleteUserRequest)

Delete user from recipient list

SendEmailToRecipientList (EmailRecipientListRequest request)

Send email to a recipient list

SendEmailToRecipient (EmailRecipientRequest request)

Send email to a recipient

 

Triggers:

Name

Summary

OnNewRecipientList ()

When a new recipient list is created

 

Objects:

Name

Summary

Address

 

AddUserToRecipientListRequest

 

DeleteUserFromRecipientListRequest

 

EmailRecipient

 

EmailRecipientList

 

EmailRecipientListRequest

 

EmailRecipientRequest

 

EmailTemplateList

 

ListRecipientListsEntry

 

ListRecipientListsResponse

 

ListTemplatesEntry

 

ListTemplatesResponse

 

Object

 

Recipient

 

RecipientList

 

 

Actions:

ListRecipientLists

Summary: Get all the lists

Description: Find all the lists for the current user

 

Syntax:

SparkPost.ListRecipientLists ()

 

Returns:

          Type:ListRecipientListsResponse

          Description: List of this users recipient lists

 

CreateRecipientList

Summary: Create recipient list

Description: Create recipient list

 

Syntax:

SparkPost.CreateRecipientList (RecipientList recipientList)

 

Parameters:

Name

Type

Summary

Required

Related Action

recipientList

RecipientList

 

Maintains a list of recipients to whom a message can be sent

True

 

Returns:

          Type:Object

 

AddUserToRecipientList

Summary: Add user to recipient list

Description: Add user to recipient list

 

Syntax:

SparkPost.AddUserToRecipientList (string recipientListId, AddUserToRecipientListRequest addUserToRecipientListRequest)

 

Parameters:

Name

Type

Summary

Required

Related Action

recipientListId

string

(Recipient)

Select a SparkPost recipient list

True

ListRecipientLists

addUserToRecipientListRequest

AddUserToRecipientListRequest

 

Request template for adding a user to a recipient list

True

 

Returns:

          Type:Object

 

ListTemplates

Summary: Get all the stored templates

Description: Find all the stored templates for the current user

 

Syntax:

SparkPost.ListTemplates ()

 

Returns:

          Type:ListTemplatesResponse

          Description: List of users store templates.

 

DeleteUserFromRecipientList

Summary: Delete user from recipient list

Description: Delete user from recipient list

 

Syntax:

SparkPost.DeleteUserFromRecipientList (string recipientListId, DeleteUserFromRecipientListRequest deleteUserRequest)

 

Parameters:

Name

Type

Summary

Required

Related Action

recipientListId

string

(Recipient)

Select a SparkPost recipient list

True

ListRecipientLists

deleteUserRequest

DeleteUserFromRecipientListRequest

 

Request template for removing a user to a recipient list

True

 

Returns:

          Type:Object

 

SendEmailToRecipientList

Summary: Send email to a recipient list

Description: Send email to a recipient list

 

Syntax:

SparkPost.SendEmailToRecipientList (EmailRecipientListRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

request

EmailRecipientListRequest

 

Request object for email recipient list post.

True

 

Returns:

          Type:Object

 

SendEmailToRecipient

Summary: Send email to a recipient

Description: Send email to a recipient

 

Syntax:

SparkPost.SendEmailToRecipient (EmailRecipientRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

request

EmailRecipientRequest

 

Request object for email recipient post.

True

 

Returns:

          Type:Object

 

Triggers:

Trigger OnNewRecipientList

Summary: When a new recipient list is created

Description: When a new recipient list is created

 

Syntax:

SparkPost.OnNewRecipientList ()

 

Returns:

          Type:ListRecipientListsResponse

          Description: List of this users recipient lists

 


 

Address

Summary:

Description: Holds the address for a recipient

 

          Properties:

Name

Type

Summary

email

string

Email address

Email Address

name

string

Name

Name


 

AddUserToRecipientListRequest

Summary:

Description: Request template for adding a user to a recipient list

 

          Properties:

Name

Type

Summary

recipient

Recipient

 

Recipient can be sent emails through Spark Post


 

DeleteUserFromRecipientListRequest

Summary:

Description: Request template for removing a user to a recipient list

 

          Properties:

Name

Type

Summary

email_address

string

Email address

Email address


 

EmailRecipient

Summary:

Description: Recipients to send email to

 

          Properties:

Name

Type

Summary

address

string

Email address

Email address


 

EmailRecipientList

Summary:

Description: Recipient list to send email to

 

          Properties:

Name

Type

Summary

list_id

string

Recipient

Select a SparkPost recipient list


 

EmailRecipientListRequest

Summary:

Description: Request object for email recipient list post.

 

          Properties:

Name

Type

Summary

recipients

EmailRecipientList

 

Recipient list to send email to

content

EmailTemplateList

 

List of email templates

campaign_id

string

Campaign Id

Campaign Id


 

EmailRecipientRequest

Summary:

Description: Request object for email recipient post.

 

          Properties:

Name

Type

Summary

content

EmailTemplateList

 

List of email templates

recipients

array of (EmailRecipient)

Recipients

Recipients


 

EmailTemplateList

Summary:

Description: List of email templates

 

          Properties:

Name

Type

Summary

template_id

string

Template

Select a SparkPost stored template


 

ListRecipientListsEntry

Summary:

Description: A SparkPost RecipientListEntry Object

 

          Properties:

Name

Type

Summary

id

string

List ID

Identifier of the list

name

string

List Name

Name of the List

description

string

List Description

Description of the List


 

ListRecipientListsResponse

Summary:

Description: List of this users recipient lists

 

          Properties:

Name

Type

Summary

results

array of (ListRecipientListsEntry)

Recipients

List of recipient lists


 

ListTemplatesEntry

Summary:

Description: A SparkPost ListTemplatesEntry Object

 

          Properties:

Name

Type

Summary

id

string

Template ID

Identifier of the template

name

string

Template Name

Name of the Template

description

string

Template Description

Description of the Template

published

boolean

Published

Indicates whether template published or not.

last_update_time

string

Last Update Time

Last update time of the Template


 

ListTemplatesResponse

Summary:

Description: List of users store templates.

 

          Properties:

Name

Type

Summary

results

array of (ListTemplatesEntry)

Templates

List of templates


 

Object

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

Recipient

Summary:

Description: Recipient can be sent emails through Spark Post

 

          Properties:

Name

Type

Summary

address

Address

 

Holds the address for a recipient


 

RecipientList

Summary:

Description: Maintains a list of recipients to whom a message can be sent

 

          Properties:

Name

Type

Summary

id

string

Id of the recipient list

Id

name

string

Name of the recipient list

Name

description

string

Description

Description

email

string

Email address of first recipient

Email address