SparkPost API - API Reference

Sending Domains

POST /sending-domains/{domain}/verify Verify a Sending Domain ▼

Verifies all the domain settings required for use of the domain for sending and receiving messages.

Request will perform a complete validation check of all required DNS records. All options available in the original Sparkpost API are ignored, eg. (dkim_verify, cname_verify, spf_verify, etc.)

Parameters

Name	In	Type	Required	Description
`Authorization`	header	string	Yes	Authorization header must contain your account's primary API token
`domain`	path	string	Yes	Domain name to verify

Responses

200

OK

Code Samples

curl -X POST 'https://sp-api.omnivery.net/api/v1/sending-domains/{domain}/verify' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: YOUR_API_KEY'

package main

import (
    "fmt"
    "net/http"
)

func main() {
    req, _ := http.NewRequest("POST", "https://sp-api.omnivery.net/api/v1/sending-domains/{domain}/verify", nil)
    req.Header.Set("Authorization", "YOUR_API_KEY")
    resp, _ := http.DefaultClient.Do(req)
    fmt.Println(resp.Status)
}

const response = await fetch('https://sp-api.omnivery.net/api/v1/sending-domains/{domain}/verify', {
  method: 'POST',
  headers: {'Content-Type': 'application/json', 'Authorization': 'YOUR_API_KEY'},
});
const data = await response.json();

<?php
$ch = curl_init('https://sp-api.omnivery.net/api/v1/sending-domains/{domain}/verify');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: YOUR_API_KEY']);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

import requests

response = requests.post(
    'https://sp-api.omnivery.net/api/v1/sending-domains/{domain}/verify',
    headers={'Content-Type': 'application/json', 'Authorization': 'YOUR_API_KEY'},
)
print(response.json())

GET /sending-domains List all Sending Domains ▼

Returns a list of domains under your account in JSON. See examples.

Parameters

Name	In	Type	Required	Description
`Authorization`	header	string	Yes	Authorization header must contain your account's primary API token

Responses

200

OK

Code Samples

curl -X GET 'https://sp-api.omnivery.net/api/v1/sending-domains' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: YOUR_API_KEY'

package main

import (
    "fmt"
    "net/http"
)

func main() {
    req, _ := http.NewRequest("GET", "https://sp-api.omnivery.net/api/v1/sending-domains", nil)
    req.Header.Set("Authorization", "YOUR_API_KEY")
    resp, _ := http.DefaultClient.Do(req)
    fmt.Println(resp.Status)
}

const response = await fetch('https://sp-api.omnivery.net/api/v1/sending-domains', {
  method: 'GET',
  headers: {'Content-Type': 'application/json', 'Authorization': 'YOUR_API_KEY'},
});
const data = await response.json();

<?php
$ch = curl_init('https://sp-api.omnivery.net/api/v1/sending-domains');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: YOUR_API_KEY']);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

import requests

response = requests.get(
    'https://sp-api.omnivery.net/api/v1/sending-domains',
    headers={'Content-Type': 'application/json', 'Authorization': 'YOUR_API_KEY'},
)
print(response.json())

POST /sending-domains Create a Sending Domain (auto gen DKIM) ▼

Create a sending domain by providing a sending domain object as the POST request body.

For compatibility reasons the API call will ignore parameters specific to Sparkpost's environment like tracking_domain, dkim, generate_dkim or shared_with_subaccounts.

Parameters

Name	In	Type	Required	Description
`Authorization`	header	string	Yes	Authorization header must contain your account's primary API token
`Content-Type`	header	string	Yes	application/json

Request Body application/json

Field	Type	Required	Description
`domain`	string	Yes	The domain or subdomain to create

Responses

200

OK

402

Payment Required

Code Samples

curl -X POST 'https://sp-api.omnivery.net/api/v1/sending-domains' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: YOUR_API_KEY' \
  -d '{"domain": "string"}'

package main

import (
    "fmt"
    "net/http"
)

func main() {
    req, _ := http.NewRequest("POST", "https://sp-api.omnivery.net/api/v1/sending-domains", nil)
    req.Header.Set("Authorization", "YOUR_API_KEY")
    resp, _ := http.DefaultClient.Do(req)
    fmt.Println(resp.Status)
}

const response = await fetch('https://sp-api.omnivery.net/api/v1/sending-domains', {
  method: 'POST',
  headers: {'Content-Type': 'application/json', 'Authorization': 'YOUR_API_KEY'},
  body: JSON.stringify({"domain": "string"})
});
const data = await response.json();

<?php
$ch = curl_init('https://sp-api.omnivery.net/api/v1/sending-domains');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: YOUR_API_KEY']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"domain": "string"}');
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

