{"info":{"_postman_id":"db5e28b1-1e68-8be2-ef79-227927e06bbc","name":"SparkPost API","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"3967924","collectionId":"db5e28b1-1e68-8be2-ef79-227927e06bbc","publishedId":"RW1YpgPz","public":true,"customColor":null,"publishDate":"2018-04-25T12:19:05.000Z"},"item":[{"name":"Account Info","item":[{"name":"Retrieve Account Usage","id":"29e1545f-f1ce-b37b-bc8c-246ab727f7ac","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/account?include=usage","urlObject":{"protocol":"https","path":["api","v1","account"],"host":["api","sparkpost","com"],"query":[{"key":"include","value":"usage"}],"variable":[]}},"response":[],"_postman_id":"29e1545f-f1ce-b37b-bc8c-246ab727f7ac"}],"id":"0713f234-5d5f-b007-7860-3d2c746ae042","_postman_id":"0713f234-5d5f-b007-7860-3d2c746ae042","description":""},{"name":"Bounce Domains","item":[{"name":"Create a Bounce Domain","id":"a20ae932-ba77-d67c-a534-6fa73abdd54c","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{API_KEY}}"}],"body":{"mode":"raw","raw":"{\n \"domain\" : \"example.domain.com\",\n}\n"},"url":"https://api.sparkpost.com/api/v1/bounce-domains","urlObject":{"protocol":"https","path":["api","v1","bounce-domains"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a20ae932-ba77-d67c-a534-6fa73abdd54c"},{"name":"List all Bounce Domains","id":"9c2b6ed0-b916-c90f-fe31-db3b74b1c23f","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/bounce-domains","description":"","urlObject":{"protocol":"https","path":["api","v1","bounce-domains"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9c2b6ed0-b916-c90f-fe31-db3b74b1c23f"},{"name":"Retrieve a Bounce Domain","id":"1d3fd36b-9e88-a3ad-384d-064ca9efce0d","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/bounce-domains/example.domain.com","urlObject":{"protocol":"https","path":["api","v1","bounce-domains","example.domain.com"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"1d3fd36b-9e88-a3ad-384d-064ca9efce0d"},{"name":"Delete a Bounce Domain","id":"ac0f41e2-27c1-e4fc-90e6-14db1e27247a","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{API_KEY}}"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/bounce-domains/example.domain.com","urlObject":{"protocol":"https","path":["api","v1","bounce-domains","example.domain.com"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ac0f41e2-27c1-e4fc-90e6-14db1e27247a"},{"name":"Verify a Bounce Domain","id":"166ff5d1-31fb-9167-b63d-b932c7905397","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{API_KEY}}"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/bounce-domains/example.domain.com/verify","urlObject":{"protocol":"https","path":["api","v1","bounce-domains","example.domain.com","verify"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"166ff5d1-31fb-9167-b63d-b932c7905397"}],"id":"3bbf963c-74d3-a265-bc79-16a12e18c975","description":"

https://developers.sparkpost.com/api/bounce-domains

\n","_postman_id":"3bbf963c-74d3-a265-bc79-16a12e18c975"},{"name":"IP Pools","item":[{"name":"List all IP Pools","id":"67089a35-dd1e-6150-ed35-858ba4fcf105","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/ip-pools","urlObject":{"protocol":"https","path":["api","v1","ip-pools"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"67089a35-dd1e-6150-ed35-858ba4fcf105"},{"name":"Create an IP Pool","id":"1b898d2d-fee9-64f4-5ef9-00c406591074","request":{"method":"POST","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\" : \"Warm up IP Pool\"\n}"},"url":"https://api.sparkpost.com/api/v1/ip-pools","urlObject":{"protocol":"https","path":["api","v1","ip-pools"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"1b898d2d-fee9-64f4-5ef9-00c406591074"},{"name":"Get an IP Pool","id":"cb97c968-32b2-abe5-8858-d51ad2ae5564","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/ip-pools/warm_up_ip_pool","urlObject":{"protocol":"https","path":["api","v1","ip-pools","warm_up_ip_pool"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"cb97c968-32b2-abe5-8858-d51ad2ae5564"},{"name":"Update an IP Pool","id":"42eeedc2-47c5-f60f-e830-2851b8af4049","request":{"method":"PUT","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\" : \"Updated Warm up IP Pool\"\n}"},"url":"https://api.sparkpost.com/api/v1/ip-pools/warm_up_ip_pool","urlObject":{"protocol":"https","path":["api","v1","ip-pools","warm_up_ip_pool"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"42eeedc2-47c5-f60f-e830-2851b8af4049"},{"name":"Delete an IP Pool","id":"c82d6305-2138-b14e-8ca7-4a89a390bc61","request":{"method":"DELETE","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/ip-pools/warm_up_ip_pool","urlObject":{"protocol":"https","path":["api","v1","ip-pools","warm_up_ip_pool"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c82d6305-2138-b14e-8ca7-4a89a390bc61"}],"id":"e4516d08-4840-a97f-a272-279d202785a8","_postman_id":"e4516d08-4840-a97f-a272-279d202785a8","description":""},{"name":"Inbound Domains","item":[{"name":"Create an Inbound Domain","id":"b22817c3-be64-2d2f-d6ae-138ecba710ca","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{API_KEY}}"}],"body":{"mode":"raw","raw":"{\n \"domain\": \"inbounddomain\"\n}\n"},"url":"https://api.sparkpost.com/api/v1/inbound-domains","description":"

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

\n","urlObject":{"protocol":"https","path":["api","v1","inbound-domains"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b22817c3-be64-2d2f-d6ae-138ecba710ca"},{"name":"List all Inbound Domains","id":"bd97a5bc-ccf5-8b54-66a7-7621422603ef","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/inbound-domains","description":"

List all your inbound domains.

\n","urlObject":{"protocol":"https","path":["api","v1","inbound-domains"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"bd97a5bc-ccf5-8b54-66a7-7621422603ef"},{"name":"Retrieve an Inbound Domain","id":"90cb9a96-107e-81c5-9947-65d97860a23c","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/inbound-domains/inbounddomain.test.com","description":"

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

\n","urlObject":{"protocol":"https","path":["api","v1","inbound-domains","inbounddomain.test.com"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"90cb9a96-107e-81c5-9947-65d97860a23c"},{"name":"Delete an Inbound Domain","id":"80f6d0fb-e805-8f5d-6bb3-32266b8833fc","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{API_KEY}}"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/inbound-domains/inbounddomain.test.com","description":"

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

\n","urlObject":{"protocol":"https","path":["api","v1","inbound-domains","inbounddomain.test.com"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"80f6d0fb-e805-8f5d-6bb3-32266b8833fc"}],"id":"95a8a237-e789-0c4e-4b3a-d3e08969daba","description":"

https://developers.sparkpost.com/api/#/reference/inbound-domains

\n","_postman_id":"95a8a237-e789-0c4e-4b3a-d3e08969daba"},{"name":"Message Events","item":[{"name":"Documentation","id":"5b0f5e4a-d8d9-9d2e-596c-1fa615ee88f9","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/message-events/events/documentation","description":"

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.

\n","urlObject":{"protocol":"https","path":["api","v1","message-events","events","documentation"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"5b0f5e4a-d8d9-9d2e-596c-1fa615ee88f9"},{"name":"Samples","id":"f706ee42-b051-2a5a-ff2e-456a15c0eb99","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/message-events/events/samples?events=bounce","description":"

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

\n","urlObject":{"protocol":"https","path":["api","v1","message-events","events","samples"],"host":["api","sparkpost","com"],"query":[{"key":"events","value":"bounce"}],"variable":[]}},"response":[],"_postman_id":"f706ee42-b051-2a5a-ff2e-456a15c0eb99"},{"name":"Search for Message Events","id":"17b9084f-3279-c847-8664-4e11564791fc","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{API_KEY}}"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/message-events?bounce_classes=1&campaign_ids=Example Campaign Name&events=delivery,injection,bounce,delay,policy_rejection,out_of_band,open,click,generation_failure,generation_rejection,spam_complaint,list_unsubscribe,link_unsubscribe&friendly_froms=sender@mail.example.com&from=2014-07-20T08:00&message_ids=0e0d94b7-9085-4e3c-ab30-e3f2cd9c273e&page=25&per_page=100&reason=bounce&recipients=recipient@example.com&template_ids=templ-1234&timezone=America/New_York&to=2014-07-20T09:00&transmission_ids=65832150921904138","description":"

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

\n","urlObject":{"protocol":"https","path":["api","v1","message-events"],"host":["api","sparkpost","com"],"query":[{"key":"bounce_classes","value":"1"},{"key":"campaign_ids","value":"Example Campaign Name"},{"key":"events","value":"delivery,injection,bounce,delay,policy_rejection,out_of_band,open,click,generation_failure,generation_rejection,spam_complaint,list_unsubscribe,link_unsubscribe"},{"key":"friendly_froms","value":"sender@mail.example.com"},{"key":"from","value":"2014-07-20T08:00"},{"key":"message_ids","value":"0e0d94b7-9085-4e3c-ab30-e3f2cd9c273e"},{"key":"page","value":"25"},{"key":"per_page","value":"100"},{"key":"reason","value":"bounce"},{"key":"recipients","value":"recipient@example.com"},{"key":"template_ids","value":"templ-1234"},{"key":"timezone","value":"America/New_York"},{"key":"to","value":"2014-07-20T09:00"},{"key":"transmission_ids","value":"65832150921904138"}],"variable":[]}},"response":[],"_postman_id":"17b9084f-3279-c847-8664-4e11564791fc"}],"id":"67378849-a1c3-f948-f970-12b485f865b5","description":"

https://developers.sparkpost.com/api/#/reference/message-events

\n","_postman_id":"67378849-a1c3-f948-f970-12b485f865b5"},{"name":"Metrics","item":[{"name":"Metrics Discoverability Links","id":"25dde401-48d8-9b8a-a556-b9bef1208ed9","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/metrics/","description":"

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.

\n","urlObject":{"protocol":"https","path":["api","v1","metrics",""],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"25dde401-48d8-9b8a-a556-b9bef1208ed9"},{"name":"Deliverability Metrics Summary","id":"86a11bf3-9974-af88-c6a7-360cb7cfa3d0","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/metrics/deliverability?from=2014-07-11T08:00&to=2014-07-20T09:00&domains=gmail.com,yahoo.com,hotmail.com&campaigns=Black Friday&templates=summer-sale&nodes=Email-MSys-1,Email-MSys-2,Email-MSys-3&bindings=Confirmation&binding_groups=Transaction&protocols=smtp&metrics=&timezone=America/New_York","description":"

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

\n","urlObject":{"protocol":"https","path":["api","v1","metrics","deliverability"],"host":["api","sparkpost","com"],"query":[{"key":"from","value":"2014-07-11T08:00"},{"key":"to","value":"2014-07-20T09:00"},{"key":"domains","value":"gmail.com,yahoo.com,hotmail.com"},{"key":"campaigns","value":"Black Friday"},{"key":"templates","value":"summer-sale"},{"key":"nodes","value":"Email-MSys-1,Email-MSys-2,Email-MSys-3"},{"key":"bindings","value":"Confirmation"},{"key":"binding_groups","value":"Transaction"},{"key":"protocols","value":"smtp"},{"key":"metrics","value":""},{"key":"timezone","value":"America/New_York"}],"variable":[]}},"response":[],"_postman_id":"86a11bf3-9974-af88-c6a7-360cb7cfa3d0"},{"name":"Deliverability Metrics by Domain","id":"c09f5ec4-8536-1b46-00ba-336de709ca03","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/metrics/deliverability/domain?from=2014-07-11T08:00&to=2014-07-20T09:00&domains=gmail.com,yahoo.com,hotmail.com&campaigns=Black Friday&templates=summer-sale&nodes=Email-MSys-1,Email-MSys-2,Email-MSys-3&bindings=Confirmation&binding_groups=Transaction&protocols=smtp&metrics=&timezone=America/New_York&order_by=count_injected&limit=5","description":"

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

\n","urlObject":{"protocol":"https","path":["api","v1","metrics","deliverability","domain"],"host":["api","sparkpost","com"],"query":[{"key":"from","value":"2014-07-11T08:00"},{"key":"to","value":"2014-07-20T09:00"},{"key":"domains","value":"gmail.com,yahoo.com,hotmail.com"},{"key":"campaigns","value":"Black Friday"},{"key":"templates","value":"summer-sale"},{"key":"nodes","value":"Email-MSys-1,Email-MSys-2,Email-MSys-3"},{"key":"bindings","value":"Confirmation"},{"key":"binding_groups","value":"Transaction"},{"key":"protocols","value":"smtp"},{"key":"metrics","value":""},{"key":"timezone","value":"America/New_York"},{"key":"order_by","value":"count_injected"},{"key":"limit","value":"5"}],"variable":[]}},"response":[],"_postman_id":"c09f5ec4-8536-1b46-00ba-336de709ca03"},{"name":"Deliverability Metrics by Binding","id":"411dfe25-63cf-c2dd-446b-dd964d46950a","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/metrics/deliverability/binding?from=2014-07-11T08:00&to=2014-07-20T09:00&domains=gmail.com,yahoo.com,hotmail.com&campaigns=Black Friday&templates=summer-sale&nodes=Email-MSys-1,Email-MSys-2,Email-MSys-3&bindings=Confirmation&binding_groups=Transaction&protocols=smtp&metrics=count_targeted&timezone=America/New_York&limit=5&order_by=count_injected","description":"

Note: This endpoint is available in SparkPost Elite only.

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

\n","urlObject":{"protocol":"https","path":["api","v1","metrics","deliverability","binding"],"host":["api","sparkpost","com"],"query":[{"key":"from","value":"2014-07-11T08:00"},{"key":"to","value":"2014-07-20T09:00"},{"key":"domains","value":"gmail.com,yahoo.com,hotmail.com"},{"key":"campaigns","value":"Black Friday"},{"key":"templates","value":"summer-sale"},{"key":"nodes","value":"Email-MSys-1,Email-MSys-2,Email-MSys-3"},{"key":"bindings","value":"Confirmation"},{"key":"binding_groups","value":"Transaction"},{"key":"protocols","value":"smtp"},{"key":"metrics","value":"count_targeted"},{"key":"timezone","value":"America/New_York"},{"key":"limit","value":"5"},{"key":"order_by","value":"count_injected"}],"variable":[]}},"response":[],"_postman_id":"411dfe25-63cf-c2dd-446b-dd964d46950a"},{"name":"Deliverability Metrics by Binding Group","id":"54046e1f-e26f-c3fd-a301-86593d16686a","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/metrics/deliverability/binding-group?from=2014-07-11T08:00&to=2014-07-20T09:00&domains=gmail.com,yahoo.com,hotmail.com&campaigns=Black Friday&templates=summer-sale&nodes=Email-MSys-1,Email-MSys-2,Email-MSys-3&bindings=Confirmation&binding_groups=Transaction&protocols=smtp&metrics=count_targeted&timezone=America/New_York&limit=5&order_by=count_injected","description":"

Note: This endpoint is available in SparkPost Elite only.

Provides aggregate metrics grouped by binding group over the time window specified.

\n","urlObject":{"protocol":"https","path":["api","v1","metrics","deliverability","binding-group"],"host":["api","sparkpost","com"],"query":[{"key":"from","value":"2014-07-11T08:00"},{"key":"to","value":"2014-07-20T09:00"},{"key":"domains","value":"gmail.com,yahoo.com,hotmail.com"},{"key":"campaigns","value":"Black Friday"},{"key":"templates","value":"summer-sale"},{"key":"nodes","value":"Email-MSys-1,Email-MSys-2,Email-MSys-3"},{"key":"bindings","value":"Confirmation"},{"key":"binding_groups","value":"Transaction"},{"key":"protocols","value":"smtp"},{"key":"metrics","value":"count_targeted"},{"key":"timezone","value":"America/New_York"},{"key":"limit","value":"5"},{"key":"order_by","value":"count_injected"}],"variable":[]}},"response":[],"_postman_id":"54046e1f-e26f-c3fd-a301-86593d16686a"},{"name":"Deliverability Metrics by Sending IP","id":"0fda7d0b-c116-1dda-a4cb-59703b76e94f","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/metrics/deliverability/sending-ip?from=2014-07-11T08:00&to=2014-07-20T09:00&domains=gmail.com,yahoo.com,hotmail.com&campaigns=Black Friday&templates=summer-sale&nodes=Email-MSys-1,Email-MSys-2,Email-MSys-3&sending_ips=Confirmation&ip_pools=Transactional&sending_domains=sales.sender.com,transactional.sender.com&subaccounts=123,125,127&bindings=Confirmation&binding_groups=Transaction&protocols=smtp&metrics=count_targeted&timezone=America/New_York&limit=5&order_by=count_injected","urlObject":{"protocol":"https","path":["api","v1","metrics","deliverability","sending-ip"],"host":["api","sparkpost","com"],"query":[{"key":"from","value":"2014-07-11T08:00"},{"key":"to","value":"2014-07-20T09:00"},{"key":"domains","value":"gmail.com,yahoo.com,hotmail.com"},{"key":"campaigns","value":"Black Friday"},{"key":"templates","value":"summer-sale"},{"key":"nodes","value":"Email-MSys-1,Email-MSys-2,Email-MSys-3"},{"key":"sending_ips","value":"Confirmation"},{"key":"ip_pools","value":"Transactional"},{"key":"sending_domains","value":"sales.sender.com,transactional.sender.com"},{"key":"subaccounts","value":"123,125,127"},{"key":"bindings","value":"Confirmation"},{"key":"binding_groups","value":"Transaction"},{"key":"protocols","value":"smtp"},{"key":"metrics","value":"count_targeted"},{"key":"timezone","value":"America/New_York"},{"key":"limit","value":"5"},{"key":"order_by","value":"count_injected"}],"variable":[]}},"response":[],"_postman_id":"0fda7d0b-c116-1dda-a4cb-59703b76e94f"},{"name":"Deliverability Metrics by Campaign","id":"6b6503df-c15e-cb74-590a-364548252cd4","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/metrics/deliverability/campaign?from=2014-07-11T08:00&to=2014-07-20T09:00&domains=gmail.com,yahoo.com,hotmail.com&campaigns=Black Friday&templates=summer-sale&nodes=Email-MSys-1,Email-MSys-2,Email-MSys-3&bindings=Confirmation&binding_groups=Transaction&protocols=smtp&metrics=&timezone=America/New_York&limit=5&order_by=count_injected","description":"

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

\n","urlObject":{"protocol":"https","path":["api","v1","metrics","deliverability","campaign"],"host":["api","sparkpost","com"],"query":[{"key":"from","value":"2014-07-11T08:00"},{"key":"to","value":"2014-07-20T09:00"},{"key":"domains","value":"gmail.com,yahoo.com,hotmail.com"},{"key":"campaigns","value":"Black Friday"},{"key":"templates","value":"summer-sale"},{"key":"nodes","value":"Email-MSys-1,Email-MSys-2,Email-MSys-3"},{"key":"bindings","value":"Confirmation"},{"key":"binding_groups","value":"Transaction"},{"key":"protocols","value":"smtp"},{"key":"metrics","value":""},{"key":"timezone","value":"America/New_York"},{"key":"limit","value":"5"},{"key":"order_by","value":"count_injected"}],"variable":[]}},"response":[],"_postman_id":"6b6503df-c15e-cb74-590a-364548252cd4"},{"name":"Deliverability Metrics by Template","id":"7f41b0f9-4400-68b0-2e55-4353ac69dda3","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/metrics/deliverability/template?from=2014-07-11T08:00&to=2014-07-20T09:00&domains=gmail.com,yahoo.com,hotmail.com&campaigns=Black Friday&templates=summer-sale&nodes=Email-MSys-1,Email-MSys-2,Email-MSys-3&bindings=Confirmation&binding_groups=Transaction&protocols=smtp&metrics=&timezone=America/New_York&limit=5&order_by=count_injected","description":"

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

\n","urlObject":{"protocol":"https","path":["api","v1","metrics","deliverability","template"],"host":["api","sparkpost","com"],"query":[{"key":"from","value":"2014-07-11T08:00"},{"key":"to","value":"2014-07-20T09:00"},{"key":"domains","value":"gmail.com,yahoo.com,hotmail.com"},{"key":"campaigns","value":"Black Friday"},{"key":"templates","value":"summer-sale"},{"key":"nodes","value":"Email-MSys-1,Email-MSys-2,Email-MSys-3"},{"key":"bindings","value":"Confirmation"},{"key":"binding_groups","value":"Transaction"},{"key":"protocols","value":"smtp"},{"key":"metrics","value":""},{"key":"timezone","value":"America/New_York"},{"key":"limit","value":"5"},{"key":"order_by","value":"count_injected"}],"variable":[]}},"response":[],"_postman_id":"7f41b0f9-4400-68b0-2e55-4353ac69dda3"},{"name":"Deliverability Metrics by Watched Domain","id":"6791553d-6ab4-28cb-2695-5d3f55afc4d9","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/metrics/deliverability/watched-domain?from=2014-07-11T08:00&to=2014-07-20T09:00&domains=gmail.com,yahoo.com,hotmail.com&campaigns=Black Friday&templates=summer-sale&nodes=Email-MSys-1,Email-MSys-2,Email-MSys-3&bindings=Confirmation&binding_groups=Transaction&protocols=smtp&metrics=&timezone=America/New_York&limit=5&order_by=count_injected","description":"

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

\n","urlObject":{"protocol":"https","path":["api","v1","metrics","deliverability","watched-domain"],"host":["api","sparkpost","com"],"query":[{"key":"from","value":"2014-07-11T08:00"},{"key":"to","value":"2014-07-20T09:00"},{"key":"domains","value":"gmail.com,yahoo.com,hotmail.com"},{"key":"campaigns","value":"Black Friday"},{"key":"templates","value":"summer-sale"},{"key":"nodes","value":"Email-MSys-1,Email-MSys-2,Email-MSys-3"},{"key":"bindings","value":"Confirmation"},{"key":"binding_groups","value":"Transaction"},{"key":"protocols","value":"smtp"},{"key":"metrics","value":""},{"key":"timezone","value":"America/New_York"},{"key":"limit","value":"5"},{"key":"order_by","value":"count_injected"}],"variable":[]}},"response":[],"_postman_id":"6791553d-6ab4-28cb-2695-5d3f55afc4d9"},{"name":"Time-Series Metrics","id":"a536d5fb-c14d-57f4-b806-cec62fb4f03b","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/metrics/deliverability/time-series?from=2014-07-11T07:00&to=2014-07-20T08:00&domains=gmail.com,yahoo.com,hotmail.com&campaigns=summerSale,promotionX&templates=summer-sale&nodes=Email-MSys-1,Email-MSys-2,Email-MSys-3&bindings=bindingA,bindingB,bindingC&binding_groups=bg1,bg2,bg3&protocols=smtp&precision=day&metrics=&timezone=America/New_York","description":"

Provides deliverability metrics ordered by a precision of time.

The following table describes the validation for the precision parameter:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Value of	Valid for time window of
1min, 5min	day
hour	month
day, month	any

","urlObject":{"protocol":"https","path":["api","v1","metrics","deliverability","time-series"],"host":["api","sparkpost","com"],"query":[{"key":"from","value":"2014-07-11T07:00"},{"key":"to","value":"2014-07-20T08:00"},{"key":"domains","value":"gmail.com,yahoo.com,hotmail.com"},{"key":"campaigns","value":"summerSale,promotionX"},{"key":"templates","value":"summer-sale"},{"key":"nodes","value":"Email-MSys-1,Email-MSys-2,Email-MSys-3"},{"key":"bindings","value":"bindingA,bindingB,bindingC"},{"key":"binding_groups","value":"bg1,bg2,bg3"},{"key":"protocols","value":"smtp"},{"key":"precision","value":"day"},{"key":"metrics","value":""},{"key":"timezone","value":"America/New_York"}],"variable":[]}},"response":[],"_postman_id":"a536d5fb-c14d-57f4-b806-cec62fb4f03b"},{"name":"Bounce Reason Metrics","id":"3c15abc4-76bf-6f53-a855-b126b0a3a8c6","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/metrics/deliverability/bounce-reason?from=2014-07-11T08:00&to=2014-07-20T09:00&domains=gmail.com,yahoo.com,hotmail.com&campaigns=Black Friday&templates=summer-sale&nodes=Email-MSys-1,Email-MSys-2,Email-MSys-3&bindings=Confirmation&binding_groups=Transaction&protocols=smtp&metrics=&timezone=America/New_York&limit=5","description":"

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

\n","urlObject":{"protocol":"https","path":["api","v1","metrics","deliverability","bounce-reason"],"host":["api","sparkpost","com"],"query":[{"key":"from","value":"2014-07-11T08:00"},{"key":"to","value":"2014-07-20T09:00"},{"key":"domains","value":"gmail.com,yahoo.com,hotmail.com"},{"key":"campaigns","value":"Black Friday"},{"key":"templates","value":"summer-sale"},{"key":"nodes","value":"Email-MSys-1,Email-MSys-2,Email-MSys-3"},{"key":"bindings","value":"Confirmation"},{"key":"binding_groups","value":"Transaction"},{"key":"protocols","value":"smtp"},{"key":"metrics","value":""},{"key":"timezone","value":"America/New_York"},{"key":"limit","value":"5"}],"variable":[]}},"response":[],"_postman_id":"3c15abc4-76bf-6f53-a855-b126b0a3a8c6"},{"name":"Bounce Reason Metrics By Domain","id":"88d68451-2673-1bd1-2462-75c3f5cc860d","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/metrics/deliverability/bounce-reason/domain?from=2014-07-11T08:00&to=2014-07-20T09:00&domains=gmail.com,yahoo.com,hotmail.com&campaigns=Black Friday&templates=summer-sale&nodes=Email-MSys-1,Email-MSys-2,Email-MSys-3&bindings=Confirmation&binding_groups=Transaction&protocols=smtp&metrics=&timezone=America/New_York&limit=5","description":"

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

\n","urlObject":{"protocol":"https","path":["api","v1","metrics","deliverability","bounce-reason","domain"],"host":["api","sparkpost","com"],"query":[{"key":"from","value":"2014-07-11T08:00"},{"key":"to","value":"2014-07-20T09:00"},{"key":"domains","value":"gmail.com,yahoo.com,hotmail.com"},{"key":"campaigns","value":"Black Friday"},{"key":"templates","value":"summer-sale"},{"key":"nodes","value":"Email-MSys-1,Email-MSys-2,Email-MSys-3"},{"key":"bindings","value":"Confirmation"},{"key":"binding_groups","value":"Transaction"},{"key":"protocols","value":"smtp"},{"key":"metrics","value":""},{"key":"timezone","value":"America/New_York"},{"key":"limit","value":"5"}],"variable":[]}},"response":[],"_postman_id":"88d68451-2673-1bd1-2462-75c3f5cc860d"},{"name":"Bounce Classification Metrics","id":"f940caec-fdfa-b53f-60f1-bf6b9ca5a18f","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/metrics/deliverability/bounce-classification?from=2014-07-11T08:00&to=2014-07-20T09:00&domains=gmail.com,yahoo.com,hotmail.com&campaigns=Black Friday&templates=summer-sale&nodes=Email-MSys-1,Email-MSys-2,Email-MSys-3,Email-MSys-4,Email-MSys-5&bindings=Confirmation&binding_groups=Transaction&protocols=smtp&metrics=&timezone=America/New_York&limit=5","description":"

Provides deliverability metrics, specific to bounce events, grouped by the bounce classification. (See Bounce Classification Codes.)

\n","urlObject":{"protocol":"https","path":["api","v1","metrics","deliverability","bounce-classification"],"host":["api","sparkpost","com"],"query":[{"key":"from","value":"2014-07-11T08:00"},{"key":"to","value":"2014-07-20T09:00"},{"key":"domains","value":"gmail.com,yahoo.com,hotmail.com"},{"key":"campaigns","value":"Black Friday"},{"key":"templates","value":"summer-sale"},{"key":"nodes","value":"Email-MSys-1,Email-MSys-2,Email-MSys-3,Email-MSys-4,Email-MSys-5"},{"key":"bindings","value":"Confirmation"},{"key":"binding_groups","value":"Transaction"},{"key":"protocols","value":"smtp"},{"key":"metrics","value":""},{"key":"timezone","value":"America/New_York"},{"key":"limit","value":"5"}],"variable":[]}},"response":[],"_postman_id":"f940caec-fdfa-b53f-60f1-bf6b9ca5a18f"},{"name":"Rejection Reason Metrics","id":"40354aa0-e26a-5a13-2474-7aa07ac74d3e","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/metrics/deliverability/rejection-reason?from=2014-07-11T08:00&to=2014-07-20T09:00&domains=gmail.com,yahoo.com,hotmail.com&campaigns=Black Friday&templates=summer-sale&nodes=Email-MSys-1,Email-MSys-2,Email-MSys-3,Email-MSys-4,Email-MSys-5&bindings=Confirmation&binding_groups=Transaction&protocols=smtp&timezone=America/New_York&limit=5","description":"

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

\n","urlObject":{"protocol":"https","path":["api","v1","metrics","deliverability","rejection-reason"],"host":["api","sparkpost","com"],"query":[{"key":"from","value":"2014-07-11T08:00"},{"key":"to","value":"2014-07-20T09:00"},{"key":"domains","value":"gmail.com,yahoo.com,hotmail.com"},{"key":"campaigns","value":"Black Friday"},{"key":"templates","value":"summer-sale"},{"key":"nodes","value":"Email-MSys-1,Email-MSys-2,Email-MSys-3,Email-MSys-4,Email-MSys-5"},{"key":"bindings","value":"Confirmation"},{"key":"binding_groups","value":"Transaction"},{"key":"protocols","value":"smtp"},{"key":"timezone","value":"America/New_York"},{"key":"limit","value":"5"}],"variable":[]}},"response":[],"_postman_id":"40354aa0-e26a-5a13-2474-7aa07ac74d3e"},{"name":"Rejection Reason Metrics By Domain","id":"3479a94d-db85-dfb9-f3e2-d4a893483371","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/metrics/deliverability/rejection-reason/domain?from=2014-07-11T08:00&to=2014-07-20T09:00&domains=gmail.com,yahoo.com,hotmail.com&campaigns=Black Friday&templates=summer-sale&nodes=Email-MSys-1,Email-MSys-2,Email-MSys-3,Email-MSys-4,Email-MSys-5&bindings=Confirmation&binding_groups=Transaction&protocols=smtp&timezone=America/New_York&limit=5","description":"

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

\n","urlObject":{"protocol":"https","path":["api","v1","metrics","deliverability","rejection-reason","domain"],"host":["api","sparkpost","com"],"query":[{"key":"from","value":"2014-07-11T08:00"},{"key":"to","value":"2014-07-20T09:00"},{"key":"domains","value":"gmail.com,yahoo.com,hotmail.com"},{"key":"campaigns","value":"Black Friday"},{"key":"templates","value":"summer-sale"},{"key":"nodes","value":"Email-MSys-1,Email-MSys-2,Email-MSys-3,Email-MSys-4,Email-MSys-5"},{"key":"bindings","value":"Confirmation"},{"key":"binding_groups","value":"Transaction"},{"key":"protocols","value":"smtp"},{"key":"timezone","value":"America/New_York"},{"key":"limit","value":"5"}],"variable":[]}},"response":[],"_postman_id":"3479a94d-db85-dfb9-f3e2-d4a893483371"},{"name":"Delay Reason Metrics","id":"96892fe6-a23e-b7d1-4e70-86b2a21027ee","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/metrics/deliverability/delay-reason?from=2014-07-11T08:00&to=2014-07-20T09:00&domains=gmail.com,yahoo.com,hotmail.com&campaigns=Black Friday&templates=summer-sale&nodes=Email-MSys-1,Email-MSys-2,Email-MSys-3,Email-MSys-4,Email-MSys-5&bindings=Confirmation&binding_groups=Transaction&protocols=smtp&timezone=America/New_York&limit=5","description":"

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

\n","urlObject":{"protocol":"https","path":["api","v1","metrics","deliverability","delay-reason"],"host":["api","sparkpost","com"],"query":[{"key":"from","value":"2014-07-11T08:00"},{"key":"to","value":"2014-07-20T09:00"},{"key":"domains","value":"gmail.com,yahoo.com,hotmail.com"},{"key":"campaigns","value":"Black Friday"},{"key":"templates","value":"summer-sale"},{"key":"nodes","value":"Email-MSys-1,Email-MSys-2,Email-MSys-3,Email-MSys-4,Email-MSys-5"},{"key":"bindings","value":"Confirmation"},{"key":"binding_groups","value":"Transaction"},{"key":"protocols","value":"smtp"},{"key":"timezone","value":"America/New_York"},{"key":"limit","value":"5"}],"variable":[]}},"response":[],"_postman_id":"96892fe6-a23e-b7d1-4e70-86b2a21027ee"},{"name":"Delay Reason Metrics By Domain","id":"ad08bb23-2aa4-5df4-2293-27039ecd54d1","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/metrics/deliverability/delay-reason/domain?from=2014-07-11T08:00&to=2014-07-20T09:00&domains=gmail.com,yahoo.com,hotmail.com&campaigns=Black Friday&templates=summer-sale&nodes=Email-MSys-1,Email-MSys-2,Email-MSys-3,Email-MSys-4,Email-MSys-5&bindings=Confirmation&binding_groups=Transaction&protocols=smtp&timezone=America/New_York&limit=5","description":"

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

\n","urlObject":{"protocol":"https","path":["api","v1","metrics","deliverability","delay-reason","domain"],"host":["api","sparkpost","com"],"query":[{"key":"from","value":"2014-07-11T08:00"},{"key":"to","value":"2014-07-20T09:00"},{"key":"domains","value":"gmail.com,yahoo.com,hotmail.com"},{"key":"campaigns","value":"Black Friday"},{"key":"templates","value":"summer-sale"},{"key":"nodes","value":"Email-MSys-1,Email-MSys-2,Email-MSys-3,Email-MSys-4,Email-MSys-5"},{"key":"bindings","value":"Confirmation"},{"key":"binding_groups","value":"Transaction"},{"key":"protocols","value":"smtp"},{"key":"timezone","value":"America/New_York"},{"key":"limit","value":"5"}],"variable":[]}},"response":[],"_postman_id":"ad08bb23-2aa4-5df4-2293-27039ecd54d1"},{"name":"Engagement Details","id":"1d73294f-620c-7485-8a1f-f360f93f9606","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/metrics/deliverability/link-name?from=2014-07-11T09:00&to=2014-07-20T00:00&timezone=America/New_York&campaigns=Black Friday&templates=summer-sale&metrics=&limit=5","description":"

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

\n","urlObject":{"protocol":"https","path":["api","v1","metrics","deliverability","link-name"],"host":["api","sparkpost","com"],"query":[{"key":"from","value":"2014-07-11T09:00"},{"key":"to","value":"2014-07-20T00:00"},{"key":"timezone","value":"America/New_York"},{"key":"campaigns","value":"Black Friday"},{"key":"templates","value":"summer-sale"},{"key":"metrics","value":""},{"key":"limit","value":"5"}],"variable":[]}},"response":[],"_postman_id":"1d73294f-620c-7485-8a1f-f360f93f9606"},{"name":"Deliveries By Attempt","id":"a6f2f3a2-2989-91e5-59d3-72cd7accab3d","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/metrics/deliverability/attempt?from=2014-07-11T08:00&to=2014-07-20T09:00&domains=gmail.com,yahoo.com,hotmail.com&campaigns=Black Friday&templates=summer-sale&nodes=Email-MSys-1,Email-MSys-2,Email-MSys-3,Email-MSys-4,Email-MSys-5&bindings=Confirmation&binding_groups=Transaction&protocols=smtp&timezone=America/New_York","description":"

Provides aggregate count of deliveries grouped by the attempt number.

\n","urlObject":{"protocol":"https","path":["api","v1","metrics","deliverability","attempt"],"host":["api","sparkpost","com"],"query":[{"key":"from","value":"2014-07-11T08:00"},{"key":"to","value":"2014-07-20T09:00"},{"key":"domains","value":"gmail.com,yahoo.com,hotmail.com"},{"key":"campaigns","value":"Black Friday"},{"key":"templates","value":"summer-sale"},{"key":"nodes","value":"Email-MSys-1,Email-MSys-2,Email-MSys-3,Email-MSys-4,Email-MSys-5"},{"key":"bindings","value":"Confirmation"},{"key":"binding_groups","value":"Transaction"},{"key":"protocols","value":"smtp"},{"key":"timezone","value":"America/New_York"}],"variable":[]}},"response":[],"_postman_id":"a6f2f3a2-2989-91e5-59d3-72cd7accab3d"},{"name":"Binding Groups List","id":"e302414b-ceae-74ba-3cc8-ee0de84e6701","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/metrics/binding-groups","description":"

Note: This endpoint is available in SparkPost Elite only.

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

\n","urlObject":{"protocol":"https","path":["api","v1","metrics","binding-groups"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e302414b-ceae-74ba-3cc8-ee0de84e6701"},{"name":"Bindings List","id":"b02d4696-88ec-70d3-5255-bd90ea869dba","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/metrics/bindings","description":"

Note: This endpoint is available in SparkPost Elite only.

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

\n","urlObject":{"protocol":"https","path":["api","v1","metrics","bindings"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b02d4696-88ec-70d3-5255-bd90ea869dba"},{"name":"Campaigns List","id":"d8c80d09-4b82-0172-dfc2-31c1647d6966","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/metrics/campaigns","description":"

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

\n","urlObject":{"protocol":"https","path":["api","v1","metrics","campaigns"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d8c80d09-4b82-0172-dfc2-31c1647d6966"},{"name":"Domains List","id":"e6ecf799-7945-3dc4-4395-d9046a4f83a6","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/metrics/domains","description":"

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

\n","urlObject":{"protocol":"https","path":["api","v1","metrics","domains"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e6ecf799-7945-3dc4-4395-d9046a4f83a6"},{"name":"Nodes List","id":"dc7362c5-8b4c-bdd4-af6a-8fc5d4e8133d","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/metrics/nodes","description":"

Note: This endpoint is available in SparkPost Elite only.

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

\n","urlObject":{"protocol":"https","path":["api","v1","metrics","nodes"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"dc7362c5-8b4c-bdd4-af6a-8fc5d4e8133d"},{"name":"Protocols List","id":"08f086fd-312b-079d-40fd-1ccec665e552","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/metrics/protocols","description":"

Note: This endpoint is available in SparkPost Elite only.

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

\n","urlObject":{"protocol":"https","path":["api","v1","metrics","protocols"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"08f086fd-312b-079d-40fd-1ccec665e552"}],"id":"76b6cf1e-538c-6723-fa06-2ef3e3339ed4","description":"

https://developers.sparkpost.com/api/#/reference/metrics

\n","_postman_id":"76b6cf1e-538c-6723-fa06-2ef3e3339ed4"},{"name":"Recipient Lists","item":[{"name":"Create a Recipient List","id":"17712df3-36dd-0d9a-0344-02f68a9aaafc","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{API_KEY}}"}],"body":{"mode":"raw","raw":"{\n \"id\": \"unique_id_4_graduate_students_list\",\n \"name\": \"graduate_students\",\n \"description\": \"An email list of graduate students at UMBC\",\n \"attributes\": {\n \"internal_id\": 112,\n \"list_group_id\": 12321\n },\n \"recipients\": [\n {\n \"return_path\": \"return-path-wilmaflin@tstone.com\",\n \"address\": {\n \"email\": \"wilmaflin@yahoo.com\",\n \"name\": \"Wilma\"\n },\n \"metadata\": {\n \"place\": \"Bedrock\"\n },\n \"substitution_data\": {\n \"subrcptkey\": \"subrcptvalue\"\n },\n \"tags\": [\n \"greeting\",\n \"prehistoric\",\n \"fred\",\n \"flintstone\"\n ]\n },\n {\n \"return_path\": \"return-path-abc@tstone.com\",\n \"address\": {\n \"email\": \"abc@flintstone.com\",\n \"name\": \"ABC\"\n },\n \"metadata\": {\n \"place\": \"MD\"\n },\n \"tags\": [\n \"driver\",\n \"computer science\",\n \"fred\",\n \"flintstone\"\n ]\n },\n {\n \"return_path\": \"return-path-def@tstone.com\",\n \"address\": {\n \"email\": \"fred.jones@flintstone.com\",\n \"name\": \"Grad Student Office\",\n \"header_to\": \"grad-student-office@flintstone.com\"\n },\n \"tags\": [\n \"driver\",\n \"computer science\",\n \"fred\",\n \"flintstone\"\n ]\n }\n ]\n}\n"},"url":"https://api.sparkpost.com/api/v1/recipient-lists?num_rcpt_errors=3","description":"

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\nrecipient list \"id\" is not provided in the POST request body, one will be generated and returned\nin the results body. Use the num_rcpt_errors parameter to limit the number of recipient errors\nreturned.

Note: The \"return_path\" in the POST request body applies to SparkPost Elite only.

\n","urlObject":{"protocol":"https","path":["api","v1","recipient-lists"],"host":["api","sparkpost","com"],"query":[{"key":"num_rcpt_errors","value":"3"}],"variable":[]}},"response":[],"_postman_id":"17712df3-36dd-0d9a-0344-02f68a9aaafc"},{"name":"Retrieve a Recipient List","id":"a6287a2a-27c2-42f8-a180-776c04d6b8cf","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/recipient-lists/unique_id_4_graduate_students?show_recipients=true","description":"

Retrieve details about a specified recipient list by specifying its id in the URI path. To\nretrieve the recipients contained in a list, the list must be specified and the show_recipients parameter must be set to true.

Note: The \"return_path\" in the POST request body applies to SparkPost Elite only.

\n","urlObject":{"protocol":"https","path":["api","v1","recipient-lists","unique_id_4_graduate_students"],"host":["api","sparkpost","com"],"query":[{"key":"show_recipients","value":"true"}],"variable":[]}},"response":[],"_postman_id":"a6287a2a-27c2-42f8-a180-776c04d6b8cf"},{"name":"List all Recipient Lists","id":"2cecd695-fe61-0eb6-5c30-c0aceb44e439","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/recipient-lists","description":"

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

\n","urlObject":{"protocol":"https","path":["api","v1","recipient-lists"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"2cecd695-fe61-0eb6-5c30-c0aceb44e439"},{"name":"Update a Recipient List","id":"4b96ab23-2fd5-fa9b-1dc2-1a4ea9b42a94","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{API_KEY}}"}],"body":{"mode":"raw","raw":" {\n \"name\": \"updated_graduate_students\",\n \"description\": \"An email list of graduate students at UMBC\",\n \"attributes\": {\n \"internal_id\": 112,\n \"list_group_id\": 12321\n },\n \"recipients\": [\n {\n \"address\": {\n \"email\": \"wilmaflin@yahoo.com\",\n \"name\": \"Wilma\"\n },\n \"metadata\": {\n \"place\": \"Bedrock\"\n },\n \"substitution_data\": {\n \"subrcptkey\": \"subrcptvalue\"\n },\n \"tags\": [\n \"greeting\",\n \"prehistoric\",\n \"fred\",\n \"flintstone\"\n ]\n },\n {\n \"address\": {\n \"email\": \"fred.jones@flintstone.com\",\n \"name\": \"Grad Student Office\",\n \"header_to\": \"grad-student-office@flintstone.com\"\n },\n \"tags\": [\n \"driver\",\n \"computer science\",\n \"fred\",\n \"flintstone\"\n ]\n }\n ]\n }\n"},"url":"https://api.sparkpost.com/api/v1/recipient-lists/unique_id_4_graduate_students_list?num_rcpt_errors=3","description":"

Update an existing recipient list by specifying its ID in the URI path and use a\nrecipient list object as the PUT request body. Use the num_rcpt_errors parameter to limit the number of recipient errors\nreturned.

The following are key points about updating your recipient lists:

If a non-scheduled transmission contains a recipient list, the recipient list cannot\nbe updated if the transmission is submitted or generating.
\n
If a scheduled transmission contains a recipient list, the recipient list cannot be updated if the transmission is\ngenerating or submitted and within 10 minutes of the scheduled generation time.
\n
The \"id\" field is read only and cannot be changed. If the recipient list \"id\" is provided in\nthe recipient list object, it must match the id parameter.
\n
If a \"recipients\" array is provided in the update request, it must contain the complete recipient\nlist and all relevant recipient fields whether they are being changed or not. The new recipients\nwill completely replace the existing recipients. The number of accepted recipients and the\nnumber of rejected recipients will only be returned if a \"recipients\" array is provided in the request.
\n
If a \"name\" field is provided in the update request, it will replace the existing\n\"name\" field for the recipient list.
\n
If a \"description\" field is provided in the update request, it will replace the existing\n\"description\" field for the recipient list.
\n
If an \"attributes\" object is provided in the update request, it will completely replace the existing\n\"attributes\" object for the recipient list.
\n

\n","urlObject":{"protocol":"https","path":["api","v1","recipient-lists","unique_id_4_graduate_students_list"],"host":["api","sparkpost","com"],"query":[{"key":"num_rcpt_errors","value":"3"}],"variable":[]}},"response":[],"_postman_id":"4b96ab23-2fd5-fa9b-1dc2-1a4ea9b42a94"},{"name":"Delete a Recipient List","id":"d6a6e1fb-f6e7-7f6d-d2c3-04d85ecc84fd","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{API_KEY}}"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/recipient-lists/unique_id_4_graduate_students_list","description":"

Permanently delete the specified recipient list.

Once a recipient list is deleted, it\ncannot be recovered. Before deleting a list, ensure that it is no longer needed and keep a backup copy. If a deleted\nlist is needed again, the list must be resubmitted with the CREATE API.

If a transmission contains a recipient list, the recipient list cannot be deleted if the transmission is\nsubmitted or generating.

\n","urlObject":{"protocol":"https","path":["api","v1","recipient-lists","unique_id_4_graduate_students_list"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d6a6e1fb-f6e7-7f6d-d2c3-04d85ecc84fd"}],"id":"dff7e90f-7c0f-a890-f001-94cd401da366","description":"

https://developers.sparkpost.com/api/#/reference/recipient-lists

\n","_postman_id":"dff7e90f-7c0f-a890-f001-94cd401da366"},{"name":"Relay Webhooks","item":[{"name":"Create a Relay Webhook","id":"ceae664e-8260-6165-9b44-6a038a01af98","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{API_KEY}}"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Replies Webhook\",\n \"target\": \"https://webhooks.customer.example/replies\",\n \"auth_token\": \"\",\n \"match\":\n {\n \"protocol\": \"SMTP\",\n \"domain\": \"email.example.com\"\n }\n}\n"},"url":"https://api.sparkpost.com/api/v1/relay-webhooks","description":"

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

\n","urlObject":{"protocol":"https","path":["api","v1","relay-webhooks"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ceae664e-8260-6165-9b44-6a038a01af98"},{"name":"List all Relay Webhooks","id":"56d17f29-f180-e7fb-924a-579e02239525","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/relay-webhooks","description":"

List all your relay webhooks.

\n","urlObject":{"protocol":"https","path":["api","v1","relay-webhooks"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"56d17f29-f180-e7fb-924a-579e02239525"},{"name":"Retrieve a Relay Webhook","id":"f4d03ced-3f30-5763-afec-37722f62375d","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/relay-webhooks/12013026328707075","description":"

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

\n","urlObject":{"protocol":"https","path":["api","v1","relay-webhooks","12013026328707075"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f4d03ced-3f30-5763-afec-37722f62375d"},{"name":"Update a Relay Webhook","id":"6ecdbd11-01c9-ee62-3a99-45538bc91970","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{API_KEY}}"}],"body":{"mode":"raw","raw":"{\n \"name\": \"New Replies Webhook\",\n \"target\": \"https://webhook.customer.example/replies\"\n}\n"},"url":"https://api.sparkpost.com/api/v1/relay-webhooks/12013026328707075","description":"

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

\n","urlObject":{"protocol":"https","path":["api","v1","relay-webhooks","12013026328707075"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"6ecdbd11-01c9-ee62-3a99-45538bc91970"},{"name":"Delete a Relay Webhook","id":"5d0587d4-6eaf-8e90-c053-7ce2aa058e81","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{API_KEY}}"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/relay-webhooks/12013026328707075","description":"

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

