| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Main | rest | https://api.sparkpost.com/api/v1 | link | — | — | — |
Actions (69)
Sending · 33
- Create a Recipient ListPOST /api/v1/recipient-lists
Create a new recipient list with recipients and metadata.
documented - Create a Recipient List (with error limit)POST /api/v1/recipient-lists{?num_rcpt_errors}
Create a recipient list with optional max error reporting.
documented - Create a Sending DomainPOST /api/v1/sending-domains
Create a new sending domain.
documented - Create a TemplatePOST /api/v1/templates
Create a new template (draft by default).
documented - Create an IP PoolPOST /api/v1/ip-pools
Create a new IP pool with DKIM and warmup settings.
documented - Create transmissionPOST /api/v1/transmissions
Create a new transmission to send email (inline content, template, or RFC822)
documented - Delete a Recipient ListDELETE /api/v1/recipient-lists/{id}
Delete a recipient list.
documented - Delete a Sending DomainDELETE /api/v1/sending-domains/{domain}
Delete a sending domain.
documented - Delete a TemplateDELETE /api/v1/templates/{id}
Delete both draft and published versions of a template.
documented - Delete a scheduled transmissionDELETE /api/v1/transmissions/{id}
Delete a scheduled transmission (deprecated behavior in some cases).
documented - Delete an IP PoolDELETE /api/v1/ip-pools/{id}
Delete an IP pool.
documented - Delete transmissions by campaign IDDELETE /api/v1/transmissions{?campaign_id}
Delete all transmissions belonging to a given campaign (query param campaign_id).
documented - List IP PoolsGET /api/v1/ip-pools
List all IP pools.
documented - List Sending DomainsGET /api/v1/sending-domains
List all sending domains.
documented - List all Recipient ListsGET /api/v1/recipient-lists
Return an array of abbreviated recipient list objects (recipients not included).
documented - List all TemplatesGET /api/v1/templates{?draft,shared_with_subaccounts}
List templates (drafts or published depending on query).
documented - Preview Template ContentPOST /api/v1/utils/content-previewer
Preview the rendered content for a template.
documented - Preview a TemplatePOST /api/v1/templates/{id}/preview{?draft}
Preview a template (draft or published) using substitution data.
documented - Preview a Template (draft or published)GET /api/v1/templates/{id}/preview{?draft}
Preview a template version.
documented - Preview an inline TemplatePOST /api/v1/templates/{id}/preview
Preview an inline template version.
documented - Retrieve a Recipient ListGET /api/v1/recipient-lists/{id}{?show_recipients}
Get a recipient list; include recipients if show_recipients=true.
documented - Retrieve a Sending DomainGET /api/v1/sending-domains/{domain}
Retrieve a specific sending domain.
documented - Retrieve a TemplateGET /api/v1/templates/{id}{?draft}
Get a template (draft or published version).
documented - Retrieve an IP PoolGET /api/v1/ip-pools/{id}
Retrieve a single IP pool.
documented - Retrieve transmissionGET /api/v1/transmissions/{id}
Get details about a specific transmission (including scheduled and generating transmissions)
documented - SMTP InjectPOST /api/v1/smtp
Inject a message for SMTP delivery via the SparkPost SMTP API.
documented - Schedule a transmissionPOST /api/v1/transmissions/
Schedule a transmission to be generated/sent at a future time (start_time in options).
documented - Update a Draft TemplatePUT /api/v1/templates/{id}
Update the draft template version.
documented - Update a Published TemplatePUT /api/v1/templates/{id}{?update_published}
Update the published template version (or draft if update_published is not set).
documented - Update a Recipient ListPUT /api/v1/recipient-lists/{id}{?num_rcpt_errors}
Update a recipient list (optionally limit recipient errors returned).
documented - Update a Sending DomainPUT /api/v1/sending-domains/{domain}
Update a sending domain.
documented - Update an IP PoolPUT /api/v1/ip-pools/{id}
Update an IP pool.
documented - Verify a Sending DomainPOST /api/v1/sending-domains/{domain}/verify
Verify a sending domain.
documented
Analytics · 14
- Create a Tracking DomainPOST /api/v1/tracking-domains
Create a tracking domain.
documented - Create a WebhookPOST /api/v1/webhooks
Create an event webhook.
documented - Delete a WebhookDELETE /api/v1/webhooks/{id}
Delete a webhook.
documented - List Ingest EventsGET /api/v1/events/ingest{?cursor,events}
Query ingest events.
documented - List Message EventsGET /api/v1/events/message
Query message events (inbound, delivered, clicks, opens, etc.).
documented - List Tracking DomainsGET /api/v1/tracking-domains
List tracking domains.
documented - List all WebhooksGET /api/v1/webhooks
List all event webhooks for your account.
documented - List all Webhooks (short)GET /api/v1/webhooks{?}
List webhooks (short form).
documented - Retrieve a Tracking DomainGET /api/v1/tracking-domains/{domain}
Retrieve a tracking domain.
documented - Retrieve a WebhookGET /api/v1/webhooks/{id}
Get a webhook by ID.
documented - Search EventsGET /api/v1/events{?filters}
General events search with many filters.
documented - Update a Tracking DomainPUT /api/v1/tracking-domains/{domain}
Update a tracking domain.
documented - Update a WebhookPUT /api/v1/webhooks/{id}
Update a webhook.
documented - Verify a Tracking DomainPOST /api/v1/tracking-domains/{domain}/verify
Verify a tracking domain.
documented
Accounts · 11
- Create a SubaccountPOST /api/v1/subaccounts
Create a new subaccount and initial API key.
documented - Data Privacy Opt-Out RequestPOST /api/v1/data-privacy/opt-out-request
Request opt-out for data usage.
documented - Data Right To Be Forgotten (bulk)POST /api/v1/data-privacy/rtbf-request
Bulk RTBF request for multiple recipients.
documented - Data Right To Be Forgotten RequestPOST /api/v1/data-privacy/rtbf-request
Request deletion/forgetting of recipient data.
documented - List SubaccountsGET /api/v1/subaccounts
List subaccounts with pagination.
documented - Retrieve AccountGET /api/v1/account{?include}
Get account details (optionally include usage).
documented - Retrieve Account with UsageGET /api/v1/account?include=usage
Get account details including usage information.
documented - Retrieve Subaccounts SummaryGET /api/v1/subaccounts/summary
Get total number of subaccounts.
documented - Retrieve a SubaccountGET /api/v1/subaccounts/{id}
Retrieve a specific subaccount.
documented - Update AccountPUT /api/v1/account
Update account properties (e.g., company name, smtp tracking).
documented - Update a SubaccountPUT /api/v1/subaccounts/{id}
Update a subaccount.
documented
Receiving · 6
- Create a Relay WebhookPOST /api/v1/relay-webhooks
Create a relay webhook to forward inbound messages.
documented - Delete Relay WebhookDELETE /api/v1/relay-webhooks/{id}
Delete a relay webhook.
documented - List Relay WebhooksGET /api/v1/relay-webhooks
List relay webhooks.
documented - Retrieve Relay WebhookGET /api/v1/relay-webhooks/{id}
Get a relay webhook by ID.
documented - Update Relay WebhookPUT /api/v1/relay-webhooks/{id}
Update a relay webhook.
documented - Validate Relay WebhookPOST /api/v1/relay-webhooks/{id}/validate
Validate a relay webhook by sending a test payload.
documented
Ingest · 5
- Get Failure Ingest BatchGET /api/v1/ingest/events/failures/{id}
Download failures for a failed ingest batch.
documented - Get Ingest BatchGET /api/v1/ingest/events/{id}
Download a previously ingested batch (NDJSON).
documented - Ingest DocumentationGET /api/v1/ingest/events/documentation
Docs describing ingest event fields.
documented - Ingest Events SamplesGET /api/v1/ingest/events/samples{?events}
Samples of ingest events for given event types.
documented - Send Ingest EventsPOST /api/v1/ingest/events
Post a batch of NDJSON events for ingestion.
documented