import requests

response = requests.post(
    'https://sp-api.omnivery.net/api/v1/sending-domains',
    headers={'Content-Type': 'application/json', 'Authorization': 'YOUR_API_KEY'},
    json={"domain": "string"}
)
print(response.json())

GET /sending-domains/{domain} 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.

Parameters

Name	In	Type	Required	Description
`Authorization`	header	string	Yes	Authorization header must contain your account's primary API token

Responses

200

Sending domain detail object

Code Samples

curl -X GET 'https://sp-api.omnivery.net/api/v1/sending-domains/{domain}' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: YOUR_API_KEY'

package main

import (
    "fmt"
    "net/http"
)

func main() {
    req, _ := http.NewRequest("GET", "https://sp-api.omnivery.net/api/v1/sending-domains/{domain}", nil)
    req.Header.Set("Authorization", "YOUR_API_KEY")
    resp, _ := http.DefaultClient.Do(req)
    fmt.Println(resp.Status)
}

const response = await fetch('https://sp-api.omnivery.net/api/v1/sending-domains/{domain}', {
  method: 'GET',
  headers: {'Content-Type': 'application/json', 'Authorization': 'YOUR_API_KEY'},
});
const data = await response.json();

<?php
$ch = curl_init('https://sp-api.omnivery.net/api/v1/sending-domains/{domain}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: YOUR_API_KEY']);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

import requests

response = requests.get(
    'https://sp-api.omnivery.net/api/v1/sending-domains/{domain}',
    headers={'Content-Type': 'application/json', 'Authorization': 'YOUR_API_KEY'},
)
print(response.json())

DELETE /sending-domains/{domain} Delete a Sending Domain ▼

Delete an existing sending domain.

Parameters

Name	In	Type	Required	Description
`Authorization`	header	string	Yes	Authorization header must contain your account's primary API token
`domain`	path	string	Yes	The domain to be deleted

Responses

204

No Content

404

Not Found

Code Samples

curl -X DELETE 'https://sp-api.omnivery.net/api/v1/sending-domains/{domain}' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: YOUR_API_KEY'

package main

import (
    "fmt"
    "net/http"
)

func main() {
    req, _ := http.NewRequest("DELETE", "https://sp-api.omnivery.net/api/v1/sending-domains/{domain}", nil)
    req.Header.Set("Authorization", "YOUR_API_KEY")
    resp, _ := http.DefaultClient.Do(req)
    fmt.Println(resp.Status)
}

const response = await fetch('https://sp-api.omnivery.net/api/v1/sending-domains/{domain}', {
  method: 'DELETE',
  headers: {'Content-Type': 'application/json', 'Authorization': 'YOUR_API_KEY'},
});
const data = await response.json();

<?php
$ch = curl_init('https://sp-api.omnivery.net/api/v1/sending-domains/{domain}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: YOUR_API_KEY']);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

import requests

response = requests.delete(
    'https://sp-api.omnivery.net/api/v1/sending-domains/{domain}',
    headers={'Content-Type': 'application/json', 'Authorization': 'YOUR_API_KEY'},
)
print(response.json())

Transmissions

POST /transmissions Create a Transmission (inline text/html and recipients) ▼

You can create a transmission using SparkPost API in a number of ways.

Using Inline Email Part Content

Create a transmission using inline email part content.

Using Inline RFC822 Content (MIME)

Create a transmission using inline RFC822 content. Content headers are not generated for transmissions providing RFC822 content. They are expected to be provided as headers contained in the RFC822 content.

Using a Stored Template

Create a transmission using a stored template by specifying the template_id in the content attribute.

Parameters

Name	In	Type	Required	Description
`Authorization`	header	string	Yes	Authorization header must contain your domain's sending API token or your account's primary API token
`Content-Type`	header	string	Yes	application/json

Request Body application/json

Field Type Required Description

substitution_data

object

No

Substitution data are global data substituted for all recipients of this transmission. Substitution data supplied in the recipient's object will override the transmission substitution data

return_path

string

No

Return path allows you to select your sending domain in case you are using a primary API token and in that case it is a required parameter. When using sending API token the return_path attribute has no use

campaign_id

string

No

Campaign ID of your choice to help you identify campaigns. This could be helpful in the future when identifying messages of a larger send.

options

object

No

Message level settings to override the domain level settings

recipients

array

Yes

Recipients object contains not only recipient's address but can also include variables to be passed to template.