\n","urlObject":{"protocol":"https","path":["api","v1","relay-webhooks","12013026328707075"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"5d0587d4-6eaf-8e90-c053-7ce2aa058e81"}],"id":"21785ad8-2205-1524-f6d4-0ce83f98e6dd","description":"

https://developers.sparkpost.com/api/#/reference/relay-webhooks

\n","_postman_id":"21785ad8-2205-1524-f6d4-0ce83f98e6dd"},{"name":"Sending Domains","item":[{"name":"Create a Sending Domain","id":"5786b324-a481-83ee-e90b-7f4e7352953f","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{API_KEY}}"}],"body":{"mode":"raw","raw":"{\n \"domain\" : \"example1.com\",\n \"tracking_domain\" : \"click.example1.com\",\n \"dkim\" : { \"private\" : \"MIICXgIBAAKBgQC+W6scd3XWwvC/hPRksfDYFi3ztgyS9OSqnnjtNQeDdTSD1DRx/xFar2wjmzxp2+SnJ5pspaF77VZveN3P/HVmXZVghr3asoV9WBx/uW1nDIUxU35L4juXiTwsMAbgMyh3NqIKTNKyMDy4P8vpEhtH1iv/BrwMdBjHDVCycB8WnwIDAQABAoGBAITb3BCRPBi5lGhHdn+1RgC7cjUQEbSb4eFHm+ULRwQ0UIPWHwiVWtptZ09usHq989fKp1g/PfcNzm8c78uTS6gCxfECweFCRK6EdO6cCCr1cfWvmBdSjzYhODUdQeyWZi2ozqd0FhGWoV4VHseh4iLj36DzleTLtOZj3FhAo1WJAkEA68T+KkGeDyWwvttYtuSiQCCTrXYAWTQnkIUxduCp7Ap6tVeIDn3TaXTj74UbEgaNgLhjG4bX//fdeDW6PaK9YwJBAM6xJmwHLPMgwNVjiz3u/6fhY3kaZTWcxtMkXCjh1QE82KzDwqyrCg7EFjTtFysSHCAZxXZMcivGl4TZLHnydJUCQQCx16+M+mAatuiCnvxlQUMuMiSTNK6Amzm45u9v53nlZeY3weYMYFdHdfe1pebMiwrT7MI9clKebz6svYJVmdtXAkApDAc8VuR3WB7TgdRKNWdyGJGfoD1PO1ZE4iinOcoKV+IT1UCY99Kkgg6C7j62n/8T5OpRBvd5eBPpHxP1F9BNAkEA5Nf2VO9lcTetksHdIeKK+F7sio6UZn0Rv7iUo3ALrN1D1cGfWIh2dj3ko1iSreyNVSwGW0ePP27qDmU+u6/Y1g==\",\n \"public\" : \"MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC+W6scd3XWwvC/hPRksfDYFi3ztgyS9OSqnnjtNQeDdTSD1DRx/xFar2wjmzxp2+SnJ5pspaF77VZveN3P/HVmXZVghr3asoV9WBx/uW1nDIUxU35L4juXiTwsMAbgMyh3NqIKTNKyMDy4P8vpEhtH1iv/BrwMdBjHDVCycB8WnwIDAQAB\",\n \"selector\" : \"brisbane\",\n \"headers\" : \"from:to:subject:date\"\n }\n}\n"},"url":"https://api.sparkpost.com/api/v1/sending-domains","description":"

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 immediately. For these customers, there is no need to use the \"verify\" endpoint to verify Sending Domains. To find out if this applies in your SparkPost Elite environment, please contact support support@sparkpostelite.com, or contact your TAM.

