SparkPost API allows you to manage email recipient lists and send emails.
Status: Preview |
Tier: Standard |
Version: 1.0 |
Name |
Summary |
Get all the lists |
|
Create recipient list |
|
Add user to recipient list |
|
Get all the stored templates |
|
Delete user from recipient list |
|
SendEmailToRecipientList (EmailRecipientListRequest request) |
Send email to a recipient list |
Send email to a recipient |
Name |
Summary |
When a new recipient list is created |
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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
Summary: Create recipient list
Description: Create recipient list
Syntax:
SparkPost.CreateRecipientList (RecipientList recipientList)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
recipientList |
|
Maintains a list of recipients to whom a message can be sent |
True |
Returns:
Type:Object
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 |
|
addUserToRecipientListRequest |
|
Request template for adding a user to a recipient list |
True |
Returns:
Type:Object
Summary: Get all the stored templates
Description: Find all the stored templates for the current user
Syntax:
SparkPost.ListTemplates ()
Returns:
Description: List of users store templates.
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 |
|
deleteUserRequest |
DeleteUserFromRecipientListRequest
|
Request template for removing a user to a recipient list |
True |
Returns:
Type:Object
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 |
|
Request object for email recipient list post. |
True |
Returns:
Type:Object
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 |
|
Request object for email recipient post. |
True |
Returns:
Type:Object
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
Summary:
Description: Holds the address for a recipient
Properties:
Name |
Type |
Summary |
|
string Email address |
Email Address |
name |
string Name |
Name |
Summary:
Description: Request template for adding a user to a recipient list
Properties:
Name |
Type |
Summary |
recipient |
|
Recipient can be sent emails through Spark Post |
Summary:
Description: Request template for removing a user to a recipient list
Properties:
Name |
Type |
Summary |
email_address |
string Email address |
Email address |
Summary:
Description: Recipients to send email to
Properties:
Name |
Type |
Summary |
address |
string Email address |
Email address |
Summary:
Description: Recipient list to send email to
Properties:
Name |
Type |
Summary |
list_id |
string Recipient |
Select a SparkPost recipient list |
Summary:
Description: Request object for email recipient list post.
Properties:
Name |
Type |
Summary |
recipients |
|
Recipient list to send email to |
content |
|
List of email templates |
campaign_id |
string Campaign Id |
Campaign Id |
Summary:
Description: Request object for email recipient post.
Properties:
Name |
Type |
Summary |
content |
|
List of email templates |
recipients |
array of (EmailRecipient) Recipients |
Recipients |
Summary:
Description: List of email templates
Properties:
Name |
Type |
Summary |
template_id |
string Template |
Select a SparkPost stored template |
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 |
Summary:
Description: List of this users recipient lists
Properties:
Name |
Type |
Summary |
results |
array of (ListRecipientListsEntry) Recipients |
List of recipient lists |
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 |
Summary:
Description: List of users store templates.
Properties:
Name |
Type |
Summary |
results |
array of (ListTemplatesEntry) Templates |
List of templates |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description: Recipient can be sent emails through Spark Post
Properties:
Name |
Type |
Summary |
address |
|
Holds the address for a recipient |
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 |
|
string Email address of first recipient |
Email address |