Field	Type	Required	Description
`address`	object	Yes	Address information for a recipient
`substitution_data`	object	No	Key/value pairs associated with a recipient that are provided to the template engine. Recipient substitution data takes precedence over transmission substitution data. Unlike metadata, substitution data is not included in Webhook events. The maximum length is 100KB per recipient.
`metadata`	object	No	Key/value pairs associated with a recipient. Metadata is available during events through the Webhooks and is provided to the template engine. A maximum of 1000 bytes of merged metadata (transmission level + recipient level) is available with recipient metadata taking precedence over transmission metadata when there are conflicts.
`tags`	array	No	Array of text labels associated with a recipient. Tags are available in Webhook events. Maximum number of tags - 10 per recipient, 100 system wide. Any tags over the limits are ignored.
`callback_url`	string	No	Custom webhook endpoint URL - overrides webhooks set at the domain level.

content

object

Yes

Content object carries the information about the sender (from), message subject as well as message body. The message body can be supplied in multiple formats or retrieved from a template.

metadata

object

No

Metadata are global metadata applied to all recipients of this transmission. Metadata supplied in the recipient's object will override the transmission metadata

Responses

200

Code Samples

curl -X POST 'https://sp-api.omnivery.net/api/v1/transmissions' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: YOUR_API_KEY' \
  -d '{"substitution_data": {}, "return_path": "string", "campaign_id": "string", "options": {}, "recipients": [], "content": {}, "metadata": {}}'

package main

import (
    "fmt"
    "net/http"
)

func main() {
    req, _ := http.NewRequest("POST", "https://sp-api.omnivery.net/api/v1/transmissions", nil)
    req.Header.Set("Authorization", "YOUR_API_KEY")
    resp, _ := http.DefaultClient.Do(req)
    fmt.Println(resp.Status)
}

const response = await fetch('https://sp-api.omnivery.net/api/v1/transmissions', {
  method: 'POST',
  headers: {'Content-Type': 'application/json', 'Authorization': 'YOUR_API_KEY'},
  body: JSON.stringify({"substitution_data": {}, "return_path": "string", "campaign_id": "string", "options": {}, "recipients": [], "content": {}, "metadata": {}})
});
const data = await response.json();

<?php
$ch = curl_init('https://sp-api.omnivery.net/api/v1/transmissions');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: YOUR_API_KEY']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"substitution_data": {}, "return_path": "string", "campaign_id": "string", "options": {}, "recipients": [], "content": {}, "metadata": {}}');
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

import requests

response = requests.post(
    'https://sp-api.omnivery.net/api/v1/transmissions',
    headers={'Content-Type': 'application/json', 'Authorization': 'YOUR_API_KEY'},
    json={"substitution_data": {}, "return_path": "string", "campaign_id": "string", "options": {}, "recipients": [], "content": {}, "metadata": {}}
)
print(response.json())

Recipient Validation

POST /recipient-validation/single/{address} Email Address Validation ▼

Runs a given address through a series of checks that catch many common problems, including syntax issues and non-existent mailboxes.

To perform email validation your sending domain must have email validation enabled and you must use your sending domain's API credentials not the account level credentials.

Responses

200

OK

Code Samples

curl -X POST 'https://sp-api.omnivery.net/api/v1/recipient-validation/single/{address}' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: YOUR_API_KEY'

package main

import (
    "fmt"
    "net/http"
)

func main() {
    req, _ := http.NewRequest("POST", "https://sp-api.omnivery.net/api/v1/recipient-validation/single/{address}", nil)
    req.Header.Set("Authorization", "YOUR_API_KEY")
    resp, _ := http.DefaultClient.Do(req)
    fmt.Println(resp.Status)
}

const response = await fetch('https://sp-api.omnivery.net/api/v1/recipient-validation/single/{address}', {
  method: 'POST',
  headers: {'Content-Type': 'application/json', 'Authorization': 'YOUR_API_KEY'},
});
const data = await response.json();

<?php
$ch = curl_init('https://sp-api.omnivery.net/api/v1/recipient-validation/single/{address}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: YOUR_API_KEY']);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

import requests

response = requests.post(
    'https://sp-api.omnivery.net/api/v1/recipient-validation/single/{address}',
    headers={'Content-Type': 'application/json', 'Authorization': 'YOUR_API_KEY'},
)
print(response.json())

Suppression List

GET /{domain}/suppression-list/{recipient} 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 domain-specific exclusion list, an HTTP status of 404 is returned. If the recipient is in the list, an HTTP status of 200 is returned with the full suppression status in the response body.

Parameters

Name	In	Type	Required
`Authorization`	header	string	Yes
`Accept`	header	string	Yes
`domain`	path	string	Yes
`recipient`	path	string	Yes

Responses

200

OK

Code Samples