\n","urlObject":{"protocol":"https","path":["api","v1","sending-domains"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"5786b324-a481-83ee-e90b-7f4e7352953f"},{"name":"List all Sending Domains","id":"2778e00f-6b4d-66ba-1d71-a8d1b7e75db3","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/sending-domains","description":"

List an overview of all sending domains in the system.

\n","urlObject":{"protocol":"https","path":["api","v1","sending-domains"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"2778e00f-6b4d-66ba-1d71-a8d1b7e75db3"},{"name":"Retrieve a Sending Domain","id":"1fa34684-6d6c-9fce-1c9e-abdbc1f99e45","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/sending-domains/example1.com","description":"

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

\n","urlObject":{"protocol":"https","path":["api","v1","sending-domains","example1.com"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"1fa34684-6d6c-9fce-1c9e-abdbc1f99e45"},{"name":"Update a Sending Domain","id":"574ed8d8-54d4-a6c0-3dd6-43d42e1b4443","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{API_KEY}}"}],"body":{"mode":"raw","raw":"{\n \"tracking_domain\": \"click.example1.com\",\n \"dkim\" : { \"private\" : \"MIICXgIBAAKBgQC+W6scd3XWwvC/hPRksfDYFi3ztgyS9OSqnnjtNQeDdTSD1DRx/xFar2wjmzxp2+SnJ5pspaF77VZveN3P/HVmXZVghr3asoV9WBx/uW1nDIUxU35L4juXiTwsMAbgMyh3NqIKTNKyMDy4P8vpEhtH1iv/BrwMdBjHDVCycB8WnwIDAQABAoGBAITb3BCRPBi5lGhHdn+1RgC7cjUQEbSb4eFHm+ULRwQ0UIPWHwiVWtptZ09usHq989fKp1g/PfcNzm8c78uTS6gCxfECweFCRK6EdO6cCCr1cfWvmBdSjzYhODUdQeyWZi2ozqd0FhGWoV4VHseh4iLj36DzleTLtOZj3FhAo1WJAkEA68T+KkGeDyWwvttYtuSiQCCTrXYAWTQnkIUxduCp7Ap6tVeIDn3TaXTj74UbEgaNgLhjG4bX//fdeDW6PaK9YwJBAM6xJmwHLPMgwNVjiz3u/6fhY3kaZTWcxtMkXCjh1QE82KzDwqyrCg7EFjTtFysSHCAZxXZMcivGl4TZLHnydJUCQQCx16+M+mAatuiCnvxlQUMuMiSTNK6Amzm45u9v53nlZeY3weYMYFdHdfe1pebMiwrT7MI9clKebz6svYJVmdtXAkApDAc8VuR3WB7TgdRKNWdyGJGfoD1PO1ZE4iinOcoKV+IT1UCY99Kkgg6C7j62n/8T5OpRBvd5eBPpHxP1F9BNAkEA5Nf2VO9lcTetksHdIeKK+F7sio6UZn0Rv7iUo3ALrN1D1cGfWIh/Y1g==\",\n \"public\" : \"MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC+W6scd3XWwvC/hPRksfDYFi3ztgyS9OSqnnjtNQeDdTSD1DRx/xFar2wjmzxp2+SnJ5pspaF77VZveN3P/HVmXZVghr3asoV9WBx/uW1nDIUxU35L4juXiTwsMAbgMyh3NqIKTNKyMDy4P8vpEhtH1iv/BrwMdBjHDVCycB8WnwIDAQAB\",\n \"selector\" : \"hello_selector\",\n \"headers\" : \"from:to:subject:date\"\n }\n}\n"},"url":"https://api.sparkpost.com/api/v1/sending-domains/example1.com","description":"

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 domain. If the supplied tracking domain is a blank string, it will clear any currently specified tracking domain. Note that if a tracking domain is not specified, any currently specified tracking domain will remain intact.

