Streamdata.io API Gallery - SparkPost (Report Issue)

Organization(s):

SparkPost Retrieve Account Usage

Retrieve account usage.

SparkPost List all Bounce Domains

List all bounce domains.

SparkPost Create a Bounce Domain

Create a bounce domain.

SparkPost Delete a Bounce Domain

Delete a bounce domain.

SparkPost Retrieve a Bounce Domain

Retrieve a bounce domain.

SparkPost Verify a Bounce Domain

Verify a bounce domain.

SparkPost List all Inbound Domains

List all your inbound domains.

SparkPost Create an Inbound Domain

Create an inbound domain by providing an **inbound domains object** as the POST request body.

SparkPost Delete an Inbound Domain

Delete an inbound domain by specifying its domain name in the URI path.

SparkPost Retrieve an Inbound Domain

Retrieve an inbound domain by specifying its domain name in the URI path.

SparkPost List all IP Pools

List all ip pools.

SparkPost Create an IP Pool

Create an ip pool.

SparkPost Delete an IP Pool

Delete an ip pool.

SparkPost Get an IP Pool

Get an ip pool.

SparkPost Update an IP Pool

Update an ip pool.

SparkPost Search for Message Events

Perform a filtered search for message event data. The response is sorted by descending timestamp.

SparkPost Documentation

List descriptions of the event fields that could be included in a response from the Message Events search endpoint. Fields will vary by event type.

SparkPost Samples

List an example of the event data that will be included in a response from the Message Events search endpoint.

SparkPost Metrics Discoverability Links

Provides links to all child URIs within the Metrics API. **Note:** Links in the response for binding-groups, bindings, nodes, and protocols apply to SparkPost Elite only.

SparkPost Binding Groups List

**Note:** This endpoint is available in SparkPost Elite only. Returns a list of binding groups that the Metrics API contains data on.

SparkPost Bindings List

**Note:** This endpoint is available in SparkPost Elite only. Returns a list of bindings that the Metrics API contains data on.

SparkPost Campaigns List

Returns a list of campaigns that the Metrics API contains data on.

SparkPost Deliverability Metrics Summary

Provides high-level summary of aggregate metrics and lists the child endpoints that contain aggregate data, which can be used as "group by" qualifiers.

SparkPost Deliveries By Attempt

Provides aggregate count of deliveries grouped by the attempt number.

SparkPost Deliverability Metrics by Binding

**Note:** This endpoint is available in SparkPost Elite only. Provides aggregate metrics grouped by binding over the time window specified.

SparkPost Deliverability Metrics by Binding Group

**Note:** This endpoint is available in SparkPost Elite only. Provides aggregate metrics grouped by binding group over the time window specified.

SparkPost Bounce Classification Metrics