curl -X GET 'https://sp-api.omnivery.net/api/v1/{domain}/suppression-list/{recipient}' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: YOUR_API_KEY'

package main

import (
    "fmt"
    "net/http"
)

func main() {
    req, _ := http.NewRequest("GET", "https://sp-api.omnivery.net/api/v1/{domain}/suppression-list/{recipient}", nil)
    req.Header.Set("Authorization", "YOUR_API_KEY")
    resp, _ := http.DefaultClient.Do(req)
    fmt.Println(resp.Status)
}

const response = await fetch('https://sp-api.omnivery.net/api/v1/{domain}/suppression-list/{recipient}', {
  method: 'GET',
  headers: {'Content-Type': 'application/json', 'Authorization': 'YOUR_API_KEY'},
});
const data = await response.json();

<?php
$ch = curl_init('https://sp-api.omnivery.net/api/v1/{domain}/suppression-list/{recipient}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: YOUR_API_KEY']);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

import requests

response = requests.get(
    'https://sp-api.omnivery.net/api/v1/{domain}/suppression-list/{recipient}',
    headers={'Content-Type': 'application/json', 'Authorization': 'YOUR_API_KEY'},
)
print(response.json())

DELETE /{domain}/suppression-list/{recipient} 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 domain-specific exclusion list, an HTTP status of 404 is returned. If the recipient is in the list, an HTTP status of 204 is returned indicating a successful deletion.

Parameters

Name	In	Type	Required	Description
`Authorization`	header	string	Yes
`Accept`	header	string	Yes
`domain`	path	string	Yes
`recipient`	path	string	Yes
`recipient`	query	string	No	Recipient email address

Request Body application/json

Responses

204

No Content

404

Not Found

Code Samples

curl -X DELETE 'https://sp-api.omnivery.net/api/v1/{domain}/suppression-list/{recipient}' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: YOUR_API_KEY'

package main

import (
    "fmt"
    "net/http"
)

func main() {
    req, _ := http.NewRequest("DELETE", "https://sp-api.omnivery.net/api/v1/{domain}/suppression-list/{recipient}", nil)
    req.Header.Set("Authorization", "YOUR_API_KEY")
    resp, _ := http.DefaultClient.Do(req)
    fmt.Println(resp.Status)
}

const response = await fetch('https://sp-api.omnivery.net/api/v1/{domain}/suppression-list/{recipient}', {
  method: 'DELETE',
  headers: {'Content-Type': 'application/json', 'Authorization': 'YOUR_API_KEY'},
});
const data = await response.json();

<?php
$ch = curl_init('https://sp-api.omnivery.net/api/v1/{domain}/suppression-list/{recipient}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: YOUR_API_KEY']);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

import requests

response = requests.delete(
    'https://sp-api.omnivery.net/api/v1/{domain}/suppression-list/{recipient}',
    headers={'Content-Type': 'application/json', 'Authorization': 'YOUR_API_KEY'},
)
print(response.json())

domain path *

recipient path *

recipient query

Authorization header *

Accept header *

Request Body application/json

Response

GET /{domain}/suppression-list Search for List Entries ▼

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

Parameters

Name	In	Type	Required	Description
`Authorization`	header	string	Yes
`Accept`	header	string	Yes
`domain`	path	string	Yes
`from`	query	string	No	Filter results by date starting from
`to`	query	string	No	Filter results by date ending at
`per_page`	query	number	No	Output record limit
`page`	query	number	No	Result page
`sources`	query	string	No	Sources (one of `Spam Complaint`, `List Unsubscribe`, `Bounce Rule`, `Unsubscribe Link`, `Manually Added`, `Compliance`)

Responses

200

OK

400

Bad Request

Code Samples

curl -X GET 'https://sp-api.omnivery.net/api/v1/{domain}/suppression-list' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: YOUR_API_KEY'

package main

import (
    "fmt"
    "net/http"
)

func main() {
    req, _ := http.NewRequest("GET", "https://sp-api.omnivery.net/api/v1/{domain}/suppression-list", nil)
    req.Header.Set("Authorization", "YOUR_API_KEY")
    resp, _ := http.DefaultClient.Do(req)
    fmt.Println(resp.Status)
}

const response = await fetch('https://sp-api.omnivery.net/api/v1/{domain}/suppression-list', {
  method: 'GET',
  headers: {'Content-Type': 'application/json', 'Authorization': 'YOUR_API_KEY'},
});
const data = await response.json();

<?php
$ch = curl_init('https://sp-api.omnivery.net/api/v1/{domain}/suppression-list');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: YOUR_API_KEY']);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

import requests