If a dkim object is provided in the update request, it must contain all relevant fields whether they are being changed or not. The new dkim object will completely overwrite the existing one.

To remove the DKIM Signing Domain Identifier for a Sending Domain, use the empty string for the value of the dkim.signing_domain field. ( Note: dkim.signing_domain is only available in SparkPost Elite. )

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 transmissions that are in progress, scheduled for the future, or use a stored template referencing the 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.
\n
Including the fields \"postmaster_at_verify\" and/or \"abuse_at_verify\" in the request results in an email sent to the specified sending domain's postmaster@ and/or abuse@ mailbox where a verification link can be clicked.
\n
Including the fields \"postmaster_at_token\" and/or \"abuse_at_token\" in the request initiates a check of the provided token(s) against the stored token(s) for the specified sending domain.
\n

The domain's \"status\" object is returned on success.

\n","urlObject":{"protocol":"https","path":["api","v1","sending-domains","","verify"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"617793f7-38f2-ccb1-69b8-f560cc554e07"}],"id":"39566d10-4ca6-7155-059c-30367cbfe155","description":"

https://developers.sparkpost.com/api/#/reference/sending-domains

\n","_postman_id":"39566d10-4ca6-7155-059c-30367cbfe155"},{"name":"Sending IPs","item":[{"name":"Get all Sending IPs ","id":"0aadeb6d-f9c5-716a-fc43-d5fd661cc2e7","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/sending-ips","urlObject":{"protocol":"https","path":["api","v1","sending-ips"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"0aadeb6d-f9c5-716a-fc43-d5fd661cc2e7"},{"name":"Get a Sending IP","id":"0559d7dd-306e-1ea7-e315-59746651356a","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/sending-ips/123.456.789.012","urlObject":{"protocol":"https","path":["api","v1","sending-ips","123.456.789.012"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"0559d7dd-306e-1ea7-e315-59746651356a"},{"name":"Update a Sending IP","id":"0bb2c12e-98fb-92ff-0da8-f6a102efe08c","request":{"method":"PUT","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"ip_pool\": \"too_cool_for_pool\"\n}"},"url":"https://api.sparkpost.com/api/v1/sending-ips/123.456.789.012","description":"

