{"componentChunkName":"component---src-templates-api-js","path":"/api/templates/","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":"Templates API"}}},{"element":"member","meta":{"classes":{"element":"array","content":[{"element":"string","content":"user"}]}},"content":{"key":{"element":"string","content":"description"},"value":{"element":"string","content":"Manage reusable content templates that are run through the SparkPost template engine and can be used when sending messages."}}}]}},"content":[{"element":"category","meta":{"classes":{"element":"array","content":[{"element":"string","content":"resourceGroup"}]},"title":{"element":"string","content":"Templates"}},"content":[{"element":"copy","content":"Templates are a way to store and edit email content.\nInstead of passing inline content to a [Transmission](/api/transmissions/) request, a template can be set to provide the content.\nAll email content in a template (from, headers, text, html, and amp_html) supports the [template language](/api/template-language/) for personalized emails.\n\n## Drafts & Published versions\n\nTemplates can have both a draft and a published version. Transmissions send the published version by default.\nThis allows you to work on an upcoming version of the content while continuing to send the last published version.\nOnce ready, [publish the draft](#templates-put-publish-a-draft) to the start sending the new version without needing to change the transmission request.\nIf needed, it's also possible to update the published version of a template directly, without affecting the draft version.\n\n## Template Object\n\n<DataStructure id=\"bf19f6387a408cffbc6df78a5bfb3655\"  title=\"Attributes\"  sample=\"%7B%0A%20%20%20%20%22id%22%3A%20%22onboarding-email%22%2C%0A%20%20%20%20%22name%22%3A%20%22Onboarding%20email%22%2C%0A%20%20%20%20%22description%22%3A%20%22First%20email%20sent%20on%20sign-up%22%2C%0A%20%20%20%20%22content%22%3A%20%7B%0A%20%20%20%20%20%20%20%20%22html%22%3A%20%22%3Cp%3EPlease%20confirm%20your%20email%20by%20clicking%20%3Ca%20href%3D%5C%22%7B%7B%20link%20%7D%7D%5C%22%3Ethis%20link%3C/a%3E%3C/p%3E%22%2C%0A%20%20%20%20%20%20%20%20%22text%22%3A%20%22Please%20confirm%20your%20email%20by%20clicking%20this%20link%3A%20%7B%7B%20link%20%7D%7D%22%2C%0A%20%20%20%20%20%20%20%20%22from%22%3A%20%22%7B%7B%20friendly_from%20%7D%7D%20%3Cteam@ourdomain.com%3E%22%2C%0A%20%20%20%20%20%20%20%20%22subject%22%3A%20%22Welcome%21%22%0A%20%20%20%20%7D%2C%0A%20%20%20%20%22published%22%3A%20true%2C%0A%20%20%20%20%22has_draft%22%3A%20true%2C%0A%20%20%20%20%22has_published%22%3A%20true%2C%0A%20%20%20%20%22last_update_time%22%3A%20%222018-07-03T23%3A41%3A07+00%3A00%22%2C%0A%20%20%20%20%22last_use%22%3A%20%222018-07-02T18%3A48%3A18+00%3A00%22%2C%0A%20%20%20%20%22shared_with_subaccounts%22%3A%20false%2C%0A%20%20%20%20%22options%22%3A%20%7B%0A%20%20%20%20%20%20%20%20%22transactional%22%3A%20true%0A%20%20%20%20%7D%0A%7D\"></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### Error Object\n\nOn request failure, an `errors` array will be returned along with HTTP 4xx or 5xx.\nTo help debug content issues, templates errors are more detailed than usual.\nEach error is described in a object with the following attributes:\n\n<DataStructure id=\"538f830d3ed8fef67e6d7711fa5abf7e\"  title=\"Attributes\"  sample=\"%7B%0A%20%20%20%20%22errors%22%3A%20%5B%0A%20%20%20%20%20%20%20%20%7B%0A%20%20%20%20%20%20%20%20%20%20%20%20%22message%22%3A%20%22substitution%20language%20syntax%20error%20in%20template%20content%22%2C%0A%20%20%20%20%20%20%20%20%20%20%20%20%22code%22%3A%20%223000%22%2C%0A%20%20%20%20%20%20%20%20%20%20%20%20%22description%22%3A%20%22Error%20while%20compiling%20part%20text%3A%20line%204%3A%20syntax%20error%20near%20%27age%27%22%2C%0A%20%20%20%20%20%20%20%20%20%20%20%20%22part%22%3A%20%22html%22%2C%0A%20%20%20%20%20%20%20%20%20%20%20%20%22line%22%3A%204%0A%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%5D%0A%7D\"></DataStructure>"},{"element":"resource","meta":{"title":{"element":"string","content":"Create a Template"}},"attributes":{"href":{"element":"string","content":"/v1/templates"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Create a Template"}},"attributes":{"href":{"element":"string","content":"/v1/templates"}},"content":[{"element":"copy","content":"Templates are created as drafts.\n\n<DataStructure id=\"bbc3653338a68a4eb29d2a2b2b3a7abd\"  ></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            \"id\": \"summer_sale\",\n            \"name\": \"Summer Sale!\",\n            \"published\": true,\n            \"description\": \"Template for a Summer Sale!\",\n            \"shared_with_subaccounts\": false,\n            \"options\": {\n                \"open_tracking\": false,\n                \"click_tracking\": true\n            },\n            \"content\": {\n                \"from\": {\n                  \"email\": \"marketing@bounces.company.example\",\n                  \"name\": \"Example Company Marketing\"\n                },\n                \"subject\": \"Summer deals for {{name}}\",\n                \"reply_to\": \"Summer deals <summer_deals@company.example>\",\n                \"text\": \"Check out these deals {{name}}!\",\n                \"html\": \"<b>Check out these deals {{name}}!</b>\",\n                \"headers\": {\n                  \"X-Example-Header\": \"Summer2014\"\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          \"id\": \"summer_sale\"\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            \"id\": \"summer_sale\",\n            \"name\": \"Summer Sale!\",\n            \"published\": true,\n            \"description\": \"Template for a Summer Sale!\",\n            \"shared_with_subaccounts\": false,\n            \"options\": {\n                \"open_tracking\": false,\n                \"click_tracking\": true\n            },\n            \"content\": {\n                \"from\": {\n                  \"email\": \"marketing@bounces.company.example\",\n                  \"name\": \"Example Company Marketing\"\n                },\n                \"subject\": \"Summer deals for {{name}}\",\n                \"reply_to\": \"Summer deals <summer_deals@company.example>\",\n                \"text\": \"Check out these deals {{name}}!\",\n                \"html\": \"<b>Check out these deals {{name}}!</b>\",\n                \"headers\": {\n                  \"X-Example-Header\": \"Summer2014\"\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              \"part\": \"text\",\n              \"description\": \"Error while compiling part text: line 4: syntax error near 'age'\",\n              \"line\": 4,\n              \"code\": \"3000\",\n              \"message\": \"substitution language syntax error in template content\"\n          }\n      ]\n  }\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"Retrieve a Template"}},"attributes":{"href":{"element":"string","content":"/v1/templates/{id}{?draft}"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Retrieve a Template"}},"attributes":{"href":{"element":"string","content":"/v1/templates/{id}{?draft}"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","meta":{"description":{"element":"string","content":"Case sensitive."},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"id"},"value":{"element":"string","content":"11714265276872"}}},{"element":"member","meta":{"description":{"element":"string","content":"If true, returns the draft template. If false, returns the published template."},"title":{"element":"string","content":"boolean"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"draft"},"value":{"element":"string","content":"true"}}}]}},"content":[{"element":"copy","content":"Use the `draft` query parameter to specify the draft or published version of the template."},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"GET"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}},{"element":"member","content":{"key":{"element":"string","content":"Accept"},"value":{"element":"string","content":"application/json"}}}]}}},{"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          \"id\": \"summer_sale\",\n          \"name\": \"Summer Sale!\",\n          \"description\": \"\",\n          \"has_draft\": true,\n          \"has_published\": true,\n          \"published\": false,\n          \"shared_with_subaccounts\": false,\n          \"last_update_time\": \"2014-05-22T15:12:59+00:00\",\n          \"last_use\": \"2014-06-02T08:15:30+00:00\",\n          \"options\": {\n              \"open_tracking\": false,\n              \"click_tracking\": true,\n              \"transactional\": false\n          },\n          \"content\": {\n              \"from\": {\n                  \"email\": \"marketing@bounces.company.example\",\n                  \"name\": \"Example Company Marketing\"\n              },\n              \"subject\": \"Summer deals for {{name}}\",\n              \"reply_to\": \"Summer deals <summer_deals@company.example>\",\n              \"text\": \"Check out these deals {{name}}!\",\n              \"html\": \"<b>Check out these deals {{name}}!</b>\",\n              \"headers\": {\n                  \"X-Example-Header\": \"Summer2014\"\n              }\n          }\n      }\n  }\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"Update a Draft"}},"attributes":{"href":{"element":"string","content":"/v1/templates/{id}"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Update a Draft"}},"attributes":{"href":{"element":"string","content":"/v1/templates/{id}"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","meta":{"description":{"element":"string","content":"Case sensitive."},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"id"},"value":{"element":"string","content":"11714265276872"}}}]}},"content":[{"element":"copy","content":"Updates the draft version of a template.\n\nIf a content object is provided in the request body, it must contain all relevant content fields whether they are being changed or not.\nThe new content will completely overwrite the existing content.\n\n<DataStructure id=\"ac5eef1d0f44d076c12cedc73579d547\"  ></DataStructure>"},{"element":"httpTransaction","content":[{"element":"httpRequest","meta":{"title":{"element":"string","content":"Update"}},"attributes":{"method":{"element":"string","content":"PUT"},"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      },\n      \"name\": \"A new name!\",\n      \"shared_with_subaccounts\": true,\n      \"content\": {\n          \"from\": {\n              \"email\": \"marketing@bounces.company.example\",\n              \"name\": \"Example Company Marketing\"\n          },\n          \"subject\": \"Updated Summer deals for {{name}}\",\n          \"reply_to\": \"Summer deals <summer_deals@company.example>\",\n          \"text\": \"Updated: Check out these deals {{name}}!\",\n          \"html\": \"<b>Updated: Check out these deals {{name}}!</b>\"\n      }\n  }\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"}}}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"Publish a Draft"}},"attributes":{"href":{"element":"string","content":"/v1/templates/{id}"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Publish a Draft"}},"attributes":{"href":{"element":"string","content":"/v1/templates/{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":"id"},"value":{"element":"string","content":"11714265276872"}}}]}},"content":[{"element":"copy","content":"Uses the draft version to create a new published version.\n\n<DataStructure id=\"6b3fb4fb87ec42c941a330b8bb8bc563\"  ></DataStructure>"},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"PUT"},"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      \"published\": true\n  }\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"}}}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"Update a Published Template"}},"attributes":{"href":{"element":"string","content":"/v1/templates/{id}{?update_published}"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Update a Published Template"}},"attributes":{"href":{"element":"string","content":"/v1/templates/{id}{?update_published}"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","meta":{"description":{"element":"string","content":"Case sensitive."},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"id"},"value":{"element":"string","content":"11714265276872"}}},{"element":"member","meta":{"description":{"element":"string","content":"Set to `true` to overwrite the existing published template."},"title":{"element":"string","content":"boolean"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"update_published"},"value":{"element":"string","content":"true"}}}]}},"content":[{"element":"copy","content":"An existing published version can be overwritten directly by setting the `update_published` query parameter to `true`.\nIf the query param is not passed or set to `false`, it will result in an update to the draft version.\n\nIf a content object is provided in the update request, it must contain all relevant content fields whether they are being changed or not.\nThe new content will completely overwrite the existing content.\n\n<DataStructure id=\"a6172f12f68ffdfc3d7777889a86e751\"  ></DataStructure>"},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"PUT"},"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      },\n      \"name\": \"A new name!\",\n      \"shared_with_subaccounts\": true,\n      \"content\": {\n          \"from\": {\n              \"email\": \"marketing@bounces.company.example\",\n              \"name\": \"Example Company Marketing\"\n          },\n          \"subject\": \"Updated Summer deals for {{name}}\",\n          \"reply_to\": \"Summer deals <summer_deals@company.example>\",\n          \"text\": \"Updated: Check out these deals {{name}}!\",\n          \"html\": \"<b>Updated: Check out these deals {{name}}!</b>\"\n      }\n  }\n"}]},{"element":"httpResponse","attributes":{"statusCode":{"element":"string","content":"200"}}}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"Preview a Template"}},"attributes":{"href":{"element":"string","content":"/v1/templates/{id}/preview{?draft}"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Preview a Template"}},"attributes":{"href":{"element":"string","content":"/v1/templates/{id}/preview{?draft}"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","meta":{"description":{"element":"string","content":"Case sensitive."},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"id"},"value":{"element":"string","content":"11714265276872"}}},{"element":"member","meta":{"description":{"element":"string","content":"If true, previews the draft template. If false, previews the published template."},"title":{"element":"string","content":"boolean"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"draft"},"value":{"element":"string","content":"true"}}}]}},"content":[{"element":"copy","content":"The template's content will be expanded using the substitution data provided and returned in the response.\nUse the `draft` query parameter to specify a draft or published version.\n\nSee [Template Language](/api/template-language/) for more information.\n\n<DataStructure id=\"fef82ca57d5943d9b2842c068a5696c0\"  ></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      \"substitution_data\": {\n          \"name\": \"Natalie\",\n          \"age\": 35,\n          \"member\": true\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          \"from\": {\n              \"email\": \"marketing@bounces.company.example\",\n              \"name\": \"Example Company Marketing\"\n          },\n          \"subject\": \"Summer deals for Natalie\",\n          \"reply_to\": \"Summer deals <summer_deals@company.example>\",\n          \"text\": \"Check out these deals Natalie!\",\n          \"html\": \"<b>Check out these deals Natalie!</b>\",\n          \"headers\": {\n              \"X-Example-Header\": \"Summer2018\"\n          }\n      }\n  }\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"Delete a Template"}},"attributes":{"href":{"element":"string","content":"/v1/templates/{id}"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Delete a Template"}},"attributes":{"href":{"element":"string","content":"/v1/templates/{id}"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","meta":{"description":{"element":"string","content":"Case sensitive."},"title":{"element":"string","content":"string"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"id"},"value":{"element":"string","content":"11714265276872"}}}]}},"content":[{"element":"copy","content":"Deletes both published and draft versions of a template.\n\n<Banner status=\"info\">If a transmission uses a template, the template cannot be deleted if the transmission is submitted or generating.</Banner>"},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"DELETE"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}}},{"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"}]}]},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"DELETE"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}}]}}},{"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\": \"resource conflict\",\n              \"code\": \"1602\",\n              \"description\": \"Template is in use by msg generation\"\n          }\n      ]\n  }\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"List all Templates"}},"attributes":{"href":{"element":"string","content":"/v1/templates{?draft,shared_with_subaccounts}"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"List all Templates"}},"attributes":{"href":{"element":"string","content":"/v1/templates{?draft,shared_with_subaccounts}"},"hrefVariables":{"element":"hrefVariables","content":[{"element":"member","meta":{"description":{"element":"string","content":"If true, returns the draft templates. If false, returns the published templates. When not provided, returns the most recently edited templates (draft or published)."},"title":{"element":"string","content":"boolean"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"draft"},"value":{"element":"string","content":"true"}}},{"element":"member","meta":{"description":{"element":"string","content":"If true, returns only shared templates. If false, returns only non-shared templates."},"title":{"element":"string","content":"boolean"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"optional"}]}},"content":{"key":{"element":"string","content":"shared_with_subaccounts"},"value":{"element":"string","content":"true"}}}]}},"content":[{"element":"copy","content":"Returns an array containing up to your first 50,000 templates."},{"element":"httpTransaction","content":[{"element":"httpRequest","attributes":{"method":{"element":"string","content":"GET"},"headers":{"element":"httpHeaders","content":[{"element":"member","content":{"key":{"element":"string","content":"Authorization"},"value":{"element":"string","content":"14ac5499cfdd2bb2859e4476d2e5b1d2bad079bf"}}},{"element":"member","content":{"key":{"element":"string","content":"Accept"},"value":{"element":"string","content":"application/json"}}}]}}},{"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          {\n              \"id\": \"summer_sale\",\n              \"name\": \"Summer Sale!\",\n              \"published\": false,\n              \"description\": \"\",\n              \"has_draft\": true,\n              \"has_published\": true,\n              \"last_update_time\": \"2017-08-11T12:12:12+00:00\",\n              \"shared_with_subaccount\": true\n          },\n          {\n              \"id\": \"daily\",\n              \"name\": \"daily\",\n              \"published\": false,\n              \"description\": \"Daily roundup email.\",\n              \"has_draft\": true,\n              \"has_published\": true,\n              \"last_use\": \"2018-05-08T14:49:03+00:00\"\n              \"last_update_time\": \"2018-02-10T14:15:16+00:00\",\n              \"shared_with_subaccount\": true\n          }\n      ]\n  }\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"Create an RFC 822 Template"}},"attributes":{"href":{"element":"string","content":"/v1/templates"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Create an RFC 822 Template"}},"attributes":{"href":{"element":"string","content":"/v1/templates"}},"content":[{"element":"copy","content":"Instead of the standard attributes, the content object may contain a single `email_rfc822` attribute. `email_rfc822` is mutually exclusive with all other content attributes.\n\n<DataStructure id=\"875656d20eb592fe311747cb27c0f1db\"  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."},{"element":"httpTransaction","content":[{"element":"httpRequest","meta":{"title":{"element":"string","content":"Create RFC822"}},"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      \"id\": \"another_summer_sale\",\n      \"name\": \"Summer Sale!\",\n      \"published\": true,\n      \"options\": {\n          \"open_tracking\": false,\n          \"click_tracking\": true\n      },\n      \"content\": {\n          \"email_rfc822\": \"Content-Type: text/plain\\nFrom: Example Company Marketing <marketing@bounces.company.example>\\nReply-To:Summer deals <summer_deals@company.example>\\nX-Example-Header: Summer2014\\nSubject: Summer deals for {{name}}\\n\\nCheck out these deals {{name}}!\"\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          \"id\": \"another_summer_sale\"\n      }\n  }\n"}]}]}]}]},{"element":"resource","meta":{"title":{"element":"string","content":"Preview an inline Template"}},"attributes":{"href":{"element":"string","content":"/v1/utils/content-previewer"}},"content":[{"element":"transition","meta":{"title":{"element":"string","content":"Preview an inline Template"}},"attributes":{"href":{"element":"string","content":"/v1/utils/content-previewer"}},"content":[{"element":"copy","content":"Requests to this endpoint must include the \"substitution_data\" and \"content\" fields. The content will be expanded using the substitution data and returned in the response.\n\nSee the [Templates API](/api/templates/#header-template-object) section for the definition of the content object.\n\nSee [Template Language](/api/template-language/) for more information.\n\n-   Data Structure\n\n    -   substitution_data (object) - Data passed to the template engine.\n    -   content (object) - Inline template content fields."},{"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      \"substitution_data\": {\n          \"name\": \"Natalie\",\n          \"age\": 35,\n          \"member\": true\n      },\n      \"content\": {\n        \"from\" : \"sandbox@sparkpostbox.com\",\n        \"subject\": \"Summer deals for {{name}}\",\n        \"html\": \"<b>Check out these deals {{name}}!</b>\"\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      \"subject\": \"Summer deals for Natalie\",\n      \"html\": \"<b>Check out these deals Natalie!</b>\"\n    }\n  }\n"}]}]}]}]}]},{"element":"category","meta":{"classes":{"element":"array","content":[{"element":"string","content":"dataStructures"}]}},"content":[{"element":"dataStructure","content":{"element":"object","meta":{"id":{"element":"string","content":"bf19f6387a408cffbc6df78a5bfb3655"}},"content":[{"element":"member","meta":{"description":{"element":"string","content":"Unique alphanumeric ID."}},"content":{"key":{"element":"string","content":"id"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Display name."}},"content":{"key":{"element":"string","content":"name"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Description of the template."}},"content":{"key":{"element":"string","content":"description"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Content that will be used to construct an email. The template language is supported in all content attributes."}},"content":{"key":{"element":"string","content":"content"},"value":{"element":"object","content":[{"element":"member","meta":{"description":{"element":"string","content":"HTML content for the email's `text/html` MIME part."}},"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."}},"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."}},"content":{"key":{"element":"string","content":"amp_html"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Email subject line."}},"content":{"key":{"element":"string","content":"subject"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Email address used to compose the email's `From` header. Can be an object with `name` & `email` attributes: `{ \"name\": \"My Company\", \"email\": \"deals@company.com\" }`."}},"content":{"key":{"element":"string","content":"from"},"value":{"element":"enum","attributes":{"enumerations":{"element":"array","content":[{"element":"object"},{"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":"Whether the template is published or is a draft version. A template cannot be changed from published to draft."}},"content":{"key":{"element":"string","content":"published"},"value":{"element":"boolean"}}},{"element":"member","meta":{"description":{"element":"string","content":"Object containing template options. All template options can be overwritten in a transmission's options."}},"content":{"key":{"element":"string","content":"options"},"value":{"element":"object","content":[{"element":"member","meta":{"description":{"element":"string","content":"Distinguish between transactional and non-transactional messages for unsubscribe and suppression purposes."}},"content":{"key":{"element":"string","content":"transactional"},"value":{"element":"boolean"}}},{"element":"member","meta":{"description":{"element":"string","content":"Enable or disable open tracking."}},"content":{"key":{"element":"string","content":"open_tracking"},"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"}}}]}}},{"element":"member","meta":{"description":{"element":"string","content":"Whether the template has a draft version."}},"content":{"key":{"element":"string","content":"has_draft"},"value":{"element":"boolean"}}},{"element":"member","meta":{"description":{"element":"string","content":"Whether the template has a published version."}},"content":{"key":{"element":"string","content":"has_published"},"value":{"element":"boolean"}}},{"element":"member","meta":{"description":{"element":"string","content":"The last date this template was updated."}},"content":{"key":{"element":"string","content":"last_update_time"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"The last date any version of this template (draft or published) was used for generating an email. Only present if template has been used."}},"content":{"key":{"element":"string","content":"last_use"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Whether this template can be used by subaccounts. Only present on templates that belong to a primary account."}},"content":{"key":{"element":"string","content":"shared_with_subaccounts"},"value":{"element":"boolean"}}},{"element":"member","meta":{"description":{"element":"string","content":"Subaccount the template belongs to. Only present on templates that belong to a subaccount."}},"content":{"key":{"element":"string","content":"subaccount_id"},"value":{"element":"number"}}}]}},{"element":"dataStructure","content":{"element":"object","meta":{"id":{"element":"string","content":"538f830d3ed8fef67e6d7711fa5abf7e"}},"content":[{"element":"member","meta":{"description":{"element":"string","content":"Explains the type of error"}},"content":{"key":{"element":"string","content":"message"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Identifies the type of error"}},"content":{"key":{"element":"string","content":"code"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Explanation of error"}},"content":{"key":{"element":"string","content":"description"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Identifies the content section where the error occurred"}},"content":{"key":{"element":"string","content":"part"},"value":{"element":"enum","attributes":{"enumerations":{"element":"array","content":[{"element":"string","content":"text"},{"element":"string","content":"html"},{"element":"string","content":"amp_html"},{"element":"string","content":"Header:Subject"}]}}}}},{"element":"member","meta":{"description":{"element":"string","content":"Identifies the line number within the MIME part identified by the part attribute"}},"content":{"key":{"element":"string","content":"line"},"value":{"element":"number"}}}]}},{"element":"dataStructure","content":{"element":"object","meta":{"id":{"element":"string","content":"bbc3653338a68a4eb29d2a2b2b3a7abd"}},"content":[{"element":"member","meta":{"description":{"element":"string","content":"Unique alphanumeric ID used to reference the template. At a minimum, `id` or `name` is required upon creation. It is auto-generated if not provided. Maximum length - 64 bytes"}},"content":{"key":{"element":"string","content":"id"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Editable display name. At a minimum, `id` or `name` is required upon creation. Does not have to be unique. Maximum length - 1024 bytes"}},"content":{"key":{"element":"string","content":"name"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Description of the template. Maximum length - 1024 bytes"}},"content":{"key":{"element":"string","content":"description"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Content that will be used to construct an email. The template language is supported in all content attributes. Maximum length - 5 MB"}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"content"},"value":{"element":"object","content":[{"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 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":"Email address used to compose the email's `From` header. The domain must be a verified sending domain. Can be an object with `name` & `email` attributes: `{ \"name\": \"My Company\", \"email\": \"deals@company.com\" }`."}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"from"},"value":{"element":"enum","attributes":{"enumerations":{"element":"array","content":[{"element":"object"},{"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":"Object containing template options. All template options can be overwritten in a transmission's options."}},"content":{"key":{"element":"string","content":"options"},"value":{"element":"object","content":[{"element":"member","meta":{"description":{"element":"string","content":"Distinguish between transactional and non-transactional messages for unsubscribe and suppression purposes."}},"content":{"key":{"element":"string","content":"transactional"},"value":{"element":"boolean"}}},{"element":"member","meta":{"description":{"element":"string","content":"Enable or disable open tracking."}},"content":{"key":{"element":"string","content":"open_tracking"},"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"}}}]}}},{"element":"member","meta":{"description":{"element":"string","content":"Whether this template can be used by subaccounts. Can only be set if the template belongs to the primary account."}},"content":{"key":{"element":"string","content":"shared_with_subaccounts"},"value":{"element":"boolean"}}}]}},{"element":"dataStructure","content":{"element":"object","meta":{"id":{"element":"string","content":"ac5eef1d0f44d076c12cedc73579d547"}},"content":[{"element":"member","meta":{"description":{"element":"string","content":"Template name. Does not have to be unique. Maximum length - 1024 bytes"}},"content":{"key":{"element":"string","content":"name"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Description of the template. Maximum length - 1024 bytes"}},"content":{"key":{"element":"string","content":"description"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Content that will be used to construct an email. The template language is supported in all content attributes. Maximum length - 5 MB"}},"content":{"key":{"element":"string","content":"content"},"value":{"element":"object","content":[{"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 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":"Email address used to compose the email's `From` header. The domain must be a verified sending domain. Can be an object with `name` & `email` attributes: `{ \"name\": \"My Company\", \"email\": \"deals@company.com\" }`."}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"from"},"value":{"element":"enum","attributes":{"enumerations":{"element":"array","content":[{"element":"object"},{"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":"Object containing template options. All template options can be overwritten in a transmission's options."}},"content":{"key":{"element":"string","content":"options"},"value":{"element":"object","content":[{"element":"member","meta":{"description":{"element":"string","content":"Distinguish between transactional and non-transactional messages for unsubscribe and suppression purposes."}},"content":{"key":{"element":"string","content":"transactional"},"value":{"element":"boolean"}}},{"element":"member","meta":{"description":{"element":"string","content":"Enable or disable open tracking."}},"content":{"key":{"element":"string","content":"open_tracking"},"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"}}}]}}},{"element":"member","meta":{"description":{"element":"string","content":"Whether this template can be used by subaccounts. Can only be set if the template belongs to the primary account. Updating this will update both the published and draft versions."}},"content":{"key":{"element":"string","content":"shared_with_subaccounts"},"value":{"element":"boolean"}}}]}},{"element":"dataStructure","content":{"element":"object","meta":{"id":{"element":"string","content":"6b3fb4fb87ec42c941a330b8bb8bc563"}},"content":[{"element":"member","meta":{"description":{"element":"string","content":"Set to `true` to publish the draft version."}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"published"},"value":{"element":"boolean"}}}]}},{"element":"dataStructure","content":{"element":"object","meta":{"id":{"element":"string","content":"a6172f12f68ffdfc3d7777889a86e751"}},"content":[{"element":"member","meta":{"description":{"element":"string","content":"Template name. Does not have to be unique. Maximum length - 1024 bytes"}},"content":{"key":{"element":"string","content":"name"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Description of the template. Maximum length - 1024 bytes"}},"content":{"key":{"element":"string","content":"description"},"value":{"element":"string"}}},{"element":"member","meta":{"description":{"element":"string","content":"Content that will be used to construct an email. The template language is supported in all content attributes. Maximum length - 5 MB"}},"content":{"key":{"element":"string","content":"content"},"value":{"element":"object","content":[{"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 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":"Email address used to compose the email's `From` header. The domain must be a verified sending domain. Can be an object with `name` & `email` attributes: `{ \"name\": \"My Company\", \"email\": \"deals@company.com\" }`."}},"attributes":{"typeAttributes":{"element":"array","content":[{"element":"string","content":"required"}]}},"content":{"key":{"element":"string","content":"from"},"value":{"element":"enum","attributes":{"enumerations":{"element":"array","content":[{"element":"object"},{"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":"Object containing template options. All template options can be overwritten in a transmission's options."}},"content":{"key":{"element":"string","content":"options"},"value":{"element":"object","content":[{"element":"member","meta":{"description":{"element":"string","content":"Distinguish between transactional and non-transactional messages for unsubscribe and suppression purposes."}},"content":{"key":{"element":"string","content":"transactional"},"value":{"element":"boolean"}}},{"element":"member","meta":{"description":{"element":"string","content":"Enable or disable open tracking."}},"content":{"key":{"element":"string","content":"open_tracking"},"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"}}}]}}},{"element":"member","meta":{"description":{"element":"string","content":"Whether this template can be used by subaccounts. Can only be set if the template belongs to the primary account. Updating this will update both the published and draft versions."}},"content":{"key":{"element":"string","content":"shared_with_subaccounts"},"value":{"element":"boolean"}}}]}},{"element":"dataStructure","content":{"element":"object","meta":{"id":{"element":"string","content":"fef82ca57d5943d9b2842c068a5696c0"}},"content":[{"element":"member","meta":{"description":{"element":"string","content":"Data passed to the template engine."}},"content":{"key":{"element":"string","content":"substitution_data"},"value":{"element":"object"}}}]}},{"element":"dataStructure","content":{"element":"object","meta":{"id":{"element":"string","content":"875656d20eb592fe311747cb27c0f1db"}},"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":10},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":4073},{"element":"number","content":908}]}]}]}},"content":"dangling message-body asset, expected a pre-formatted code block, indent every of it's line by 8 spaces or 2 tabs"},{"element":"annotation","meta":{"classes":{"element":"array","content":[{"element":"string","content":"warning"}]}},"attributes":{"code":{"element":"number","content":10},"sourceMap":{"element":"array","content":[{"element":"sourceMap","content":[{"element":"array","content":[{"element":"number","content":9048},{"element":"number","content":4}]},{"element":"array","content":[{"element":"number","content":9060},{"element":"number","content":24}]},{"element":"array","content":[{"element":"number","content":9092},{"element":"number","content":4}]}]}]}},"content":"message-body asset is expected to be a pre-formatted code block, every of its line indented by exactly 12 spaces or 3 tabs"},{"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":8643},{"element":"number","content":46}]}]}]}},"content":"the resource '/v1/templates/{id}' is already defined"},{"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":12350},{"element":"number","content":51}]}]}]}},"content":"the resource '/v1/templates/{id}' is already defined"},{"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":14774},{"element":"number","content":53}]}]}]}},"content":"the resource '/v1/templates' 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":18034},{"element":"number","content":56}]}]}]}},"content":"ignoring unrecognized type attribute"},{"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":20384},{"element":"number","content":49}]}]}]}},"content":"no value(s) specified"},{"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":20435},{"element":"number","content":48}]}]}]}},"content":"no value(s) specified"},{"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":20485},{"element":"number","content":47}]}]}]}},"content":"no value(s) specified"},{"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":20813},{"element":"number","content":207}]}]}]}},"content":"ignoring unrecognized type attribute"}]},"TableOfContents":[{"anchor":"#templates","title":"Templates","children":[{"anchor":"#header-drafts-&-published-versions","title":"Drafts & Published versions"},{"anchor":"#header-template-object","title":"Template Object"},{"anchor":"#header-header-notes","title":"Header Notes"},{"anchor":"#header-error-object","title":"Error Object"},{"anchor":"#templates-create-a-template","title":"Create a Template","children":[{"anchor":"#templates-post-create-a-template","title":"Create a Template"}]},{"anchor":"#templates-retrieve-a-template","title":"Retrieve a Template","children":[{"anchor":"#templates-get-retrieve-a-template","title":"Retrieve a Template"}]},{"anchor":"#templates-update-a-draft","title":"Update a Draft","children":[{"anchor":"#templates-put-update-a-draft","title":"Update a Draft"}]},{"anchor":"#templates-publish-a-draft","title":"Publish a Draft","children":[{"anchor":"#templates-put-publish-a-draft","title":"Publish a Draft"}]},{"anchor":"#templates-update-a-published-template","title":"Update a Published Template","children":[{"anchor":"#templates-put-update-a-published-template","title":"Update a Published Template"}]},{"anchor":"#templates-preview-a-template","title":"Preview a Template","children":[{"anchor":"#templates-post-preview-a-template","title":"Preview a Template"}]},{"anchor":"#templates-delete-a-template","title":"Delete a Template","children":[{"anchor":"#templates-delete-delete-a-template","title":"Delete a Template"}]},{"anchor":"#templates-list-all-templates","title":"List all Templates","children":[{"anchor":"#templates-get-list-all-templates","title":"List all Templates"}]},{"anchor":"#templates-create-an-rfc-822-template","title":"Create an RFC 822 Template","children":[{"anchor":"#templates-post-create-an-rfc-822-template","title":"Create an RFC 822 Template"}]},{"anchor":"#templates-preview-an-inline-template","title":"Preview an inline Template","children":[{"anchor":"#templates-post-preview-an-inline-template","title":"Preview an inline Template"}]}]}],"meta":{"title":"Templates API","description":"Manage reusable content templates that are run through the SparkPost template engine and can be used when sending messages.","full":false},"fields":{"path":"/api/templates/"}}},"pageContext":{"file":"templates.apib"}},"staticQueryHashes":["1319884646","1428769721","3859448388"]}