{"componentChunkName":"component---src-templates-api-js","path":"/api/transmissions/","result":{"data":{"allApiBlueprint":{"edges":[{"node":{"meta":{"title":"A/B Testing API","label":"New"},"fields":{"path":"/api/ab-testing/","file":"ab-testing.apib"}}},{"node":{"meta":{"title":"Data Privacy API","label":"New"},"fields":{"path":"/api/data-privacy/","file":"data-privacy.apib"}}},{"node":{"meta":{"title":"Events API","label":null},"fields":{"path":"/api/events/","file":"events.apib"}}},{"node":{"meta":{"title":"Ingest API","label":"Private Access"},"fields":{"path":"/api/events-ingest/","file":"events-ingest.apib"}}},{"node":{"meta":{"title":"Inbound Domains API","label":null},"fields":{"path":"/api/inbound-domains/","file":"inbound-domains.apib"}}},{"node":{"meta":{"title":"Account API","label":null},"fields":{"path":"/api/account/","file":"account.apib"}}},{"node":{"meta":{"title":"API Overview","label":null},"fields":{"path":"/api/","file":"index.apib"}}},{"node":{"meta":{"title":"Automatic Inline Seeding","label":"Deliverability"},"fields":{"path":"/api/inline-seeds/","file":"inline-seeds.apib"}}},{"node":{"meta":{"title":"Labs APIs","label":null},"fields":{"path":"/api/labs/","file":"labs.apib"}}},{"node":{"meta":{"title":"Message Events API","label":null},"fields":{"path":"/api/message-events/","file":"message-events.apib"}}},{"node":{"meta":{"title":"Recipient Validation API","label":"New"},"fields":{"path":"/api/recipient-validation/","file":"recipient-validation.apib"}}},{"node":{"meta":{"title":"IP Pools API","label":null},"fields":{"path":"/api/ip-pools/","file":"ip-pools.apib"}}},{"node":{"meta":{"title":"Seed List API","label":"Deliverability"},"fields":{"path":"/api/seed-list/","file":"seed-list.apib"}}},{"node":{"meta":{"title":"Bounce Domains API","label":null},"fields":{"path":"/api/bounce-domains/","file":"bounce-domains.apib"}}},{"node":{"meta":{"title":"Recipient Lists API","label":null},"fields":{"path":"/api/recipient-lists/","file":"recipient-lists.apib"}}},{"node":{"meta":{"title":"Sending IPs API","label":null},"fields":{"path":"/api/sending-ips/","file":"sending-ips.apib"}}},{"node":{"meta":{"title":"Relay Webhooks API","label":null},"fields":{"path":"/api/relay-webhooks/","file":"relay-webhooks.apib"}}},{"node":{"meta":{"title":"SMTP API","label":null},"fields":{"path":"/api/smtp/","file":"smtp.apib"}}},{"node":{"meta":{"title":"Snippets API","label":"New"},"fields":{"path":"/api/snippets/","file":"snippets.apib"}}},{"node":{"meta":{"title":"Subaccounts API","label":null},"fields":{"path":"/api/subaccounts/","file":"subaccounts.apib"}}},{"node":{"meta":{"title":"Sending Domains API","label":null},"fields":{"path":"/api/sending-domains/","file":"sending-domains.apib"}}},{"node":{"meta":{"title":"Suppression List API","label":null},"fields":{"path":"/api/suppression-list/","file":"suppression-list.apib"}}},{"node":{"meta":{"title":"Template Language","label":null},"fields":{"path":"/api/template-language/","file":"template-language.apib"}}},{"node":{"meta":{"title":"Tracking Domains API","label":null},"fields":{"path":"/api/tracking-domains/","file":"tracking-domains.apib"}}},{"node":{"meta":{"title":"Templates API","label":null},"fields":{"path":"/api/templates/","file":"templates.apib"}}},{"node":{"meta":{"title":"Transmissions API","label":null},"fields":{"path":"/api/transmissions/","file":"transmissions.apib"}}},{"node":{"meta":{"title":"Event Webhooks API","label":null},"fields":{"path":"/api/webhooks/","file":"webhooks.apib"}}},{"node":{"meta":{"title":"Usage API","label":null},"fields":{"path":"/api/usage/","file":"usage.apib"}}},{"node":{"meta":{"title":"Metrics API","label":null},"fields":{"path":"/api/metrics/","file":"metrics.apib"}}}]},"apiBlueprint":{"ast":{"element":"parseResult","content":[{"element":"category","meta":{"classes":{"element":"array","content":[{"element":"string","content":"api"}]},"title":{"element":"string","content":""}},"attributes":{"meta":{"element":"array","content":[{"element":"member","meta":{"classes":{"element":"array","content":[{"element":"string","content":"user"}]}},"content":{"key":{"element":"string","content":"FORMAT"},"value":{"element":"string","content":"1A"}}},{"element":"member","meta":{"classes":{"element":"array","content":[{"element":"string","content":"user"}]}},"content":{"key":{"element":"string","content":"title"},"value":{"element":"string","content":"Transmissions API"}}},{"element":"member","meta":{"classes":{"element":"array","content":[{"element":"string","content":"user"}]}},"content":{"key":{"element":"string","content":"description"},"value":{"element":"string","content":"Use the transmissions API to send a batch of messages through SparkPost."}}}]}},"content":[{"element":"category","meta":{"classes":{"element":"array","content":[{"element":"string","content":"resourceGroup"}]},"title":{"element":"string","content":"Transmissions"}},"content":[{"element":"copy","content":"The Transmissions endpoint lets you send email. Each transmission can send an email to a single recipient or thousands. SparkPost generates and sends messages using the options you've defined, a list of recipients, and the content given in transmissions call.\n\nWhen creating a transmission, the [options](#header-request-body) allow you to configure engagement tracking, sending optimization, global substitution data, and more to control how your emails are sent.\n\nTo set the recipients you can include all recipients in the request or use a [stored recipient list](/api/recipient-lists/). For each recipient, you can specify metadata and substitution data to [personalize](/api/template-language/) each email. You can also set the transmission to treat certain recipients as [CC'd or BCC'd](https://www.sparkpost.com/docs/faq/cc-bcc-with-rest-api/).\n\nThe content of the messages can be set in 4 different ways: [inline content](#transmissions-post-send-inline-content), a [stored template](#transmissions-post-send-a-template), an [A/B test](#transmissions-post-send-an-a-b-test), or raw [RFC822 content](#transmissions-post-send-rfc822-content). Each method has different use cases they are best suited for. All of these types of content can use the substitution data and metadata to create a unique message for each recipient.\n\nLearn about [how to optimize your sending](https://www.sparkpost.com/docs/tech-resources/smtp-rest-api-performance/) with SparkPost.\n\n### The Sandbox Domain\n\nThe sandbox domain allows you to send your first email without setting up a sending domain. You can send up to 5 sandbox messages over the lifetime of your account. To send a message from the sandbox domain, set the `options.sandbox` to `true`, and set `content.template_id` to `my-first-email`. The `from` address in the template `my-first-email` should be `support@sparkpostbox.com`. You can only use the sandbox domain with the `my-first-email` template.\n\nFor more extensive testing with your own sending domain, use the SparkPost [Sink Server](https://www.sparkpost.com/docs/faq/using-sink-server/).\n\n<Banner status=\"info\">The sandbox domain is not available for <strong><a href=\"https://www.sparkpost.com/enterprise-email/\">Enterprise</a></strong> accounts.</Banner>\n\n### Sending Limits\n\nYour account has a sandbox, daily, and monthly sending limit based on your current plan level. You can view your current limits on your [dashboard](https://app.sparkpost.com/dashboard) ([EU](https://app.eu.sparkpost.com/dashboard)). If a transmission will push you over the sandbox, daily, or monthly sending limit, an error with the status code `420` is returned, along with a message detailing which limit you will exceed. If this happens, no messages are sent, regardless of the number of messages in the transmission that will push you past your limit.\n\nLearn more about these [limits](https://www.sparkpost.com/docs/faq/daily-and-monthly-quota-limits/) and [what counts towards usage](https://www.sparkpost.com/docs/getting-started/what-counts-daily-monthly-usage/).\n\n```json\n{\n  \"errors\": [\n    {\n      \"message\": \"Exceed Sending Limit (hourly)\",\n      \"code\": \"2101\"\n    }\n  ]\n}\n```"},{"element":"resource","meta":{"title":{"element":"string","content":"Create a Transmission"}},"attributes":{"href":{"element":"string","content":"/v1/transmissions"}},"content":[{"element":"copy","content":"You can create a transmission in a number of ways.\n\n<Banner status=\"warning\">The transmission content (text + html + attachments + inline images) is limited to 20 MBs.</Banner>\n\n<Banner status=\"warning\">The `override` block does **not** support substitution_data</Banner>\n\n### Request Body\n\n<DataStructure id=\"25a493e514b0cfa91bc003126d481e69\"   sample=\"%7B%0A%20%20%22options%22%3A%20%7B%0A%20%20%20%20%22click_tracking%22%3A%20false%2C%0A%20%20%20%20%22transactional%22%3A%20true%2C%0A%20%20%20%20%22ip_pool%22%3A%20%22my_ip_pool%22%2C%0A%20%20%20%20%22inline_css%22%3A%20true%2C%0A%20%20%20%20%22dkim_key%22%3A%20%22marketing%22%0A%20%20%7D%2C%0A%20%20%22override%22%3A%20%7B%0A%20%20%20%20%22from%22%3A%20%7B%0A%20%20%20%20%20%20%22name%22%3A%20%22Fred%20Flintstone%22%2C%0A%20%20%20%20%20%20%22email%22%3A%20%22fred@flintstone.com%22%0A%20%20%20%20%7D%2C%0A%20%20%20%20%22reply_to%22%3A%20%22Christmas%20Sales%20%3Csales@flintstone.com%3E%22%2C%0A%20%20%20%20%22list_id%22%3A%20%22%3Cmarketing@flintstone.com%3E%22%0A%20%20%7D%2C%0A%20%20%22description%22%3A%20%22Christmas%20Campaign%20Email%22%2C%0A%20%20%22campaign_id%22%3A%20%22christmas_campaign%22%2C%0A%20%20%22metadata%22%3A%20%7B%0A%20%20%20%20%22user_type%22%3A%20%22students%22%2C%0A%20%20%20%20%22education_level%22%3A%20%22college%22%0A%20%20%7D%2C%0A%20%20%22substitution_data%22%3A%20%7B%0A%20%20%20%20%22sender%22%3A%20%22Big%20Store%20Team%22%2C%0A%20%20%20%20%22holiday_name%22%3A%20%22Christmas%22%0A%20%20%7D%2C%0A%20%20%22recipients%22%3A%20%5B%0A%20%20%20%20%7B%0A%20%20%20%20%20%20%22address%22%3A%20%7B%0A%20%20%20%20%20%20%20%20%22email%22%3A%20%22wilma@flintstone.com%22%2C%0A%20%20%20%20%20%20%20%20%22name%22%3A%20%22Wilma%20Flintstone%22%0A%20%20%20%20%20%20%7D%2C%0A%20%20%20%20%20%20%22tags%22%3A%20%5B%0A%20%20%20%20%20%20%20%20%22prehistoric%22%0A%20%20%20%20%20%20%5D%2C%0A%20%20%20%20%20%20%22metadata%22%3A%20%7B%0A%20%20%20%20%20%20%20%20%22age%22%3A%20%2224%22%2C%0A%20%20%20%20%20%20%20%20%22place%22%3A%20%22Bedrock%22%0A%20%20%20%20%20%20%7D%2C%0A%20%20%20%20%20%20%22substitution_data%22%3A%20%7B%0A%20%20%20%20%20%20%20%20%22customer_type%22%3A%20%22Platinum%22%2C%0A%20%20%20%20%20%20%20%20%22year%22%3A%20%22Freshman%22%0A%20%20%20%20%20%20%7D%0A%20%20%20%20%7D%0A%20%20%5D%2C%0A%20%20%22content%22%3A%20%7B%20...%20%7D%0A%7D\"></DataStructure>\n\n<br />\n<br />\n<br />\n\n### Stored Recipient List\n\nThe following `recipients` attributes should be set in the `recipients` object when using a stored recipient list:\n\n<DataStructure id=\"c4d2827d6301c9385151e0a5b85de75c\"  title=\"Recipients Attributes\"  sample=\"%7B%0A%20%20%22recipients%22%3A%20%7B%0A%20%20%20%20%22list_id%22%3A%20%22christmas_sales_2013%22%0A%20%20%7D%2C%0A%20%20%22content%22%3A%20%7B%0A%20%20%20%20%22from%22%3A%20%7B%0A%20%20%20%20%20%20%22name%22%3A%20%22Our%20Store%22%2C%0A%20%20%20%20%20%20%22email%22%3A%20%22deals@example.com%22%0A%20%20%20%20%7D%2C%0A%20%20%20%20%22subject%22%3A%20%22Big%20Christmas%20savings%21%22%2C%0A%20%20%20%20%22text%22%3A%20%22Hi%20%7B%7Bname%7D%7D%20%5CnSave%20big%20this%20Christmas%20in%20your%20area%20%7B%7Bplace%7D%7D%21%20%5CnClick%20http%3A//www.mysite.com%20and%20get%20huge%20discount%5Cn%20Hurry%2C%20this%20offer%20is%20only%20to%20%7B%7Buser_type%7D%7D%5Cn%20%7B%7Bsender%7D%7D%22%2C%0A%20%20%20%20%22html%22%3A%20%22%3Cp%3EHi%20%7B%7Bname%7D%7D%20%5CnSave%20big%20this%20Christmas%20in%20your%20area%20%7B%7Bplace%7D%7D%21%20%5CnClick%20http%3A//www.mysite.com%20and%20get%20huge%20discount%5Cn%3C/p%3E%3Cp%3EHurry%2C%20this%20offer%20is%20only%20to%20%7B%7Buser_type%7D%7D%5Cn%3C/p%3E%3Cp%3E%7B%7Bsender%7D%7D%3C/p%3E%22%0A%20%20%7D%2C%0A%20%20...%0A%7D\"></DataStructure>\n\n<br />\n<br />\n<br />"},{"element":"transition","meta":{"title":{"element":"string","content":"Send Inline Content"}},"content":[{"element":"copy","content":"The template language is supported in `from`, `subject`, `text`, `html`, `amp_html`, `reply_to`, and `headers`. The following attributes are used when specifying inline content in the transmission's `content` object:\n\n<DataStructure id=\"2d4e7f24eda2c29766cced9cae75967f\"  title=\"Content Attributes\" ></DataStructure>\n\n#### Header Notes\n\n-   Headers such as `Content-Type` and `Content-Transfer-Encoding` are not allowed, as they are auto-generated upon construction of the email.\n\n-   The `To` header should not be specified, since it is generated from each recipient's `address` field.\n\n-   Each header value is expected in the UTF-8 charset without RFC2047 encoding.\n\n-   The template language is supported in headers.\n\n#### Attachment Object\n\nAttachments for a transmission are specified in the `content.attachments` array where each object in the array is described by the following attributes:\n\n<DataStructure id=\"3f60e01cac6a510bf65f3e5c1cc6ad75\"  title=\"Attributes\"  sample=\"%7B%0A%20%20%20%20%22name%22%3A%20%22billing.pdf%22%2C%0A%20%20%20%20%22type%22%3A%20%22application/pdf%22%2C%0A%20%20%20%20%22data%22%3A%20%22Q29uZ3JhdHVsYXRpb25zLCB5b3UgY2FuIGJhc2U2NCBkZWNvZGUh%22%0A%7D\"></DataStructure>\n\n<Banner status=\"danger\">Sending attachments with malicious content is <strong>strictly prohibited</strong> by SparkPost. This includes (and is not limited to) files with `bat` and `exe` extensions.</Banner>\n\n#### Inline Image Object\n\nInsert inline images into your HTML using `<img src=\"cid:NAME\" />`, where `NAME` is the value you set in the `name` attribute.\n\nInline images for a transmission are specified in the `content.inline_images` array where each object in the array is described by the following attributes:\n\n<DataStructure id=\"c6c4bba7ae4ede0226c22cd7a8823b2e\"  title=\"Attributes\"  sample=\"%7B%0A%20%20%20%20%22name%22%3A%20%22my_image.jpeg%22%2C%0A%20%20%20%20%22type%22%3A%20%22image/jpeg%22%2C%0A%20%20%20%20%22data%22%3A%20%22VGhpcyBkb2Vzbid0IGxvb2sgbGlrZSBhIGpwZWcgdG8gbWUh%22%0A%7D\"></DataStructure>"},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"POST"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}},{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"options\": {\n          \"open_tracking\": true,\n          \"click_tracking\": true\n      },\n      \"metadata\": {\n          \"user_type\": \"students\",\n          \"education_level\": \"college\"\n      },\n      \"substitution_data\": {\n          \"discount\": \"25\"\n      },\n      \"recipients\": [\n          {\n              \"address\": {\n                  \"email\": \"wilma@flintstone.com\",\n                  \"name\": \"Wilma Flintstone\"\n              },\n              \"substitution_data\": {\n                  \"customer_type\": \"Platinum\",\n              }\n          }\n      ],\n      \"content\": {\n          \"from\": {\n              \"name\": \"Fred Flintstone\",\n              \"email\": \"fred@flintstone.com\"\n          },\n          \"subject\": \"Big Christmas savings!\",\n          \"reply_to\": \"Christmas Sales <sales@flintstone.com>\",\n          \"headers\": {\n              \"X-Customer-Campaign-ID\": \"christmas_campaign\"\n          },\n          \"html\": \"<p>Hi {{address.name}} \\nSave big this Christmas in your area {{place}}! \\nClick http://www.mysite.com and get a {{discount}}% discount\\n</p><p>Hurry, this offer is only to {{user_type}}\\n</p>\"\n      }\n  }\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"results\": {\n          \"total_rejected_recipients\": 0,\n          \"total_accepted_recipients\": 1,\n          \"id\": \"11668787484950529\"\n      }\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"POST"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}},{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"options\": {\n          \"open_tracking\": true,\n          \"click_tracking\": true\n      },\n      \"metadata\": {\n          \"user_type\": \"students\",\n          \"education_level\": \"college\"\n      },\n      \"substitution_data\": {\n          \"discount\": \"25\"\n      },\n      \"recipients\": [\n          {\n              \"address\": {\n                  \"email\": \"wilma@flintstone.com\",\n                  \"name\": \"Wilma Flintstone\"\n              },\n              \"substitution_data\": {\n                  \"customer_type\": \"Platinum\",\n              }\n          }\n      ],\n      \"content\": {\n          \"from\": {\n              \"name\": \"Fred Flintstone\",\n              \"email\": \"fred@flintstone.com\"\n          },\n          \"subject\": \"Big Christmas savings!\",\n          \"reply_to\": \"Christmas Sales <sales@flintstone.com>\",\n          \"headers\": {\n              \"X-Customer-Campaign-ID\": \"christmas_campaign\"\n          },\n          \"html\": \"<p>Hi {{address.name}} \\nSave big this Christmas in your area {{place}}! \\nClick http://www.mysite.com and get a {{discount}}% discount\\n</p><p>Hurry, this offer is only to {{user_type}}\\n</p>\"\n      }\n  }\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"400"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"description\": \"Unconfigured or unverified sending domain.\",\n              \"code\": \"7001\",\n              \"message\": \"Invalid domain\"\n          }\n      ]\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"POST"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}},{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"options\": {\n          \"open_tracking\": true,\n          \"click_tracking\": true\n      },\n      \"metadata\": {\n          \"user_type\": \"students\",\n          \"education_level\": \"college\"\n      },\n      \"substitution_data\": {\n          \"discount\": \"25\"\n      },\n      \"recipients\": [\n          {\n              \"address\": {\n                  \"email\": \"wilma@flintstone.com\",\n                  \"name\": \"Wilma Flintstone\"\n              },\n              \"substitution_data\": {\n                  \"customer_type\": \"Platinum\",\n              }\n          }\n      ],\n      \"content\": {\n          \"from\": {\n              \"name\": \"Fred Flintstone\",\n              \"email\": \"fred@flintstone.com\"\n          },\n          \"subject\": \"Big Christmas savings!\",\n          \"reply_to\": \"Christmas Sales <sales@flintstone.com>\",\n          \"headers\": {\n              \"X-Customer-Campaign-ID\": \"christmas_campaign\"\n          },\n          \"html\": \"<p>Hi {{address.name}} \\nSave big this Christmas in your area {{place}}! \\nClick http://www.mysite.com and get a {{discount}}% discount\\n</p><p>Hurry, this offer is only to {{user_type}}\\n</p>\"\n      }\n  }\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"400"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"code\": \"1100\",\n              \"message\": \"Invalid DKIM key ID 'nonexistent' for sending domain 'example.com'\"\n          }\n      ]\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"POST"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}},{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"options\": {\n          \"open_tracking\": true,\n          \"click_tracking\": true\n      },\n      \"metadata\": {\n          \"user_type\": \"students\",\n          \"education_level\": \"college\"\n      },\n      \"substitution_data\": {\n          \"discount\": \"25\"\n      },\n      \"recipients\": [\n          {\n              \"address\": {\n                  \"email\": \"wilma@flintstone.com\",\n                  \"name\": \"Wilma Flintstone\"\n              },\n              \"substitution_data\": {\n                  \"customer_type\": \"Platinum\",\n              }\n          }\n      ],\n      \"content\": {\n          \"from\": {\n              \"name\": \"Fred Flintstone\",\n              \"email\": \"fred@flintstone.com\"\n          },\n          \"subject\": \"Big Christmas savings!\",\n          \"reply_to\": \"Christmas Sales <sales@flintstone.com>\",\n          \"headers\": {\n              \"X-Customer-Campaign-ID\": \"christmas_campaign\"\n          },\n          \"html\": \"<p>Hi {{address.name}} \\nSave big this Christmas in your area {{place}}! \\nClick http://www.mysite.com and get a {{discount}}% discount\\n</p><p>Hurry, this offer is only to {{user_type}}\\n</p>\"\n      }\n  }\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"400"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"code\": \"1100\",\n              \"message\": \"DKIM key 'marketing' is not verified for sending domain 'example.com'\"\n          }\n      ]\n  }\n"}]}]}]},{"element":"transition","meta":{"title":{"element":"string","content":"Send a Template"}},"content":[{"element":"copy","content":"The following attributes should be set in the `content` object when using a template as the transmission's content:\n\n<DataStructure id=\"aaf42596f96288c49f757b29c2e55384\"  title=\"Content Attributes\" ></DataStructure>"},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"POST"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"content\": {\n          \"template_id\": \"black_friday\",\n          \"use_draft_template\": true\n      },\n      \"substitution_data\": {\n          \"discount\": \"25%\"\n      },\n      \"recipients\": [\n          {\n              \"address\": {\n                  \"email\": \"wilma@flintstone.com\",\n                  \"name\": \"Wilma Flintstone\"\n              },\n              \"substitution_data\": {\n                  \"first_name\": \"Wilma\",\n                  \"last_name\": \"Flintstone\"\n              }\n          }\n      ]\n  }\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"message\": \"transmission created, but with validation errors\",\n              \"code\": \"2000\"\n          }\n      ],\n      \"results\": {\n          \"rcpt_to_errors\": [\n              {\n                  \"message\": \"required field is missing\",\n                  \"description\": \"address.email is required for each recipient\",\n                  \"code\": \"1400\"\n              }\n          ],\n          \"total_rejected_recipients\": 1,\n          \"total_accepted_recipients\": 1,\n          \"id\": \"11668787484950530\"\n      }\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"POST"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"content\": {\n          \"template_id\": \"black_friday\",\n          \"use_draft_template\": true\n      },\n      \"substitution_data\": {\n          \"discount\": \"25%\"\n      },\n      \"recipients\": [\n          {\n              \"address\": {\n                  \"email\": \"wilma@flintstone.com\",\n                  \"name\": \"Wilma Flintstone\"\n              },\n              \"substitution_data\": {\n                  \"first_name\": \"Wilma\",\n                  \"last_name\": \"Flintstone\"\n              }\n          }\n      ]\n  }\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"422"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"message\": \"Subresource not found\",\n              \"description\": \"template 'christmas_offer' does not exist\",\n              \"code\": \"1603\"\n          }\n      ]\n  }\n"}]}]}]},{"element":"transition","meta":{"title":{"element":"string","content":"Send an A/B Test"}},"content":[{"element":"copy","content":"The following attribute should be set in the `content` object when sending an A/B test as the transmission's content:\n\n<DataStructure id=\"f723558d3fc4f5a3b2bd9a3cb2560372\"  title=\"Content Attributes\" ></DataStructure>\n\nWhen using substitution data with A/B tests, data for all possible templates must be provided.  We recommend that all templates that make up an A/B test should use the same substitution data fields.\n\n<Banner status=\"warning\">A/B Tests only support single recipient transmissions currently</Banner>"},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"POST"}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"content":"  {\n      \"content\": {\n          \"ab_test_id\": \"password_reset\"\n      },\n      \"recipients\": [\n          {\n              \"address\": {\n                  \"email\": \"wilma@flintstone.com\",\n                  \"name\": \"Wilma Flintstone\"\n              },\n              \"substitution_data\": {\n                  \"first_name\": \"Wilma\",\n                  \"last_name\": \"Flintstone\"\n              }\n          }\n      ]\n  }\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"results\": {\n          \"total_rejected_recipients\": 0,\n          \"total_accepted_recipients\": 1,\n          \"id\": \"11668787493850529\"\n      }\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"POST"}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"content":"  {\n      \"content\": {\n          \"ab_test_id\": \"password_reset\"\n      },\n      \"recipients\": [\n          {\n              \"address\": {\n                  \"email\": \"wilma@flintstone.com\",\n                  \"name\": \"Wilma Flintstone\"\n              },\n              \"substitution_data\": {\n                  \"first_name\": \"Wilma\",\n                  \"last_name\": \"Flintstone\"\n              }\n          }\n      ]\n  }\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"422"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"message\": \"Subresource not found\",\n              \"description\": \"ab_test_id 'password_reset' does not exist\",\n              \"code\": \"1603\"\n          }\n      ]\n  }\n"}]}]}]},{"element":"transition","meta":{"title":{"element":"string","content":"Send RFC822 Content"}},"content":[{"element":"copy","content":"The following attribute should be set in the `content` object when sending RFC822 content as the transmission's content:\n\n<DataStructure id=\"1bdf276ed296675e5165cb2d61a511f7\"  title=\"RFC 822 Content\" ></DataStructure>\n\n-   Substitutions will be applied in the top-level headers and the first non-attachment `text/plain`, `text/html`, and `text/x-amp-html` MIME parts only.\n\n-   If `text/x-amp-html` is used, it must be a descendant of multipart/alternative, alongside at least one other `text/html` or `text/plain` MIME part.\n\n-   Lone `LF`s and lone `CR`s are allowed. SparkPost converts line endings to `CRLF` where necessary.\n\n-   It should NOT be dot stuffed. SparkPost dot stuffs before sending the email.\n\n-   It should NOT contain the SMTP terminator `\\r\\n.\\r\\n`. SparkPost adds this terminator.\n    The provided `email_rfc822` in MIME format will be rejected if SparkPost cannot parse the contents into a MIME tree.\n\nContent headers are not generated for transmissions providing RFC822 content. They are expected to be provided as headers contained in the RFC822 content."},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"POST"}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"content":"  {\n      \"description\": \"Christmas Campaign Email\",\n      \"recipients\": [\n          {\n              \"address\": {\n                  \"email\": \"wilma@flintstone.com\",\n                  \"name\": \"Wilma Flintstone\"\n              },\n              \"substitution_data\": {\n                  \"first_name\": \"Wilma\",\n                  \"customer_type\": \"Platinum\",\n                  \"year\": \"Freshman\"\n              }\n          }\n      ],\n      \"content\": {\n          \"email_rfc822\": \"Content-Type: text\\/plain\\r\\nTo: \\\"{{address.name}}\\\" <{{address.email}}>\\r\\n\\r\\n Hi {{first_name}} \\nSave big this Christmas in your area {{place}}! \\nClick http://www.mysite.com and get huge discount\\n Hurry, this offer is only to {{customer_type}}\\n {{sender}}\\r\\n\"\n      }\n  }\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"results\": {\n          \"total_rejected_recipients\": 0,\n          \"total_accepted_recipients\": 2,\n          \"id\": \"11668787484950529\"\n      }\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"POST"}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"content":"  {\n      \"description\": \"Christmas Campaign Email\",\n      \"recipients\": [\n          {\n              \"address\": {\n                  \"email\": \"wilma@flintstone.com\",\n                  \"name\": \"Wilma Flintstone\"\n              },\n              \"substitution_data\": {\n                  \"first_name\": \"Wilma\",\n                  \"customer_type\": \"Platinum\",\n                  \"year\": \"Freshman\"\n              }\n          }\n      ],\n      \"content\": {\n          \"email_rfc822\": \"Content-Type: text\\/plain\\r\\nTo: \\\"{{address.name}}\\\" <{{address.email}}>\\r\\n\\r\\n Hi {{first_name}} \\nSave big this Christmas in your area {{place}}! \\nClick http://www.mysite.com and get huge discount\\n Hurry, this offer is only to {{customer_type}}\\n {{sender}}\\r\\n\"\n      }\n  }\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"400"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"description\": \"Unconfigured or unverified sending domain.\",\n              \"code\": \"7001\",\n              \"message\": \"Invalid domain\"\n          }\n      ]\n  }\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"Scheduled Transmissions"}},"attributes":{"href":{"element":"string","content":"/v1/transmissions"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Schedule a Transmission"}},"attributes":{"href":{"element":"string","content":"/v1/transmissions/"}},"content":[{"element":"copy","content":"Create a scheduled transmission to be generated and sent at a future time by specifying `start_time` in the `options` attribute.\nThe scheduled start time cannot be more than 3 days in the future.\n\n#### Templates in Scheduled Transmissions\n\nTransmissions scheduled with a template will use the version of the template available at the scheduled time of generation.\nThis means updates to the template made between scheduling the transmission and time of generation will be reflected in the transmission.\nOnce message generation has been initiated, all emails in the transmission will be generated using the template version available at the start of the generation.\nIf a template update is made during the generation of a transmission that uses that template,\nthe template update will succeed, but the transmission will continue to use the version that was available at the start of the generation."},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"POST"}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"content":"  {\n      \"name\": \"Fall Sale\",\n      \"campaign_id\": \"fall\",\n      \"options\": {\n          \"start_time\": \"2018-09-11T08:00:00-04:00\"\n      },\n      \"recipients\": {\n          \"list_id\": \"all_subscribers\"\n      },\n      \"content\": {\n          \"template_id\": \"fall_deals\"\n      }\n  }\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"results\": {\n          \"total_rejected_recipients\": 1000,\n          \"total_accepted_recipients\": 0,\n          \"id\": \"11668787484950529\"\n      }\n  }\n"}]}]}]},{"element":"transition","meta":{"title":{"element":"string","content":"Retrieve a Scheduled Transmission"}},"attributes":{"href":{"element":"string","content":"/v1/transmissions/{id}"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","meta":{"title":{"element":"string","content":"number"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"id"},"value":{"element":"string","content":"11714265276872"}}}]}},"content":[{"element":"copy","content":"<Banner status=\"warning\"><strong>Deprecation Notice</strong>: This feature has been deprecated.</Banner>\n\nReturns details about a scheduled transmission.\nThe response for a transmission using an inline content will include `\"template_id\":\"inline\"`.\nInline content cannot be specifically queried."},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"GET"}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"results\": {\n          \"transmission\": {\n              \"id\": \"11750520427380741\",\n              \"description\": \"\",\n              \"state\": \"Success\",\n              \"campaign_id\": \"white_christmas\",\n              \"content\": {\n                  \"template_id\": \"Bob's template\",\n                  \"use_draft_template\": false\n              },\n              \"rcpt_list_chunk_size\": 100,\n              \"rcpt_list_total_chunks\": 1,\n              \"num_rcpts\": 10,\n              \"num_generated\": 10,\n              \"num_failed_gen\": 0,\n              \"generation_start_time\": \"2014-05-22T15:12:59+00:00\",\n              \"generation_end_time\": \"2014-05-22T15:13:00+00:00\",\n              \"substitution_data\": \"\",\n              \"metadata\": {\n                  \"is_snowing\": \"yes\"\n              },\n              \"options\": {\n                  \"open_tracking\": \"\",\n                  \"click_tracking\": \"\"\n              }\n          }\n      }\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"GET"}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"404"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"message\": \"resource not found\",\n              \"description\": \"Resource not found:transmission id 123\",\n              \"code\": \"1600\"\n          }\n      ]\n  }\n"}]}]}]},{"element":"transition","meta":{"title":{"element":"string","content":"Delete a Scheduled Transmission"}},"attributes":{"href":{"element":"string","content":"/v1/transmissions/{id}"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","meta":{"title":{"element":"string","content":"number"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"id"},"value":{"element":"string","content":"11714265276872"}}}]}},"content":[{"element":"copy","content":"<Banner status=\"warning\"><strong>Deprecation Notice</strong>: This feature has been deprecated. Please use the delete by campaign ID feature instead.</Banner>\n\nOnly transmissions which are scheduled for future generation may be deleted.\n\n<Banner status=\"warning\">Scheduled transmissions cannot be deleted if the transmission is within 10 minutes of the scheduled generation time.</Banner>"},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"DELETE"}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"204"}}}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"DELETE"}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"404"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"message\": \"resource not found\",\n              \"code\": \"1600\",\n              \"description\": \"Resource not found:transmission id 999999999\"\n          }\n      ]\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"DELETE"}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"409"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"message\": \"too close to generation time to delete transmission\",\n              \"code\": \"2003\",\n              \"description\": \"Deletion time window (660 seconds) doesn't permit transmission deletion\"\n          }\n      ]\n  }\n"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"DELETE"}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"409"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Content-Type"},"value":{"element":"string","content":"application/json"}}}]}},"content":[{"element":"asset","meta":{"classes":{"element":"array","content":[{"element":"string","content":"messageBody"}]}},"attributes":{"contentType":{"element":"string","content":"application/json"}},"content":"  {\n      \"errors\": [\n          {\n              \"message\": \"transmission database record is in an invalid state for deletion\",\n              \"code\": \"2006\",\n              \"description\": \"Unable to delete a transmission that is in progress (state=Generating)\"\n          }\n      ]\n  }\n"}]}]}]},{"element":"transition","meta":{"title":{"element":"string","content":"Delete Scheduled Transmissions By Campaign ID"}},"attributes":{"href":{"element":"string","content":"/v1/transmissions{?campaign_id}"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","meta":{"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"campaign_id"},"value":{"element":"string","content":"white-christmas"}}}]}},"content":[{"element":"copy","content":"Delete all transmissions in a campaign.\n\n<Banner status=\"warning\">This Request is rate limited and will return a 429 when this occurs.  Please see [Rate Limiting](https://developers.sparkpost.com/api/index/#header-rate-limiting)</Banner>\n\nPlease note that this endpoint immediately returns a 204 response and the\ndeletion process happens in the background. When a message is deleted, you will\nreceive a bounce event with a reason of \"554 5.7.1 [internal] Campaign\ncancelled\". You can consume these events via the [Events API](/api/events) and\n[Event Webhooks](/api/webhooks). You can also view statistics about these\nevents via the [Metrics API](/api/metrics).\n\nPlease also note that if you wish to cancel a transmission scheduled by a\nsubaccount, you must make the request as the subaccount, i.e., by specifying\nthe subaccount ID in the `X-MSYS-SUBACCOUNT` header as the primary account or by\nusing an API key associated with the subaccount."},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"DELETE"}}},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"204"}}}]}]}]}]},{"element":"category","meta":{"classes":{"element":"array","content":[{"element":"string","content":"dataStructures"}]}},"content":[{"element":"dataStructure","content":{"element":"object","meta":{"id":{"element":"string","content":"25a493e514b0cfa91bc003126d481e69"}},"content":[{"element":"member","meta":{"description":{"element":"string","content":"Object containing transmission options. If an option is not set, the [template-level option](#header-template-object) is used."}},"content":{"key":{"element":"string","content":"options"},"value":{"element":"object","content":[{"element":"member","meta":{"description":{"element":"string","content":"The system will not attempt to deliver messages until this datetime. For additional information, see [Scheduled Transmissions](#transmissions-scheduled-transmissions). <br />Format: `YYYY-MM-DDTHH:MM:SS+-HH:MM`"}},"content":{"key":{"element":"string","content":"start_time"},"value":{"element":"string","attributes":{"default":{"element":"string","content":"now"}}}}},{"element":"member","meta":{"description":{"element":"string","content":"  Enable or disable open tracking. If this option is not set, then the value of the `rest_tracking_default` account option is used. See the [Account API documentation](/api/account/) for more information on this account option."}},"content":{"key":{"element":"string","content":"open_tracking"},"value":{"element":"boolean"}}},{"element":"member","meta":{"description":{"element":"string","content":"  Enable or disable initial open tracking. If this option is not set and `open_tracking` is `true`, then the value of the `initial_open_pixel_tracking` account option is used. If this option is not set and `open_tracking` is `false`, then this option is set to `false`. If neither this option nor the `open_tracking` option is set, then this value is set based on the `rest_tracking_default` and `initial_open_pixel_tracking` account options. See the [Account API documentation](/api/account/) for more information on these account options."}},"content":{"key":{"element":"string","content":"initial_open"},"value":{"element":"boolean"}}},{"element":"member","meta":{"description":{"element":"string","content":"Enable or disable click tracking."}},"content":{"key":{"element":"string","content":"click_tracking"},"value":{"element":"boolean","attributes":{"default":{"element":"boolean","content":true}}}}},{"element":"member","meta":{"description":{"element":"string","content":"Distinguish between [transactional and non-transactional](https://www.sparkpost.com/resources/infographics/email-difference-transactional-vs-commercial-emails/) messages for unsubscribe and suppression purposes."}},"content":{"key":{"element":"string","content":"transactional"},"value":{"element":"boolean","attributes":{"default":{"element":"boolean","content":false}}}}},{"element":"member","meta":{"description":{"element":"string","content":"Whether to use the [sandbox sending domain](#header-the-sandbox-domain)."}},"content":{"key":{"element":"string","content":"sandbox"},"value":{"element":"boolean","attributes":{"default":{"element":"boolean","content":false}}}}},{"element":"member","meta":{"description":{"element":"string","content":"Whether to ignore customer suppression rules. <span class=\"label label-warning\"><strong>Enterprise</strong></span> only."}},"content":{"key":{"element":"string","content":"skip_suppression"},"value":{"element":"boolean","attributes":{"default":{"element":"boolean","content":false}}}}},{"element":"member","meta":{"description":{"element":"string","content":"The ID of a [dedicated IP pool](https://www.sparkpost.com/docs/deliverability/dedicated-ip-pools) to send from. If this field is not provided, the account's default dedicated IP pool is used (if there are IPs assigned to it). <br/><a href=\"https://www.sparkpost.com/enterprise-email/\"><span class=\"label label-warning\"><strong>Enterprise</strong></span></a> accounts, contact your TAM for support details."}},"content":{"key":{"element":"string","content":"ip_pool"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Whether to inline the CSS in `<style>` tags in the `<head>` in the HTML content.  Not performed on AMPHTML Email content."}},"content":{"key":{"element":"string","content":"inline_css"},"value":{"element":"boolean","attributes":{"default":{"element":"boolean","content":false}}}}},{"element":"member","meta":{"description":{"element":"string","content":"  Enable or disable substitutions. Can only be set to `false` when using an inline template. Setting to `false` disables substitutions in the `text`, `html`, `amp`, and `email_rfc822` content parts and also disables all macros (including [snippets](/api/template-language/#header-snippets)). Headers are still passed to the substitution engine when this option is set to `false`. That includes headers that are part of `email_rfc822` content parts."}},"content":{"key":{"element":"string","content":"perform_substitutions"},"value":{"element":"boolean","attributes":{"default":{"element":"boolean","content":true}}}}},{"element":"member","meta":{"description":{"element":"string","content":"  Select which [DKIM key](/api/sending-domains/#sending-domains-get-list-dkim-keys) to sign the message with. Only keys with a verified DNS record can be used. When not set, the sending domain's default key is used. Specifying a non-existent or unverified key will result in a 400 error."}},"content":{"key":{"element":"string","content":"dkim_key"},"value":{"element":"string"}}}]}}},{"element":"member","meta":{"description":{"element":"string","content":"Object containing data that overrides what is set in the content block (e.g. `from` or `reply_to` values in a stored template)"}},"content":{"key":{"element":"string","content":"override"},"value":{"element":"object","content":[{"element":"member","meta":{"description":{"element":"string","content":"Email address used to compose the email's `From` header. The domain must be a verified sending domain. Can be a string with a valid email address or an object with the following attributes:"}},"content":{"key":{"element":"string","content":"from"},"value":{"element":"enum","attributes":{"enumerations":{"element":"array","content":[{"element":"string"},{"element":"object","content":[{"element":"member","meta":{"description":{"element":"string","content":"The name associated with the email address. If omitted, falls back to `content.from.name` or the stored template's `from.name`."}},"content":{"key":{"element":"string","content":"name"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"The email address to send from."}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"email"},"value":{"element":"string"}}}]}]}}}}},{"element":"member","meta":{"description":{"element":"string","content":"Email address used to compose the email's \"Reply-To\" header."}},"content":{"key":{"element":"string","content":"reply_to"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Sets the `List-Id` header for mailing list identification (RFC 2919). Used by email clients for filtering and organization. Format: `<list-identifier>` (e.g., `<marketing@example.com>`)."}},"content":{"key":{"element":"string","content":"list_id"},"value":{"element":"string"}}}]}}},{"element":"member","meta":{"description":{"element":"string","content":"Array of [recipient objects](/api/recipient-lists/#header-recipient-object) or a single object containing a [stored recipient list](#header-stored-recipient-list)."}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"recipients"},"value":{"element":"enum","attributes":{"enumerations":{"element":"array","content":[{"element":"array"},{"element":"object"}]}}}}},{"element":"member","meta":{"description":{"element":"string","content":"Content used to generate the messages. The content can be set in 4 different ways: [inline content](#transmissions-post-send-inline-content), [stored template](#transmissions-post-send-a-template), [A/B test](#transmissions-post-send-an-a-b-test), or [RFC822 content](#transmissions-post-send-rfc822-content)."}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"content"},"value":{"element":"object"}}},{"element":"member","meta":{"description":{"element":"string","content":"Name of the campaign. Maximum length - 64 bytes"}},"content":{"key":{"element":"string","content":"campaign_id"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Description of the transmission. Maximum length - 1024 bytes"}},"content":{"key":{"element":"string","content":"description"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Transmission level metadata. Metadata is available in Webhook events and can also be used in the template language. Recipient metadata takes precedence over transmission metadata. Maximum length - 10KB."}},"content":{"key":{"element":"string","content":"metadata"},"value":{"element":"object"}}},{"element":"member","meta":{"description":{"element":"string","content":"Object of data passed to the [template language](/api/template-language/) in the content. Recipient substitution data takes precedence over transmission substitution data. Maximum length - 100KB"}},"content":{"key":{"element":"string","content":"substitution_data"},"value":{"element":"object"}}},{"element":"member","meta":{"description":{"element":"string","content":"  Email address to use for envelope FROM. The domain of the `return_path` address must be a [CNAME-verified sending domain](sending-domains.html#header-using-a-sending-domain-as-a-bounce-domain).  The local part of the `return_path` address will be overwritten by SparkPost.<br><br>For <a href=\"https://www.sparkpost.com/enterprise-email/\"><span class=\"label label-warning\"><strong>Enterprise</strong></span></a> accounts, the `return_path` may be any valid email address and the local part in the `return_path` will **not** be overwritten by SparkPost.  To support [Variable Envelope Return Path](https://en.wikipedia.org/wiki/Variable_envelope_return_path) (VERP), this field can be specified in each recipient object in order to give the recipients unique envelope MAIL FROM addresses."}},"content":{"key":{"element":"string","content":"return_path"},"value":{"element":"string"}}}]}},{"element":"dataStructure","content":{"element":"object","meta":{"id":{"element":"string","content":"c4d2827d6301c9385151e0a5b85de75c"}},"content":[{"element":"member","meta":{"description":{"element":"string","content":"  ID of the stored recipient list to use.\n\n<hr style=\"margin-top: 0;\" />\n\nCreate a transmission using a stored recipients list by specifying the `list_id` in the `recipients` attribute."}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"list_id"},"value":{"element":"string"}}}]}},{"element":"dataStructure","content":{"element":"object","meta":{"id":{"element":"string","content":"2d4e7f24eda2c29766cced9cae75967f"}},"content":[{"element":"member","meta":{"description":{"element":"string","content":"Email address used to compose the email's `From` header. The domain must be a verified sending domain. Can be a string with a valid email address or an object with the following attributes:"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"from"},"value":{"element":"enum","attributes":{"enumerations":{"element":"array","content":[{"element":"string"},{"element":"object","content":[{"element":"member","meta":{"description":{"element":"string","content":"The name associated with the email address."}},"content":{"key":{"element":"string","content":"name"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"The email address to send from."}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"email"},"value":{"element":"string"}}}]}]}}}}},{"element":"member","meta":{"description":{"element":"string","content":"Email subject line. Expected in the UTF-8 charset without RFC2047 encoding."}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"subject"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"HTML content for the email's `text/html` MIME part. At a minimum, html or text is required. Expected in the UTF-8 charset with no `Content-Transfer-Encoding` applied."}},"content":{"key":{"element":"string","content":"html"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Text content for the email's `text/plain` MIME part. At a minimum, html or text is required. Expected in the UTF-8 charset with no `Content-Transfer-Encoding` applied."}},"content":{"key":{"element":"string","content":"text"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"AMPHTML Email content for the email's `text/x-amp-html` MIME part. At least one of `content.html` or `content.text` must also be provided. Expected in the UTF-8 charset with no `Content-Transfer-Encoding` applied."}},"content":{"key":{"element":"string","content":"amp_html"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Email address used to compose the email's \"Reply-To\" header."}},"content":{"key":{"element":"string","content":"reply_to"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Object containing headers other than `Subject`, `From`, `To`, and `Reply-To` . See the [Header Notes](#header-header-notes)."}},"content":{"key":{"element":"string","content":"headers"},"value":{"element":"object"}}},{"element":"member","meta":{"description":{"element":"string","content":"Array of attachments. For a full description, see [Attachment Object](#header-attachment-object)."}},"content":{"key":{"element":"string","content":"attachments"},"value":{"element":"array","content":[{"element":"object"}]}}},{"element":"member","meta":{"description":{"element":"string","content":"Array of inline images For a full description, see [Inline Image Object](#header-inline-image-object)."}},"content":{"key":{"element":"string","content":"inline_images"},"value":{"element":"array","content":[{"element":"object"}]}}}]}},{"element":"dataStructure","content":{"element":"object","meta":{"id":{"element":"string","content":"3f60e01cac6a510bf65f3e5c1cc6ad75"}},"content":[{"element":"member","meta":{"description":{"element":"string","content":"The filename of the attachment. This is inserted into the filename parameter of the `Content-Disposition` header. Maximum length - 255 bytes"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"name"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"The MIME type of the attachment. The value will apply as-is to the `Content-Type` header of the generated MIME part for the attachment. <br /> Include the `charset` parameter, if needed (e.g. `text/html; charset=\"UTF-8\"`)"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"type"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"The content of the attachment as a Base64 encoded string. The string should not contain `\\r\\n` line breaks. SparkPost will add line breaks as necessary to ensure the Base64 encoded lines contain no more than 76 characters each."}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"data"},"value":{"element":"string"}}}]}},{"element":"dataStructure","content":{"element":"object","meta":{"id":{"element":"string","content":"c6c4bba7ae4ede0226c22cd7a8823b2e"}},"content":[{"element":"member","meta":{"description":{"element":"string","content":"The name of the image, which will be inserted into the `Content-ID` header. The name must be unique within the `content.inline_images` array. Maximum length - 255 bytes"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"name"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"The MIME type of the image.  The value will apply as-is to the `Content-Type` header of the generated MIME part for the image."}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"type"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"The content of the image as a Base64 encoded string. The string should not contain `\\r\\n` line breaks. SparkPost will add line breaks as necessary to ensure the Base64 encoded lines contain no more than 76 characters each."}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"data"},"value":{"element":"string"}}}]}},{"element":"dataStructure","content":{"element":"object","meta":{"id":{"element":"string","content":"aaf42596f96288c49f757b29c2e55384"}},"content":[{"element":"member","meta":{"description":{"element":"string","content":"ID of the template to use."}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"template_id"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Whether to use the draft version. If this is set to `true` and no draft exists, the transmission will fail."}},"content":{"key":{"element":"string","content":"use_draft_template"},"value":{"element":"boolean","attributes":{"default":{"element":"boolean","content":false}}}}}]}},{"element":"dataStructure","content":{"element":"object","meta":{"id":{"element":"string","content":"f723558d3fc4f5a3b2bd9a3cb2560372"}},"content":[{"element":"member","meta":{"description":{"element":"string","content":"ID of the A/B test to use."}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"ab_test_id"},"value":{"element":"string"}}}]}},{"element":"dataStructure","content":{"element":"object","meta":{"id":{"element":"string","content":"1bdf276ed296675e5165cb2d61a511f7"}},"content":[{"element":"member","meta":{"description":{"element":"string","content":"Pre-built message with the format as described by the [message/rfc822 Content-Type](http://tools.ietf.org/html/rfc2046#section-5.2.1)."}},"content":{"key":{"element":"string","content":"email_rfc822"},"value":{"element":"string"}}}]}}]}]},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":2},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":11798},{"element":"number","content":28}]}]}]}},"content":"action with method 'POST' already defined for resource '/v1/transmissions'"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":2},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":13788},{"element":"number","content":29}]}]}]}},"content":"action with method 'POST' already defined for resource '/v1/transmissions'"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":2},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":15471},{"element":"number","content":32}]}]}]}},"content":"action with method 'POST' already defined for resource '/v1/transmissions'"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":6},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":20173},{"element":"number","content":13}]}]}]}},"content":"empty request message-body"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":6},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":22109},{"element":"number","content":13}]}]}]}},"content":"empty request message-body"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":6},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":24286},{"element":"number","content":13}]}]}]}},"content":"empty request message-body"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":2},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":18069},{"element":"number","content":48}]}]}]}},"content":"the resource '/v1/transmissions' is already defined"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":5},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":26325},{"element":"number","content":445}]}]}]}},"content":"ignoring unrecognized type attribute"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":4},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":26301},{"element":"number","content":18}]}]}]}},"content":"invalid value for 'boolean' type. allowed values are 'true' or 'false'"}]},"TableOfContents":[{"anchor":"#transmissions","title":"Transmissions","children":[{"anchor":"#header-the-sandbox-domain","title":"The Sandbox Domain"},{"anchor":"#header-sending-limits","title":"Sending Limits"},{"anchor":"#transmissions-create-a-transmission","title":"Create a Transmission","children":[{"anchor":"#header-request-body","title":"Request Body"},{"anchor":"#header-stored-recipient-list","title":"Stored Recipient List"},{"anchor":"#transmissions-post-send-inline-content","title":"Send Inline Content","children":[{"anchor":"#header-header-notes","title":"Header Notes"},{"anchor":"#header-attachment-object","title":"Attachment Object"},{"anchor":"#header-inline-image-object","title":"Inline Image Object"}]},{"anchor":"#transmissions-post-send-a-template","title":"Send a Template"},{"anchor":"#transmissions-post-send-an-a-b-test","title":"Send an A/B Test"},{"anchor":"#transmissions-post-send-rfc822-content","title":"Send RFC822 Content"}]},{"anchor":"#transmissions-scheduled-transmissions","title":"Scheduled Transmissions","children":[{"anchor":"#transmissions-post-schedule-a-transmission","title":"Schedule a Transmission","children":[{"anchor":"#header-templates-in-scheduled-transmissions","title":"Templates in Scheduled Transmissions"}]},{"anchor":"#transmissions-get-retrieve-a-scheduled-transmission","title":"Retrieve a Scheduled Transmission"},{"anchor":"#transmissions-delete-delete-a-scheduled-transmission","title":"Delete a Scheduled Transmission"},{"anchor":"#transmissions-delete-delete-scheduled-transmissions-by-campaign-id","title":"Delete Scheduled Transmissions By Campaign ID"}]}]}],"meta":{"title":"Transmissions API","description":"Use the transmissions API to send a batch of messages through SparkPost.","full":false},"fields":{"path":"/api/transmissions/"}}},"pageContext":{"file":"transmissions.apib"}},"staticQueryHashes":["1319884646","1428769721","3859448388"]}