Updates the IP Pool of a sending IP.

\n","urlObject":{"protocol":"https","path":["api","v1","sending-ips","123.456.789.012"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"0bb2c12e-98fb-92ff-0da8-f6a102efe08c"}],"id":"43faa87c-5ffb-0e34-6cc0-3e685e9b19c5","_postman_id":"43faa87c-5ffb-0e34-6cc0-3e685e9b19c5","description":""},{"name":"Subaccounts","item":[{"name":"List subaccounts","id":"bdf18728-3771-ddbd-0476-6bb5c7009fa1","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/subaccounts","description":"

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

\n","urlObject":{"protocol":"https","path":["api","v1","subaccounts"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"bdf18728-3771-ddbd-0476-6bb5c7009fa1"},{"name":"Create new subaccount","id":"09c0eace-3b32-5c15-5f4f-a74764ba51f1","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{API_KEY}}"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Sparkle Ponies\",\n \"key_label\": \"API Key for Sparkle Ponies Subaccount\",\n \"key_grants\": [\"smtp/inject\", \"sending_domains/manage\", \"message_events/view\", \"suppression_lists/manage\"]\n}\n"},"url":"https://api.sparkpost.com/api/v1/subaccounts","description":"

Provisions a new subaccount and an initial subaccount API key. Subaccount API keys are only allowed very\nspecific grants, which are limited to: smtp/inject, sending_domains/manage, message_events/view and suppression_lists/manage.\nSubaccounts are allowed to send mail using the SMTP protocol, retrieve sending statistics via the Message Events API, and manage their own Sending Domains and Suppression List.

