SparkPost
SparkPost API allows you to manage email recipient lists and send emails.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Standard | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Apps | Standard | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Automate | Standard | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Microsoft |
| URL | Microsoft LogicApps Support Microsoft Power Automate Support Microsoft Power Apps Support |
| Connector Metadata | |
|---|---|
| Publisher | Microsoft |
| Website | https://www.sparkpost.com/ |
| Privacy policy | https://www.sparkpost.com/policies/privacy/ |
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| SparkPost API Key | securestring | SparkPost API Key | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 30 | 60 seconds |
| Frequency of trigger polls | 1 | 15 seconds |
Actions
| Add user to recipient list |
Add user to recipient list |
| Create recipient list |
Create recipient list |
| Delete user from recipient list |
Delete user from recipient list |
| Send email to a recipient |
Send email to a recipient |
| Send email to a recipient list |
Send email to a recipient list |
Add user to recipient list
Add user to recipient list
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Recipient
|
recipientListId | True | string |
Select a SparkPost recipient list |
|
Email address
|
True | string |
Email Address |
|
|
Name
|
name | string |
Name |
Returns
- response
- object
Create recipient list
Create recipient list
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Id of the recipient list
|
id | string |
Id |
|
|
Name of the recipient list
|
name | string |
Name |
|
|
Description
|
description | string |
Description |
|
|
Email address of first recipient
|
string |
Email address |
Returns
- response
- object
Delete user from recipient list
Delete user from recipient list
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Recipient
|
recipientListId | True | string |
Select a SparkPost recipient list |
|
Email address
|
email_address | string |
Email address |
Returns
- response
- object
Send email to a recipient
Send email to a recipient
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Template
|
template_id | True | string |
Select a SparkPost stored template |
|
Email address
|
address | True | string |
Email address |
Returns
- response
- object
Send email to a recipient list
Send email to a recipient list
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Recipient
|
list_id | True | string |
Select a SparkPost recipient list |
|
Template
|
template_id | True | string |
Select a SparkPost stored template |
|
Campaign Id
|
campaign_id | string |
Campaign Id |
Returns
- response
- object
Triggers
| When a new recipient list is created |
When a new recipient list is created |
When a new recipient list is created
When a new recipient list is created
Returns
List of this users recipient lists
Definitions
ListRecipientListsResponse
List of this users recipient lists
| Name | Path | Type | Description |
|---|---|---|---|
|
Recipients
|
results | array of ListRecipientListsEntry |
List of recipient lists |
ListRecipientListsEntry
A SparkPost RecipientListEntry Object
| Name | Path | Type | Description |
|---|---|---|---|
|
List ID
|
id | string |
Identifier of the list |
|
List Name
|
name | string |
Name of the List |
|
List Description
|
description | string |
Description of the List |
object
This is the type 'object'.