Provides deliverability metrics, specific to bounce events, grouped by the bounce classification. (See [Bounce Classification Codes.](https://www.sparkpost.com/docs/bounce-classification-codes))

SparkPost Bounce Reason Metrics

Provides deliverability metrics, specific to bounce events, grouped by the bounce reasons.

SparkPost Bounce Reason Metrics By Domain

Provides deliverability metrics, specific to bounce events, grouped by the domain and bounce reasons.

SparkPost Deliverability Metrics by Campaign

Provides aggregate metrics grouped by campaign over the time window specified.

SparkPost Delay Reason Metrics

Provides deliverability metrics, specific to delay events, grouped by the delay reasons.

SparkPost Delay Reason Metrics By Domain

Provides deliverability metrics, specific to delay events, grouped by the domain and delay reasons.

SparkPost Deliverability Metrics by Domain

Provides aggregate metrics grouped by domain over the time window specified.

SparkPost Engagement Details

Provides deliverability metrics, specific to engagement events (clicks/opens), grouped by the link name (or URL if no link name exists).

SparkPost Rejection Reason Metrics

Provides deliverability metrics, specific to rejection events, grouped by the rejection reasons.

SparkPost Rejection Reason Metrics By Domain

Provides deliverability metrics, specific to rejection events, grouped by the domain and rejection reasons.

SparkPost Deliverability Metrics by Sending IP

Deliverability metrics by sending ip.

SparkPost Deliverability Metrics by Template

Provides aggregate metrics grouped by template over the time window specified.

SparkPost Time-Series Metrics

Provides deliverability metrics ordered by a precision of time. The following table describes the validation for the **precision** parameter: | Value of | Valid for time window of | |---------------|-------------| |1min, 5min |day | |...

SparkPost Deliverability Metrics by Watched Domain

Provides aggregate metrics grouped by watched domain over the time window specified. The difference between domain and watched domain is that watched domains are comprised of the top 99% domains in the world.

SparkPost Domains List

Returns a list of domains that the Metrics API contains data on.

SparkPost Nodes List

**Note:** This endpoint is available in SparkPost Elite only. Returns a list of nodes that the Metrics API contains data on.

SparkPost Protocols List

**Note:** This endpoint is available in SparkPost Elite only. Returns a list of protocols that the Metrics API contains data on.

SparkPost List all Recipient Lists

List a summary of all recipient lists. The recipients for each list are not included in the results. To retrieve recipient details, use the RETRIEVE API for a specified recipient list.

SparkPost Create a Recipient List

Create a recipient list by providing a **recipient list object** as the POST request body. At a minimum, the "recipients" array is required, which must contain a valid "address". If the recipient list "id" is not provided in the POST request bod...

SparkPost Retrieve a Recipient List

Retrieve details about a specified recipient list by specifying its id in the URI path. To retrieve the recipients contained in a list, the list must be specified and the **show_recipients** parameter must be set to true. **Note:** The "return_p...

SparkPost Delete a Recipient List

Permanently delete the specified recipient list. Once a recipient list is deleted, it cannot be recovered. Before deleting a list, ensure that it is no longer needed and keep a backup copy. If a deleted list is needed again, the list must be re...

SparkPost Update a Recipient List

Update an existing recipient list by specifying its ID in the URI path and use a **recipient list object** as the PUT request body. Use the **num_rcpt_errors** parameter to limit the number of recipient errors returned. The following are key poin...

SparkPost List all Relay Webhooks

List all your relay webhooks.

SparkPost Create a Relay Webhook

Create a relay webhook by providing a **relay webhooks object** as the POST request body.

SparkPost Delete a Relay Webhook

Delete a relay webhook by specifying the webhook ID in the URI path.

SparkPost Retrieve a Relay Webhook

Retrieve a specific relay webhook by specifying the webhook ID in the URI path.

SparkPost Update a Relay Webhook

Update a relay webhook by specifying the webhook ID in the URI path.

SparkPost List all Sending Domains

List an overview of all sending domains in the system.

SparkPost Create a Sending Domain

Create a sending domain by providing a **sending domain object** as the POST request body. **Note**: For some SparkPost Elite customers, Sending Domains will be set to verified automatically when they are created, and can be used to send messages...

SparkPost Delete a Sending Domain

Delete an existing sending domain. **Warning:** Before deleting a sending domain please ensure you are no longer using it. After deleting a sending domain, any new transmissions that use it will result in a rejection. This includes any transmissi...

SparkPost Retrieve a Sending Domain

Retrieve a sending domain by specifying its domain name in the URI path. The response includes details about its DKIM key configuration.

SparkPost Update a Sending Domain

Update the attributes of an existing sending domain by specifying its domain name in the URI path and use a **sending domain object** as the PUT request body. If a tracking domain is specified, it will replace any currently specified tracking dom...

SparkPost Verify a Sending Domain

The verify resource operates differently depending on the provided request fields: * Including the fields "dkim_verify" and/or "spf_verify" in the request initiates a check against the associated DNS record type for the specified sending domain...

SparkPost Get all Sending IPs

Get all sending ips.

SparkPost Get a Sending IP

Get a sending ip.

SparkPost Update a Sending IP

Updates the IP Pool of a sending IP.

SparkPost List subaccounts

Endpoint for retrieving a list of your subaccounts. This endpoint only returns information about the subaccounts themselves, not the data associated with the subaccount.

SparkPost Create new subaccount

Provisions a new subaccount and an initial subaccount API key. Subaccount API keys are only allowed very specific grants, which are limited to: `smtp/inject`, `sending_domains/manage`, `message_events/view` and `suppression_lists/manage`. Subaccou...

SparkPost List specific subaccount

Endpoint for retrieving information about a specific subaccount.

SparkPost Edit a subaccount

Update an existing subaccount's information. You can update the following information associated with a subaccount: #### Request Body Attributes | Field | Required | Type | Description | Notes | | ---...

SparkPost Search for List Entries

Perform a filtered search for entries in your customer-specific exclusion list.

SparkPost Insert or Update List Entries

Bulk insert or update entries in the customer-specific exclusion list by providing a JSON object, with a "recipients" key containing an array of recipients to insert or update, as the PUT request body. Maximum size of the JSON object is 50mb. At a...

SparkPost Delete a List Entry

Delete a recipient from the list by specifying the recipient's email address in the URI path. If the recipient is not in the customer-specific exclusion list, an HTTP status of 404 is returned. If the recipient is in the list, an HTTP status of 2...

SparkPost Retrieve a Recipient Suppression Status

Retrieve the suppression status for a specific recipient by specifying the recipient’s email address in the URI path. If the recipient is not in the customer-specific exclusion list, an HTTP status of 404 is returned. If the recipient is in the l...

SparkPost List all Templates

Lists the most recent version of each template in your account. Each template object in the list will have the following fields: - id: Unique template ID - name: Template name - published: Published state of the template (true = published, fals...

SparkPost Create a Template

Create a template by providing a **template object** as the POST request body. At a minimum, the "name" and "content" fields are required, where content must contain the "from", "subject", and at least one of "html" or "text" fields. By default,...

SparkPost Delete a Template

Delete a template by specifying its ID in the URI path. If the template delete API call succeeds, then ALL versions of the template will be deleted from the system (both published AND draft versions). If a transmission uses a stored template, the...

SparkPost Retrieve a Template

Retrieve a single template by specifying its ID in the URI path. By default, the most recently updated version is returned. Use the **draft** query parameter to specify a draft or published template. The result will include a "last_update_time" ...

SparkPost Update a Template

Update an existing template by specifying its ID in the URI path and use a **template object** as the PUT request body. By default, the update will result in a new draft version, but the published version can be overwritten directly by using the *...

SparkPost Preview a Template

Preview the most recent version of an existing template by specifying {id}/preview in the URI path and providing "substitution_data" as part of the POST request body. The template's content will be expanded using the substitution data provided and...

SparkPost List all Tracking Domains

Retrieve a list of all tracking domains. **NOTE:** For SparkPost, port and secure are not returned since they are hard coded values.

SparkPost Create a Tracking Domain

Create a tracking domain. A tracking domain cannot be set as the default until it is verified. **NOTE:** For SparkPost, only domain is required in the POST request body. The values for port (80) and secure (false) are not configurable.

SparkPost Delete a Tracking Domain

Delete an existing tracking domain.

SparkPost Retrieve a Tracking Domain

Retrieve an existing tracking domain. **NOTE:** For SparkPost, port and secure are not returned since they are hard coded values.

SparkPost Update a Tracking Domain

Update the attributes of an existing tracking domain. A tracking domain cannot be set as the default until it is verified. If a tracking domain is set to the default, and there is already a default domain, the default is changed. **NOTE:** For ...

SparkPost Verify a Tracking Domain

Initiate a check against the CNAME DNS record for the specified tracking domain. The domain's `status` object is returned on success.

SparkPost Create a Transmission (metadata with stored template and inline recipients)

You can create a transmission in a number of ways. In all cases, you can use the **num_rcpt_errors** parameter to limit the number of recipient errors returned. **Note:** The "return_path" in the POST request body applies to SparkPost Elite only....

SparkPost Delete a Transmission

Delete a transmission by specifying its ID in the URI path. Only transmissions which are scheduled for future generation may be deleted. Scheduled transmissions cannot be deleted if the transmission is within 10 minutes of the scheduled generati...

SparkPost List all Webhooks

List currently extant webhooks.

SparkPost Create a Webhook

Create a webhook by providing a **webhooks object** as the POST request body. On creation, events will begin to be pushed to the target URL specified in the POST request body. As described in "Webhooks Object Properties", webhook creation entail...

SparkPost Delete a Webhook

Delete a webhook from the system by specifying its id in the URI path. The system will stop pushing data to the target URL after the batches currently queued to be delivered are drained.

SparkPost Retrieve Webhook Details

Retrieve details about a webhook by specifying its id in the URI path.

SparkPost Update a Webhook

Update a webhook's properties by specifying its id in the URI path and use a **webhooks object** as the PUT request body. Note that batches currently queued for delivery to this webhook will not be affected by these modifications. For example, i...

SparkPost Retrieve Status Information

Retrieve status information regarding batches that have been generated for the given webhook by specifying its id in the URI path. Status information includes the successes of batches that previously failed to reach the webhook's target URL and ba...

SparkPost Validate a Webhook

The validation sends an example message event batch from the Webhooks API to the target URL, validates that the target responds with HTTP 200, and returns detailed information on the response received from the target. #### Message Properties | P...

SparkPost Documentation

List descriptions of the events, event types, and event fields that could be included in a Webhooks post to your target URL.

SparkPost Samples

List an example of the event data that will be posted by a Webhook for the specified events. **Note:** the data that will arrive at your target URL will **not** contain the top level ``results`` key shown in the example response.

Submit Your API

Join the gallery to find out how much you can save with Streamdata.io.