Request Body Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Required	Type	Description
name	yes	string	User friendly identifier for a specific subaccount
key_label	yes	string	User friendly identifier for the initial subaccount api key
key_grants	yes	Array	List of grants to give to the initial subaccount api key
key_valid_ips	no	Array	List of IP's that the initial subaccount api key can be used from. If empty array, then api key is usable on any IP address

","urlObject":{"protocol":"https","path":["api","v1","subaccounts"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"09c0eace-3b32-5c15-5f4f-a74764ba51f1"},{"name":"List specific subaccount","id":"8afe4b56-0931-6dc8-de77-3f55b1ba4b58","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/subaccounts/:subaccountID","description":"

Endpoint for retrieving information about a specific subaccount.

\n","urlObject":{"protocol":"https","path":["api","v1","subaccounts",":subaccountID"],"host":["api","sparkpost","com"],"query":[],"variable":[{"type":"any","key":"subaccountID"}]}},"response":[],"_postman_id":"8afe4b56-0931-6dc8-de77-3f55b1ba4b58"},{"name":"Edit a subaccount","id":"a0802336-115c-a738-2ed6-d1f5422896f3","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{API_KEY}}"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Hey Joe! Garage and Parts\",\n \"status\": \"suspended\"\n}\n"},"url":"https://api.sparkpost.com/api/v1/subaccounts/:subaccountID","description":"

Update an existing subaccount's information. You can update the following information associated with a subaccount:

Request Body Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Required	Type	Description	Notes
name	no	string	User friendly identifier for a specific subaccount
status	no	string	Status of the account	Value is one of `active`, `suspended`, or `terminated`

","urlObject":{"protocol":"https","path":["api","v1","subaccounts",":subaccountID"],"host":["api","sparkpost","com"],"query":[],"variable":[{"type":"any","key":"subaccountID"}]}},"response":[],"_postman_id":"a0802336-115c-a738-2ed6-d1f5422896f3"}],"id":"bfae011b-1056-8942-0ada-6b6f86ae9052","description":"

https://developers.sparkpost.com/api/#/introduction/subaccounts

\n","_postman_id":"bfae011b-1056-8942-0ada-6b6f86ae9052"},{"name":"Suppression List","item":[{"name":"Insert or Update List Entries","id":"ba042de1-6fdb-feb9-2843-e4de16777019","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{API_KEY}}"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/suppression-list/","description":"

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 minimum, each recipient must have a valid \"email\" address and at least one of the following keys: \"transactional\" or \"non_transactional\". The optional \"description\" key can be used to include an explanation of what type of message should be suppressed.

If the recipient entry was added to the list by Compliance, it cannot be updated.

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

\n","urlObject":{"protocol":"https","path":["api","v1","suppression-list",""],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ba042de1-6fdb-feb9-2843-e4de16777019"},{"name":"Search for List Entries","id":"06eca03f-16f9-2114-b4ea-c1a584abf8c0","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/suppression-list?to=2014-07-20T09:00:00%2B0000&from=2014-07-20T09:00:00%2B0000&types=&limit=5","description":"

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

\n","urlObject":{"protocol":"https","path":["api","v1","suppression-list"],"host":["api","sparkpost","com"],"query":[{"key":"to","value":"2014-07-20T09:00:00%2B0000"},{"key":"from","value":"2014-07-20T09:00:00%2B0000"},{"key":"types","value":""},{"key":"limit","value":"5"}],"variable":[]}},"response":[],"_postman_id":"06eca03f-16f9-2114-b4ea-c1a584abf8c0"},{"name":"Retrieve a Recipient Suppression Status","id":"86ff0001-6b92-24bc-4e60-f75b40a942ab","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/suppression-list/rcpt_1@example.com","description":"

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 list, an HTTP status of 200 is returned with the full suppression status in the response body.

In addition to the list entry attributes, the response body also includes \"created\" and \"updated\" timestamps.

\n","urlObject":{"protocol":"https","path":["api","v1","suppression-list","rcpt_1@example.com"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"86ff0001-6b92-24bc-4e60-f75b40a942ab"},{"name":"Delete a List Entry","id":"7944c58f-1ece-c6de-2fdd-35ac25132eee","request":{"method":"DELETE","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/suppression-list/rcpt_1@example.com","description":"

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 204 is returned indicating a successful deletion.

\n","urlObject":{"protocol":"https","path":["api","v1","suppression-list","rcpt_1@example.com"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"7944c58f-1ece-c6de-2fdd-35ac25132eee"}],"id":"56a15b29-7973-ba7e-b78d-9fe43e778d1f","description":"

https://developers.sparkpost.com/api/#/reference/suppression-list

\n","_postman_id":"56a15b29-7973-ba7e-b78d-9fe43e778d1f"},{"name":"Templates","item":[{"name":"Create a Template","id":"6eef1b01-fef3-05d7-9286-9b2fb081481f","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{API_KEY}}"}],"body":{"mode":"raw","raw":"{\n \"id\" : \"another_summer_sale\",\n \"name\" : \"Summer Sale!\",\n \"published\" : true,\n\n \"options\": {\n \"open_tracking\" : false,\n \"click_tracking\" : true\n },\n\n \"content\": {\n \"email_rfc822\" : \"Content-Type: text/plain\\nFrom: Example Company Marketing \\nReply-To:Summer deals \\nX-Customer-Campaign-ID: Summer2014\\nSubject: Summer deals for {{name}}\\n\\nCheck out these deals {{name}}!\"\n }\n}\n"},"url":"https://api.sparkpost.com/api/v1/templates","description":"

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, when a template is referenced in a transmission, it is the published version of that template. To submit a transmission that uses a draft template, set the transmission field \"use_draft_template\" to true. For additional details, see the Transmissions API documentation for Using a Stored Template.

