{"componentChunkName":"component---src-templates-api-js","path":"/api/transmissions/","result":{"data":{"allApiBlueprint":{"edges":[{"node":{"meta":{"title":"Bounce Domains API","label":null},"fields":{"path":"/api/bounce-domains/","file":"bounce-domains.apib"}}},{"node":{"meta":{"title":"Account API","label":null},"fields":{"path":"/api/account/","file":"account.apib"}}},{"node":{"meta":{"title":"Ingest API","label":"Private Access"},"fields":{"path":"/api/events-ingest/","file":"events-ingest.apib"}}},{"node":{"meta":{"title":"A/B Testing API","label":"New"},"fields":{"path":"/api/ab-testing/","file":"ab-testing.apib"}}},{"node":{"meta":{"title":"Events API","label":null},"fields":{"path":"/api/events/","file":"events.apib"}}},{"node":{"meta":{"title":"Data Privacy API","label":"New"},"fields":{"path":"/api/data-privacy/","file":"data-privacy.apib"}}},{"node":{"meta":{"title":"Inbound Domains API","label":null},"fields":{"path":"/api/inbound-domains/","file":"inbound-domains.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":"IP Pools API","label":null},"fields":{"path":"/api/ip-pools/","file":"ip-pools.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":"Recipient Lists API","label":null},"fields":{"path":"/api/recipient-lists/","file":"recipient-lists.apib"}}},{"node":{"meta":{"title":"Relay Webhooks API","label":null},"fields":{"path":"/api/relay-webhooks/","file":"relay-webhooks.apib"}}},{"node":{"meta":{"title":"Seed List API","label":"Deliverability"},"fields":{"path":"/api/seed-list/","file":"seed-list.apib"}}},{"node":{"meta":{"title":"Sending IPs API","label":null},"fields":{"path":"/api/sending-ips/","file":"sending-ips.apib"}}},{"node":{"meta":{"title":"Sending Domains API","label":null},"fields":{"path":"/api/sending-domains/","file":"sending-domains.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":"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":"Templates API","label":null},"fields":{"path":"/api/templates/","file":"templates.apib"}}},{"node":{"meta":{"title":"Tracking Domains API","label":null},"fields":{"path":"/api/tracking-domains/","file":"tracking-domains.apib"}}},{"node":{"meta":{"title":"Transmissions API","label":null},"fields":{"path":"/api/transmissions/","file":"transmissions.apib"}}},{"node":{"meta":{"title":"Usage API","label":null},"fields":{"path":"/api/usage/","file":"usage.apib"}}},{"node":{"meta":{"title":"Event Webhooks API","label":null},"fields":{"path":"/api/webhooks/","file":"webhooks.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\nTo quickly send a test of a stored template to a few recipients while editing it, use [Send a Test Email](#transmissions-post-send-a-test-email) instead of assembling a full transmission.\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\nThe sandbox domain is not available for Enterprise accounts.\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\nThe transmission content (text + html + attachments + inline images) is limited to 20 MBs.\n\nThe `override` block does **not** support substitution_data\n\n### Request Body\n\n\n\n
\n
\n
\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\n\n
\n
\n
"},{"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\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\n\nSending attachments with malicious content is strictly prohibited by SparkPost. This includes (and is not limited to) files with `bat` and `exe` extensions.\n\n#### Inline Image Object\n\nInsert inline images into your HTML using ``, 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"},{"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 \",\n \"headers\": {\n \"X-Customer-Campaign-ID\": \"christmas_campaign\"\n },\n \"html\": \"

Hi {{address.name}} \\nSave big this Christmas in your area {{place}}! \\nClick http://www.mysite.com and get a {{discount}}% discount\\n

Hurry, this offer is only to {{user_type}}\\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\": \"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 \",\n \"headers\": {\n \"X-Customer-Campaign-ID\": \"christmas_campaign\"\n },\n \"html\": \"

Hi {{address.name}} \\nSave big this Christmas in your area {{place}}! \\nClick http://www.mysite.com and get a {{discount}}% discount\\n

Hurry, this offer is only to {{user_type}}\\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":"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 \",\n \"headers\": {\n \"X-Customer-Campaign-ID\": \"christmas_campaign\"\n },\n \"html\": \"

Hi {{address.name}} \\nSave big this Christmas in your area {{place}}! \\nClick http://www.mysite.com and get a {{discount}}% discount\\n

Hurry, this offer is only to {{user_type}}\\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 \"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 \",\n \"headers\": {\n \"X-Customer-Campaign-ID\": \"christmas_campaign\"\n },\n \"html\": \"

Hi {{address.name}} \\nSave big this Christmas in your area {{place}}! \\nClick http://www.mysite.com and get a {{discount}}% discount\\n

Hurry, this offer is only to {{user_type}}\\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 \"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"},{"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\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\nA/B Tests only support single recipient transmissions currently"},{"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\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":"Send a Test Email"}},"attributes":{"href":{"element":"string","content":"/v1/transmissions/test-send"}},"content":[{"element":"copy","content":"Send a test email of a stored template to a small set of recipients. This is a scoped alternative to [creating a full transmission](#transmissions-post-create-a-transmission), designed for the template-editing workflow: you can send either the draft or the published version of a stored template to up to 5 recipients without assembling a complete transmission request.\n\nThis endpoint requires the templates/test-send grant, which is held by the Templates, Developer, and Subaccount Developer roles, and by custom users assigned the Templates policy. Users with the full Transmissions: Read/Write grant can also call it. It is currently available to web-app sessions only and cannot be assigned to API keys yet.\n\nTest sends are **real messages**. They count toward your daily and monthly [sending limits](#header-sending-limits) and account usage, generate the same events as any other message, and respect suppression lists (this cannot be bypassed).\n\nIf the template's `from` address uses the [sandbox domain](#header-the-sandbox-domain), sandbox mode is applied automatically by the service; all sandbox rules still apply (the `my-first-email` template only, and the account's lifetime sandbox limit).\n\nDraft and published versions are resolved exactly as they are for the main transmissions endpoint. A missing draft or published version produces the same errors as a regular template transmission.\n\nThis endpoint is rate limited to 6 requests per minute, per IP address. Exceeding this limit returns a 429 response."},{"element":"transition","meta":{"title":{"element":"string","content":"Send a Test Email"}},"content":[{"element":"copy","content":"\n\nAny top-level field not listed above is rejected.\n\nAll validation failures return a `422` status with the standard error body (`{\"errors\": [{\"message\": \"...\", \"code\": \"...\"}]}`). More than one error may be returned at once when a request has multiple problems.\n\n| Case | code | message |\n| ----------------------------------------------------------- | ---- | -------------------------------------------------------- |\n| `template_id` missing | 1400 | template_id is required |\n| `template_id` not a non-empty string | 1300 | template_id must be a non-empty string |\n| `draft` not a boolean | 1300 | draft must be a Boolean |\n| `recipients` missing | 1400 | recipients is required |\n| `recipients` not an array | 1300 | recipients must be an array of email addresses |\n| `recipients` empty | 5002 | at least one recipient is required |\n| More than 5 recipients | 5003 | a maximum of 5 recipients is allowed for test sends |\n| Invalid email in `recipients` | 1300 | invalid recipients[<index>] email address |\n| `substitution_data`, `metadata`, or `options` not an object | 1300 | <field> must be a JSON object |\n| `options.skip_suppression` present | 1302 | options.skip_suppression is not permitted for test sends |\n| `options.start_time` present | 1302 | options.start_time is not permitted for test sends |\n| Unknown top-level field | 1302 | unknown field '<name>' is not permitted |"},{"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 \"template_id\": \"black_friday\",\n \"draft\": true,\n \"recipients\": [\n \"wilma@flintstone.com\",\n \"fred@flintstone.com\"\n ],\n \"substitution_data\": {\n \"discount\": \"25%\"\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"},"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 \"template_id\": \"black_friday\",\n \"draft\": true,\n \"recipients\": [\n \"wilma@flintstone.com\",\n \"fred@flintstone.com\"\n ],\n \"substitution_data\": {\n \"discount\": \"25%\"\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\": \"a maximum of 5 recipients is allowed for test sends\",\n \"code\": \"5003\"\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":"Deprecation Notice: This feature has been deprecated.\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":"Deprecation Notice: This feature has been deprecated. Please use the delete by campaign ID feature instead.\n\nOnly transmissions which are scheduled for future generation may be deleted.\n\nScheduled transmissions cannot be deleted if the transmission is within 10 minutes of the scheduled generation time."},{"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\nThis 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)\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":"5166af957088fa93751b303eef56deec"}},"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).
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. Enterprise 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).
Enterprise 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 `