response = requests.get(
    'https://sp-api.omnivery.net/api/v1/{domain}/suppression-list',
    headers={'Content-Type': 'application/json', 'Authorization': 'YOUR_API_KEY'},
)
print(response.json())

domain path *

from query

to query

per_page query

page query

sources query

Authorization header *

Accept header *

Response

PUT /{domain}/suppression-list Insert or Update List Entries ▼

Bulk insert entries to the domain-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 10mb. At a minimum, each recipient must have a valid "email" address in recipient field. The optional "description" key can be used to include an explanation of what type of message should be suppressed.

If the type field is used with value transactional the record will be added to the "block" suppressions, otherwise the "unsubscribe" suppression will be used.

If an email address is duplicated in a single request, only the first instance will be processed.

Parameters

Name	In	Type	Required
`Content-Type`	header	string	No
`Accept`	header	string	Yes
`Authorization`	header	string	Yes
`domain`	path	string	Yes

Request Body application/json

Field Type Required Description

recipients array Yes

Field	Type	Required
`type`	string	No
`recipient`	string	Yes
`description`	string	Yes

Responses

200

OK

Code Samples

curl -X PUT 'https://sp-api.omnivery.net/api/v1/{domain}/suppression-list' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: YOUR_API_KEY' \
  -d '{"recipients": []}'

package main

import (
    "fmt"
    "net/http"
)

func main() {
    req, _ := http.NewRequest("PUT", "https://sp-api.omnivery.net/api/v1/{domain}/suppression-list", nil)
    req.Header.Set("Authorization", "YOUR_API_KEY")
    resp, _ := http.DefaultClient.Do(req)
    fmt.Println(resp.Status)
}

const response = await fetch('https://sp-api.omnivery.net/api/v1/{domain}/suppression-list', {
  method: 'PUT',
  headers: {'Content-Type': 'application/json', 'Authorization': 'YOUR_API_KEY'},
  body: JSON.stringify({"recipients": []})
});
const data = await response.json();

<?php
$ch = curl_init('https://sp-api.omnivery.net/api/v1/{domain}/suppression-list');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: YOUR_API_KEY']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"recipients": []}');
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

import requests

response = requests.put(
    'https://sp-api.omnivery.net/api/v1/{domain}/suppression-list',
    headers={'Content-Type': 'application/json', 'Authorization': 'YOUR_API_KEY'},
    json={"recipients": []}
)
print(response.json())

domain path *

Content-Type header

Accept header *

Authorization header *

Request Body application/json

Response

Account Info

GET /account Retrieve Account information ▼

Returns complete information about your account, it's settings and current plan and its usage.

Parameters

Name	In	Type	Required	Description
`Authorization`	header	string	Yes	Authorization header must contain your account's primary API token

Responses

200

OK

Code Samples

curl -X GET 'https://sp-api.omnivery.net/api/v1/account' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: YOUR_API_KEY'

package main

import (
    "fmt"
    "net/http"
)

func main() {
    req, _ := http.NewRequest("GET", "https://sp-api.omnivery.net/api/v1/account", nil)
    req.Header.Set("Authorization", "YOUR_API_KEY")
    resp, _ := http.DefaultClient.Do(req)
    fmt.Println(resp.Status)
}

const response = await fetch('https://sp-api.omnivery.net/api/v1/account', {
  method: 'GET',
  headers: {'Content-Type': 'application/json', 'Authorization': 'YOUR_API_KEY'},
});
const data = await response.json();

<?php
$ch = curl_init('https://sp-api.omnivery.net/api/v1/account');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: YOUR_API_KEY']);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

import requests

response = requests.get(
    'https://sp-api.omnivery.net/api/v1/account',
    headers={'Content-Type': 'application/json', 'Authorization': 'YOUR_API_KEY'},
)
print(response.json())

SparkPost API (v1)

Authentication

Sending Domains

Parameters

Responses

Code Samples

Response

Parameters

Responses

Code Samples

Response

Parameters

Request Body application/json

Responses

Code Samples

Response

Parameters

Responses

Code Samples

Response

Parameters

Responses

Code Samples

Response

Transmissions

Using Inline Email Part Content

Using Inline RFC822 Content (MIME)

Using a Stored Template

Parameters

Request Body application/json

Responses

Code Samples

Response

Recipient Validation

Responses

Code Samples

Response

Suppression List

Parameters

Responses

Code Samples

Response

Parameters

Request Body application/json

Responses

Code Samples

Response

Parameters

Responses

Code Samples

Response

Parameters

Request Body application/json

Responses

Code Samples

Response

Account Info

Parameters

Responses

Code Samples

Response