Create Parts

The following are key points about creating parts in your templates, as shown in the example:

The \"id\" field may be supplied, and it must be unique.
\n
By default, templates are created as drafts. If you would like to directly publish a template upon creation, set the \"published\" field to true.
\n
Open and click tracking may be enable/disabled at the template level using the \"open_tracking\" and\n\"click_tracking\" fields.
\n
The \"from\" field may be a JSON object composed of \"email\" and \"name\".
\n
A \"Reply-To\" header may be specified using the \"reply_to\" field.
\n
Both \"text\" and \"html\" may be provided.
\n
Additional headers may be specified in the \"headers\" JSON dictionary.
\n

Create RFC822

Fully formed email_rfc822 content may be provided instead of the \"text\", \"html\", \"from\", and \"subject\" parts, as shown in the example.

\n","urlObject":{"protocol":"https","path":["api","v1","templates"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"6eef1b01-fef3-05d7-9286-9b2fb081481f"},{"name":"List all Templates","id":"076bff1e-77c5-cc65-2834-601857bd79c4","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/templates","description":"

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
\n
name: Template name
\n
published: Published state of the template (true = published, false = draft)
\n
description: Template description
\n

\n","urlObject":{"protocol":"https","path":["api","v1","templates"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"076bff1e-77c5-cc65-2834-601857bd79c4"},{"name":"Retrieve a Template","id":"6faf1bbb-2b14-0239-9658-aa6cebc4151a","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/templates/11714265276872?draft=true","description":"

Retrieve a single template by specifying its ID in the URI path. By default, the most recently\nupdated version is returned. Use the draft query parameter to specify a draft or published\ntemplate.

The result will include a \"last_update_time\" field. The \"last_update_time\" is the time the template was last updated, for both draft and published versions.

If the template was used for message generation, the result will also include a \"last_use\" field. The \"last_use\" time represents the last time any version of this template was used (draft or published).

\n","urlObject":{"protocol":"https","path":["api","v1","templates","11714265276872"],"host":["api","sparkpost","com"],"query":[{"key":"draft","value":"true"}],"variable":[]}},"response":[],"_postman_id":"6faf1bbb-2b14-0239-9658-aa6cebc4151a"},{"name":"Update a Template","id":"c3ac3a2d-832b-2e7b-bef0-b7e9f0a5b77e","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{API_KEY}}"}],"body":{"mode":"raw","raw":"{\n \"published\": true\n}\n"},"url":"https://api.sparkpost.com/api/v1/templates/11714265276872?update_published=true","description":"

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

The \"name\" field may be modified, but the \"id\" field is read only.

If a content object is provided in the update request, it must\ncontain all relevant content fields whether they are being changed or not.\nThe new content will completely overwrite the existing content.

The example shows an update that will rename the template, enable open tracking,\nand update the content all in one API call. All content fields are included whether they are being\nchanged or not.

Publishing a template is a specific case of an update. The body of the PUT\nrequest should contain the \"published\": true field as shown in the example. The\nupdate_published query parameter does not apply.

\n","urlObject":{"protocol":"https","path":["api","v1","templates","11714265276872"],"host":["api","sparkpost","com"],"query":[{"key":"update_published","value":"true"}],"variable":[]}},"response":[],"_postman_id":"c3ac3a2d-832b-2e7b-bef0-b7e9f0a5b77e"},{"name":"Preview a Template","id":"6c4b3163-6855-201c-90bc-a19d8747b6f8","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{API_KEY}}"}],"body":{"mode":"raw","raw":"{\n \"substitution_data\" : {\n \"name\" : \"Natalie\",\n \"age\" : 35,\n \"member\" : true\n }\n}\n"},"url":"https://api.sparkpost.com/api/v1/templates/11714265276872/preview?draft=true","description":"

Preview the most recent version of an existing template by specifying {id}/preview in the URI path\nand providing \"substitution_data\" as part of the POST request body.\nThe template's content will be expanded using the substitution data provided and returned\nin the response. By default, the most recently updated version is returned. Use the draft query parameter to specify a draft or published\ntemplate.

See the Substitutions Reference section for more information.

\n","urlObject":{"protocol":"https","path":["api","v1","templates","11714265276872","preview"],"host":["api","sparkpost","com"],"query":[{"key":"draft","value":"true"}],"variable":[]}},"response":[],"_postman_id":"6c4b3163-6855-201c-90bc-a19d8747b6f8"},{"name":"Delete a Template","id":"1bd82f78-3d39-f18d-696d-5d4a6ecdc3c0","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{API_KEY}}"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/templates/11714265276872","description":"

Delete a template by specifying its ID in the URI path.\nIf 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 template cannot be deleted if the transmission is submitted or generating.

\n","urlObject":{"protocol":"https","path":["api","v1","templates","11714265276872"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"1bd82f78-3d39-f18d-696d-5d4a6ecdc3c0"}],"id":"490d0317-b1fb-1cb3-77e1-109372252e75","description":"

https://developers.sparkpost.com/api/#/reference/templates

\n","_postman_id":"490d0317-b1fb-1cb3-77e1-109372252e75"},{"name":"Tracking Domains","item":[{"name":"Create a Tracking Domain","id":"121c82f3-bb65-476c-6bf6-bb5a3a5f425d","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{API_KEY}}"}],"body":{"mode":"raw","raw":"{\n \"domain\": \"example.domain.com\",\n \"port\": 8080,\n \"secure\": true\n}\n"},"url":"https://api.sparkpost.com/api/v1/tracking-domains","description":"

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.

\n","urlObject":{"protocol":"https","path":["api","v1","tracking-domains"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"121c82f3-bb65-476c-6bf6-bb5a3a5f425d"},{"name":"List all Tracking Domains","id":"c49ef10e-9e1b-93eb-fc79-baaf56a7191e","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/tracking-domains","description":"

Retrieve a list of all tracking domains.

NOTE: For SparkPost, port and secure are not returned since they are hard coded values.

\n","urlObject":{"protocol":"https","path":["api","v1","tracking-domains"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c49ef10e-9e1b-93eb-fc79-baaf56a7191e"},{"name":"Retrieve a Tracking Domain","id":"4b0a3b92-9961-7e11-fb80-33ae0df50b7e","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/tracking-domains/example.domain.com","description":"

Retrieve an existing tracking domain.

NOTE: For SparkPost, port and secure are not returned since they are hard coded values.

\n","urlObject":{"protocol":"https","path":["api","v1","tracking-domains","example.domain.com"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"4b0a3b92-9961-7e11-fb80-33ae0df50b7e"},{"name":"Update a Tracking Domain","id":"530399e5-d53c-321e-f78e-40cd2a3198e2","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{API_KEY}}"}],"body":{"mode":"raw","raw":"{\n \"port\" : 80,\n \"secure\" : true,\n \"default\" : true\n}\n"},"url":"https://api.sparkpost.com/api/v1/tracking-domains/example.domain.com","description":"

Update the attributes of an existing tracking domain. A tracking domain cannot be\nset as the default until it is verified. If a tracking domain is set to the default,\nand there is already a default domain, the default is changed.

NOTE: For SparkPost, port and secure cannot be updated.

\n","urlObject":{"protocol":"https","path":["api","v1","tracking-domains","example.domain.com"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"530399e5-d53c-321e-f78e-40cd2a3198e2"},{"name":"Delete a Tracking Domain","id":"f2b1d3aa-b1d0-819b-4385-84ce77179a6b","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{API_KEY}}"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/tracking-domains/example.domain.com","description":"

Delete an existing tracking domain.

\n","urlObject":{"protocol":"https","path":["api","v1","tracking-domains","example.domain.com"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f2b1d3aa-b1d0-819b-4385-84ce77179a6b"},{"name":"Verify a Tracking Domain","id":"f1b173fa-73ea-ea74-95bb-b8da32dd7bd1","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{API_KEY}}"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/tracking-domains/example.domain.com/verify","description":"

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

\n","urlObject":{"protocol":"https","path":["api","v1","tracking-domains","example.domain.com","verify"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f1b173fa-73ea-ea74-95bb-b8da32dd7bd1"}],"id":"bf453a04-3a57-eb58-3fdc-d947d81345f0","description":"

https://developers.sparkpost.com/api/#/reference/tracking-domains

\n","_postman_id":"bf453a04-3a57-eb58-3fdc-d947d81345f0"},{"name":"Transmissions","item":[{"name":"Create a Transmission (inline template and recipients)","id":"5402d141-c70a-7bdd-ddb8-b7238009ac40","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{API_KEY}}"}],"body":{"mode":"raw","raw":"{\n \"campaign_id\": \"postman_inline_both_example\",\n \"recipients\": [\n {\n \"address\": \"wilma@example.sink.sparkpostmail.com\"\n }\n ],\n \"content\": {\n \"from\": {\n \"email\": \"marketing@example.sink.sparkpostmail.com\",\n \"name\": \"Example Company\"\n },\n\n \"subject\": \"SparkPost inline template example\",\n \"html\": \"Here is your inline html, {{first_name or 'you great person'}}!
\"\n }\n}\n"},"url":"https://api.sparkpost.com/api/v1/transmissions?num_rcpt_errors=3","description":"

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.

Note: Sending limits apply to SparkPost only. When a transmission is created in SparkPost, the number of messages in the transmission is compared to the sending limit of your account. If the transmission will cause you to exceed your sending limit, the entire transmission results in an error and no messages are sent. Note that no messages will be sent for the given transmission, regardless of the number of messages that caused you to exceed your sending limit. In this case, the Transmission API will return an HTTP 420 error code with an error detailing whether you would exceed your hourly, daily, or sandbox sending limit.

Using Inline Email Part Content

Create a transmission using inline email part content.

Using Inline RFC822 Content

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 Recipients List

Create a transmission using a stored recipients list by specifying the \"list_id\" in the \"recipients\" attribute.

Using a Stored Template

Create a transmission using a stored template by specifying the \"template_id\" in the \"content\" attribute. The \"use_draft_template\" field is optional and indicates whether to use a draft version or the published version of the template when generating messages.

Scheduling Transmissions

Create a scheduled transmission to be generated and sent at a future time by specifying \"start_time\" in the \"options\" attribute.

Scheduling a transmission that specifies a stored template will use the LATEST version of the template available at the time of scheduled generation. The use of published versus draft versions follows the same logic in all transmission requests, whether scheduled or immediate generation. When \"use_draft_template\" is not specified (or set to false), the latest published version of the specified stored template is used. If \"use_draft_template\" is set to true, the latest draft version is used in the transmission instead.

Once message generation has been initiated, all messages in the transmission will use the template selected at the start of the generation. If a template update is made during the generation of a transmission that uses that template, the template update will succeed but the transmission will continue to use the version that was selected at the start of the generation.

\n","urlObject":{"protocol":"https","path":["api","v1","transmissions"],"host":["api","sparkpost","com"],"query":[{"key":"num_rcpt_errors","value":"3"}],"variable":[]}},"response":[],"_postman_id":"5402d141-c70a-7bdd-ddb8-b7238009ac40"},{"name":"Create a Transmission (stored template, inline recipients)","id":"a32c470c-fc0c-a8b3-b441-6857d0f9fdb2","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{API_KEY}}"}],"body":{"mode":"raw","raw":"{\n \"campaign_id\": \"postman_template_example\",\n \"recipients\": [\n {\n \"address\": \"wilma@example.sink.sparkpostmail.com\"\n }\n ],\n \"content\": {\n \"template_id\": \"postman_test_template\"\n }\n}\n"},"url":"https://api.sparkpost.com/api/v1/transmissions?num_rcpt_errors=3","description":"

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.

Using Inline Email Part Content

Create a transmission using inline email part content.

Using Inline RFC822 Content

Using a Stored Recipients List

Create a transmission using a stored recipients list by specifying the \"list_id\" in the \"recipients\" attribute.

Using a Stored Template

Scheduling Transmissions

Create a scheduled transmission to be generated and sent at a future time by specifying \"start_time\" in the \"options\" attribute.

\n","urlObject":{"protocol":"https","path":["api","v1","transmissions"],"host":["api","sparkpost","com"],"query":[{"key":"num_rcpt_errors","value":"3"}],"variable":[]}},"response":[],"_postman_id":"a32c470c-fc0c-a8b3-b441-6857d0f9fdb2"},{"name":"Create a Transmission (metadata with stored template and inline recipients)","id":"e956df04-2be9-d179-2412-a55d85e2809a","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{API_KEY}}"}],"body":{"mode":"raw","raw":"{\n \"campaign_id\": \"postman_metadata_example\",\n \"recipients\": [\n {\n \"address\": \"wilma@example.sink.sparkpostmail.com\",\n \"metadata\": {\n \"unique_id\": 424242\n },\n \"substitution_data\": {\n \"first_name\": \"Wilma\"\n }\n }\n ],\n \"content\": {\n \"template_id\": \"postman_test_template\"\n }\n}\n"},"url":"https://api.sparkpost.com/api/v1/transmissions?num_rcpt_errors=3","description":"

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.

Using Inline Email Part Content

Create a transmission using inline email part content.

Using Inline RFC822 Content

Using a Stored Recipients List

Create a transmission using a stored recipients list by specifying the \"list_id\" in the \"recipients\" attribute.

Using a Stored Template

Scheduling Transmissions

Create a scheduled transmission to be generated and sent at a future time by specifying \"start_time\" in the \"options\" attribute.

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 generation time.

\n","urlObject":{"protocol":"https","path":["api","v1","transmissions","11714265276872"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"7b89a837-739e-102b-d449-31d081c73b36"}],"id":"2e816841-9eb9-e62c-1a92-960f9bc1dc36","description":"

https://developers.sparkpost.com/api/#/reference/transmissions

\n","_postman_id":"2e816841-9eb9-e62c-1a92-960f9bc1dc36"},{"name":"Webhooks","item":[{"name":"Documentation","id":"67b2694e-b00b-c3b2-f2ea-9262f4f00765","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/webhooks/events/documentation","description":"

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

\n","urlObject":{"protocol":"https","path":["api","v1","webhooks","events","documentation"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"67b2694e-b00b-c3b2-f2ea-9262f4f00765"},{"name":"Samples","id":"52679653-6055-cbe1-3b2e-39dbce628a06","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/webhooks/events/samples?events=bounce","description":"

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.

\n","urlObject":{"protocol":"https","path":["api","v1","webhooks","events","samples"],"host":["api","sparkpost","com"],"query":[{"key":"events","value":"bounce"}],"variable":[]}},"response":[],"_postman_id":"52679653-6055-cbe1-3b2e-39dbce628a06"},{"name":"Create a Webhook","id":"a913e417-7a65-7426-6e00-63f4c91be719","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{API_KEY}}"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Example webhook\",\n \"target\": \"http://client.example.com/example-webhook\",\n \"auth_type\": \"oauth2\",\n \"auth_request_details\": {\n \"url\": \"http://client.example.com/tokens\",\n \"body\": {\n \"client_id\": \"CLIENT123\",\n \"client_secret\": \"9sdfj791d2bsbf\",\n \"grant_type\": \"client_credentials\"\n }\n },\n \"auth_token\": \"\",\n \"events\": [\n \"delivery\",\n \"injection\",\n \"open\",\n \"click\"\n ]\n}\n\n"},"url":"https://api.sparkpost.com/api/v1/webhooks","description":"

Create a webhook by providing a webhooks object as the POST request body. On creation, events will\nbegin to be pushed to the target URL specified in the POST request body.

As described in \"Webhooks Object Properties\", webhook creation entails a test POST request to the URL given as the target value. If this request does not receive an HTTP 200 response, your request to the Webhook API will fail with HTTP 400, and the webhook will not be created. If created successfully, the webhook will begin to receive event data after 1 minute.

\n","urlObject":{"protocol":"https","path":["api","v1","webhooks"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a913e417-7a65-7426-6e00-63f4c91be719"},{"name":"Retrieve Webhook Details","id":"98e295e3-a399-4afa-c06e-d7e450e86f15","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/webhooks/12affc24-f183-11e3-9234-3c15c2c818c2?timezone=America/New_York","description":"

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

\n","urlObject":{"protocol":"https","path":["api","v1","webhooks","12affc24-f183-11e3-9234-3c15c2c818c2"],"host":["api","sparkpost","com"],"query":[{"key":"timezone","value":"America/New_York"}],"variable":[]}},"response":[],"_postman_id":"98e295e3-a399-4afa-c06e-d7e450e86f15"},{"name":"List all Webhooks","id":"e9fdd2fb-8a39-3489-2ee5-d2da4292c0be","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/webhooks?timezone=America/New_York","description":"

List currently extant webhooks.

\n","urlObject":{"protocol":"https","path":["api","v1","webhooks"],"host":["api","sparkpost","com"],"query":[{"key":"timezone","value":"America/New_York"}],"variable":[]}},"response":[],"_postman_id":"e9fdd2fb-8a39-3489-2ee5-d2da4292c0be"},{"name":"Update a Webhook","id":"b7def0cd-b8ab-5db9-0e4c-0671ae7d297b","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{API_KEY}}"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Renamed webhook\",\n \"events\": [\n \"rejection\",\n \"delay\"\n ],\n \"auth_type\": \"none\"\n}\n\n"},"url":"https://api.sparkpost.com/api/v1/webhooks/12affc24-f183-11e3-9234-3c15c2c818c2","description":"

Update a webhook's properties by specifying its id in the URI path and use a webhooks object as\nthe PUT request body.

Note that batches currently queued for delivery to this webhook will not be affected by these\nmodifications. For example, if you change the webhook's target URL, batches already queued for delivery will still be POSTed to the previous URL.

As described in \"Webhooks Object Properties\", a change to the target value entails a test POST request to the URL given. If this request does not receive an HTTP 200 response, your request to the Webhooks API will fail with HTTP 400, and the webhook will not be modified.

\n","urlObject":{"protocol":"https","path":["api","v1","webhooks","12affc24-f183-11e3-9234-3c15c2c818c2"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b7def0cd-b8ab-5db9-0e4c-0671ae7d297b"},{"name":"Delete a Webhook","id":"c38301a4-c242-84cf-e063-a113a5e512b6","request":{"method":"DELETE","header":[{"key":"Authorization","value":"{{API_KEY}}"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/webhooks/12affc24-f183-11e3-9234-3c15c2c818c2","description":"

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\ndelivered are drained.

\n","urlObject":{"protocol":"https","path":["api","v1","webhooks","12affc24-f183-11e3-9234-3c15c2c818c2"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c38301a4-c242-84cf-e063-a113a5e512b6"},{"name":"Validate a Webhook","id":"4bf5e68f-4057-aed0-0f13-dc42b4811206","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"{{API_KEY}}"}],"body":{"mode":"raw","raw":"{\n \"message\": {\n \"msys\": {}\n }\n}\n\n"},"url":"https://api.sparkpost.com/api/v1/webhooks/12affc24-f183-11e3-9234-3c15c2c818c2/validate","description":"

The validation sends an example message event batch from the Webhooks API to the\ntarget URL, validates that the target responds with HTTP 200,\nand returns detailed information on the response received from the target.

Message Properties

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description	Required	Notes
message	object	Example batch to send	yes	example: `{\"msys\": {}}`

","urlObject":{"protocol":"https","path":["api","v1","webhooks","12affc24-f183-11e3-9234-3c15c2c818c2","validate"],"host":["api","sparkpost","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"4bf5e68f-4057-aed0-0f13-dc42b4811206"},{"name":"Retrieve Status Information","id":"6342ce31-1a5c-b442-879c-1e9fc7a1d59a","request":{"method":"GET","header":[{"key":"Authorization","value":"{{API_KEY}}"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.sparkpost.com/api/v1/webhooks/12affc24-f183-11e3-9234-3c15c2c818c2/batch-status?limit=1000","description":"

Retrieve status information regarding batches that have been generated\nfor the given webhook by specifying its id in the URI path. Status information includes the successes of batches\nthat previously failed to reach the webhook's target URL and batches that\nare currently in a failed state.

\n","urlObject":{"protocol":"https","path":["api","v1","webhooks","12affc24-f183-11e3-9234-3c15c2c818c2","batch-status"],"host":["api","sparkpost","com"],"query":[{"key":"limit","value":"1000"}],"variable":[]}},"response":[],"_postman_id":"6342ce31-1a5c-b442-879c-1e9fc7a1d59a"}],"id":"daa40b11-a375-3d51-abc6-03f20d3ea5ba","description":"

https://developers.sparkpost.com/api/#/reference/webhooks

\n","_postman_id":"daa40b11-a375-3d51-abc6-03f20d3ea5ba"}]}