{"componentChunkName":"component---src-pages-product-js","path":"/transactional/api/rejects/add-phone-number-to-sms-denylist/","result":{"data":{"productData":{"name":"Mailchimp Transactional","sidenavTitle":"Mailchimp Transactional","firstGuide":{"fields":{"path":"/transactional/guides/quick-start"}},"guides":[{"slug":"quick-start","headline":"Transactional API Quick Start","contentList":[{"title":"At a glance","shouldHideFromSidebar":true},{"title":"Create an account","shouldHideFromSidebar":false},{"title":"Generate your API key","shouldHideFromSidebar":false},{"title":"Install the client library for your language","shouldHideFromSidebar":false},{"title":"Make your first API call","shouldHideFromSidebar":false},{"title":"Next steps","shouldHideFromSidebar":false}]},{"slug":"send-first-email","headline":"Send Your First Transactional Email","contentList":[{"title":"At a glance","shouldHideFromSidebar":true},{"title":"What you’ll need","shouldHideFromSidebar":true},{"title":"Transactional vs Marketing Email","shouldHideFromSidebar":false},{"title":"Add a sending domain","shouldHideFromSidebar":false},{"title":"Configure your DNS","shouldHideFromSidebar":false},{"title":"Verify domain ownership","shouldHideFromSidebar":false},{"title":"Send your first email","shouldHideFromSidebar":false},{"title":"More resources","shouldHideFromSidebar":true}]},{"slug":"send-first-sms","headline":"Send Your First Transactional SMS","contentList":[{"title":"At a glance","shouldHideFromSidebar":true},{"title":"What you'll need","shouldHideFromSidebar":true},{"title":"Create an account","shouldHideFromSidebar":false},{"title":"Setup your API key","shouldHideFromSidebar":false},{"title":"Send your first SMS","shouldHideFromSidebar":false}]},{"slug":"change-behavior-rules-engine","headline":"Change Sending Behavior with the Rules Engine","contentList":[{"title":"At a glance","shouldHideFromSidebar":true},{"title":"What you’ll need","shouldHideFromSidebar":true},{"title":"How rules work","shouldHideFromSidebar":false},{"title":"Create a rule","shouldHideFromSidebar":false},{"title":"Example rules","shouldHideFromSidebar":false},{"title":"Testing your rules","shouldHideFromSidebar":false},{"title":"More resources","shouldHideFromSidebar":true}]},{"slug":"manage-different-users-subaccounts","headline":"Manage Different Users with Subaccounts","contentList":[{"title":"At a glance","shouldHideFromSidebar":true},{"title":"What you’ll need","shouldHideFromSidebar":true},{"title":"Create a subaccount","shouldHideFromSidebar":false},{"title":"Send email from a subaccount","shouldHideFromSidebar":false},{"title":"View subaccount activity","shouldHideFromSidebar":false},{"title":"Update a subaccount’s quota","shouldHideFromSidebar":false},{"title":"Pause and resume sending from a subaccount","shouldHideFromSidebar":false},{"title":"Delete a subaccount","shouldHideFromSidebar":false},{"title":"More resources","shouldHideFromSidebar":true}]},{"slug":"set-up-inbound-email-processing","headline":"Set Up Inbound Email Processing","contentList":[{"title":"At a glance","shouldHideFromSidebar":true},{"title":"What you’ll need","shouldHideFromSidebar":true},{"title":"Add your inbound domain","shouldHideFromSidebar":false},{"title":"Set up your MX records","shouldHideFromSidebar":false},{"title":"Validate your MX records","shouldHideFromSidebar":false},{"title":"Configure your incoming email address and webhook","shouldHideFromSidebar":false},{"title":"Handle parsed emails","shouldHideFromSidebar":false},{"title":"More resources","shouldHideFromSidebar":true}]},{"slug":"track-respond-activity-webhooks","headline":"Track and Respond to Email Activity with Webhooks","contentList":[{"title":"At a glance","shouldHideFromSidebar":true},{"title":"What you’ll need","shouldHideFromSidebar":true},{"title":"Create a new webhook","shouldHideFromSidebar":false},{"title":"Handling the webhook response in your app","shouldHideFromSidebar":false},{"title":"Test the webhook","shouldHideFromSidebar":false},{"title":"Authenticating webhook requests","shouldHideFromSidebar":false},{"title":"More resources","shouldHideFromSidebar":true}]},{"slug":"how-to-use-mailchimps-transactional-messaging-mcp","headline":"How to Use Mailchimp's Transactional Messaging MCP","contentList":[{"title":"What is an MCP?","shouldHideFromSidebar":true},{"title":"What can the MCP do?","shouldHideFromSidebar":true},{"title":"Prerequisites","shouldHideFromSidebar":true},{"title":"How do I set up the MCP?","shouldHideFromSidebar":true},{"title":"Managing MCP Access","shouldHideFromSidebar":true},{"title":"Troubleshooting","shouldHideFromSidebar":true},{"title":"Example Prompts","shouldHideFromSidebar":true}]}],"firstDoc":{"fields":{"path":"/transactional/docs/fundamentals"}},"docs":[{"slug":"fundamentals","headline":"Fundamentals","contentSource":"Contentful","markdownSourceNode":null,"contentList":[{"title":"The basics","shouldHideFromSidebar":false},{"title":"Getting started","shouldHideFromSidebar":false},{"title":"API conventions","shouldHideFromSidebar":false},{"title":"API error codes","shouldHideFromSidebar":false},{"title":"Account features","shouldHideFromSidebar":false},{"title":"Test mode","shouldHideFromSidebar":false},{"title":"Support","shouldHideFromSidebar":false}]},{"slug":"authentication-delivery","headline":"Authentication and Delivery","contentSource":"Contentful","markdownSourceNode":null,"contentList":[{"title":"The basics","shouldHideFromSidebar":false},{"title":"Authentication","shouldHideFromSidebar":false},{"title":"Delivery","shouldHideFromSidebar":false},{"title":"Dedicated IP","shouldHideFromSidebar":false}]},{"slug":"outbound-email","headline":"Outbound Email","contentSource":"Contentful","markdownSourceNode":null,"contentList":[{"title":"The basics","shouldHideFromSidebar":false},{"title":"Multiple recipients","shouldHideFromSidebar":false},{"title":"Scheduling messages","shouldHideFromSidebar":false},{"title":"Resending messages","shouldHideFromSidebar":false},{"title":"Plain text vs HTML","shouldHideFromSidebar":false},{"title":"Inline CSS","shouldHideFromSidebar":false},{"title":"Attachments","shouldHideFromSidebar":false},{"title":"Images","shouldHideFromSidebar":false},{"title":"Unsubscribes","shouldHideFromSidebar":false},{"title":"Troubleshooting","shouldHideFromSidebar":false}]},{"slug":"smtp-integration","headline":"SMTP Integration","contentSource":"Contentful","markdownSourceNode":null,"contentList":[{"title":"The basics","shouldHideFromSidebar":false},{"title":"Send via SMTP with your programming language of choice","shouldHideFromSidebar":false},{"title":"Customize messages with SMTP headers","shouldHideFromSidebar":false}]},{"slug":"reputation-rejections","headline":"Reputation and Rejections","contentSource":"Contentful","markdownSourceNode":null,"contentList":[{"title":"The basics","shouldHideFromSidebar":false},{"title":"Reputation and hourly quota","shouldHideFromSidebar":false},{"title":"Spam complaints","shouldHideFromSidebar":false},{"title":"Bounces","shouldHideFromSidebar":false},{"title":"Unsubscribes","shouldHideFromSidebar":false},{"title":"Reducing spam complaints, bounces, and unsubscribes","shouldHideFromSidebar":false},{"title":"Failed content reviews","shouldHideFromSidebar":false},{"title":"Rejected emails","shouldHideFromSidebar":false}]},{"slug":"activity-reports","headline":"Activity and Reports","contentSource":"Contentful","markdownSourceNode":null,"contentList":[{"title":"The basics","shouldHideFromSidebar":false},{"title":"Open and click tracking","shouldHideFromSidebar":false},{"title":"Google Analytics tracking","shouldHideFromSidebar":false},{"title":"Search Outbound Activity","shouldHideFromSidebar":false},{"title":"Tags and metadata","shouldHideFromSidebar":false},{"title":"Analytics","shouldHideFromSidebar":false},{"title":"Export activity","shouldHideFromSidebar":false}]},{"slug":"tags-metadata","headline":"Tags and Metadata","contentSource":"Contentful","markdownSourceNode":null,"contentList":[{"title":"The basics","shouldHideFromSidebar":false},{"title":"Tags","shouldHideFromSidebar":false},{"title":"Metadata","shouldHideFromSidebar":false}]},{"slug":"templates-dynamic-content","headline":"Templates and Dynamic Content","contentSource":"Contentful","markdownSourceNode":null,"contentList":[{"title":"The basics","shouldHideFromSidebar":false},{"title":"Creating templates","shouldHideFromSidebar":false},{"title":"Test your templates","shouldHideFromSidebar":false},{"title":"Dynamic content","shouldHideFromSidebar":false},{"title":"Handlebars","shouldHideFromSidebar":false},{"title":"Mailchimp merge language","shouldHideFromSidebar":false},{"title":"Editable content areas","shouldHideFromSidebar":false}]},{"slug":"rules-engine","headline":"The Rules Engine","contentSource":"Contentful","markdownSourceNode":null,"contentList":[{"title":"The basics","shouldHideFromSidebar":false},{"title":"Create a rule","shouldHideFromSidebar":false},{"title":"Structuring your rules","shouldHideFromSidebar":false}]},{"slug":"transactional-sms","headline":"Transactional SMS","contentSource":"Contentful","markdownSourceNode":null,"contentList":[{"title":"The basics","shouldHideFromSidebar":false},{"title":"Programs and sending numbers","shouldHideFromSidebar":false},{"title":"SMS contact lists","shouldHideFromSidebar":false},{"title":"Transactional SMS API consent field","shouldHideFromSidebar":false},{"title":"Sending messages","shouldHideFromSidebar":false},{"title":"Unsubscribes","shouldHideFromSidebar":false},{"title":"Tags and metadata","shouldHideFromSidebar":false},{"title":"Subaccounts","shouldHideFromSidebar":false},{"title":"Reporting and analytics","shouldHideFromSidebar":false},{"title":"Webhooks","shouldHideFromSidebar":false},{"title":"Reputation","shouldHideFromSidebar":false}]},{"slug":"subaccounts","headline":"Subaccounts","contentSource":"Contentful","markdownSourceNode":null,"contentList":[{"title":"The basics","shouldHideFromSidebar":false},{"title":"Create a subaccount","shouldHideFromSidebar":false},{"title":"View subaccount activity","shouldHideFromSidebar":false},{"title":"Custom hourly quotas","shouldHideFromSidebar":false},{"title":"Subaccount rejections","shouldHideFromSidebar":false},{"title":"Pause and resume sending","shouldHideFromSidebar":false},{"title":"Delete a subaccount","shouldHideFromSidebar":false}]},{"slug":"webhooks","headline":"Webhooks","contentSource":"Contentful","markdownSourceNode":null,"contentList":[{"title":"The basics","shouldHideFromSidebar":false},{"title":"Add a new webhook","shouldHideFromSidebar":false},{"title":"Test and debug webhooks","shouldHideFromSidebar":false},{"title":"Failed webhook batches","shouldHideFromSidebar":false},{"title":"Detailed webhook format responses","shouldHideFromSidebar":false}]}]},"refNavData":{"nodes":[{"sectionTitle":"Allowlists","sectionAnchor":"allowlists","sectionRoute":"/allowlists","paths":[{"operationId":"postAllowlistsAdd","pathRoute":"/allowlists/add-email-to-allowlist","summary":"Add email to allowlist"},{"operationId":"postAllowlistsList","pathRoute":"/allowlists/list-allowlisted-emails","summary":"List allowlisted emails"},{"operationId":"postAllowlistsDelete","pathRoute":"/allowlists/remove-email-from-allowlist","summary":"Remove email from allowlist"}],"subSections":[]},{"sectionTitle":"Exports","sectionAnchor":"exports","sectionRoute":"/exports","paths":[{"operationId":"postExportsInfo","pathRoute":"/exports/view-export-info","summary":"View export info"},{"operationId":"postExportsList","pathRoute":"/exports/list-exports","summary":"List exports"},{"operationId":"postExportsRejects","pathRoute":"/exports/export-denylist","summary":"Export denylist"},{"operationId":"postExportsWhitelist","pathRoute":"/exports/export-allowlist","summary":"Export Allowlist"},{"operationId":"postExportsAllowlist","pathRoute":"/exports/export-allowlist","summary":"Export Allowlist"},{"operationId":"postExportsActivity","pathRoute":"/exports/export-activity-history","summary":"Export activity history"}],"subSections":[]},{"sectionTitle":"IPs","sectionAnchor":"ips","sectionRoute":"/ips","paths":[{"operationId":"postIpsList","pathRoute":"/ips/list-ip-addresses","summary":"List ip addresses"},{"operationId":"postIpsInfo","pathRoute":"/ips/get-ip-info","summary":"Get ip info"},{"operationId":"postIpsProvision","pathRoute":"/ips/request-additional-ip","summary":"Request additional ip"},{"operationId":"postIpsStartWarmup","pathRoute":"/ips/start-ip-warmup","summary":"Start ip warmup"},{"operationId":"postIpsCancelWarmup","pathRoute":"/ips/cancel-ip-warmup","summary":"Cancel ip warmup"},{"operationId":"postIpsSetPool","pathRoute":"/ips/move-ip-to-different-pool","summary":"Move ip to different pool"},{"operationId":"postIpsDelete","pathRoute":"/ips/delete-ip-address","summary":"Delete ip address"},{"operationId":"postIpsListPools","pathRoute":"/ips/list-ip-pools","summary":"List ip pools"},{"operationId":"postIpsPoolInfo","pathRoute":"/ips/get-ip-pool-info","summary":"Get ip pool info"},{"operationId":"postIpsCreatePool","pathRoute":"/ips/add-ip-pool","summary":"Add ip pool"},{"operationId":"postIpsDeletePool","pathRoute":"/ips/delete-ip-pool","summary":"Delete ip pool"},{"operationId":"postIpsCheckCustomDns","pathRoute":"/ips/test-custom-dns","summary":"Test custom dns"},{"operationId":"postIpsSetCustomDns","pathRoute":"/ips/set-custom-dns","summary":"Set custom dns"}],"subSections":[]},{"sectionTitle":"Inbound","sectionAnchor":"inbound","sectionRoute":"/inbound","paths":[{"operationId":"postInboundDomains","pathRoute":"/inbound/list-inbound-domains","summary":"List inbound domains"},{"operationId":"postInboundAddDomain","pathRoute":"/inbound/add-inbound-domain","summary":"Add inbound domain"},{"operationId":"postInboundCheckDomain","pathRoute":"/inbound/check-domain-settings","summary":"Check domain settings"},{"operationId":"postInboundDeleteDomain","pathRoute":"/inbound/delete-inbound-domain","summary":"Delete inbound domain"},{"operationId":"postInboundRoutes","pathRoute":"/inbound/list-routes","summary":"List routes"},{"operationId":"postInboundAddRoute","pathRoute":"/inbound/add-route","summary":"Add route"},{"operationId":"postInboundUpdateRoute","pathRoute":"/inbound/update-mailbox-route","summary":"Update mailbox route"},{"operationId":"postInboundDeleteRoute","pathRoute":"/inbound/delete-mailbox-route","summary":"Delete mailbox route"},{"operationId":"postInboundSendRaw","pathRoute":"/inbound/send-mime-document","summary":"Send mime document"}],"subSections":[]},{"sectionTitle":"Messages","sectionAnchor":"messages","sectionRoute":"/messages","paths":[{"operationId":"postMessagesSend","pathRoute":"/messages/send-new-message","summary":"Send new message"},{"operationId":"postMessagesSendSms","pathRoute":"/messages/send-sms-message","summary":"Send SMS message"},{"operationId":"postMessagesSendTemplate","pathRoute":"/messages/send-using-message-template","summary":"Send using message template"},{"operationId":"postMessagesSendMcTemplate","pathRoute":"/messages/send-using-mailchimp-template","summary":"Send using Mailchimp template"},{"operationId":"postMessagesSearch","pathRoute":"/messages/search-messages-by-date","summary":"Search messages by date"},{"operationId":"postMessagesSearchTimeSeries","pathRoute":"/messages/search-messages-by-hour","summary":"Search messages by hour"},{"operationId":"postMessagesInfo","pathRoute":"/messages/get-message-info","summary":"Get message info"},{"operationId":"postMessagesContent","pathRoute":"/messages/get-message-content","summary":"Get message content"},{"operationId":"postMessagesParse","pathRoute":"/messages/parse-mime-document","summary":"Parse mime document"},{"operationId":"postMessagesSendRaw","pathRoute":"/messages/send-mime-document","summary":"Send mime document"},{"operationId":"postMessagesListScheduled","pathRoute":"/messages/list-scheduled-emails","summary":"List scheduled emails"},{"operationId":"postMessagesCancelScheduled","pathRoute":"/messages/cancel-scheduled-email","summary":"Cancel scheduled email"},{"operationId":"postMessagesReschedule","pathRoute":"/messages/reschedule-email","summary":"Reschedule email"}],"subSections":[]},{"sectionTitle":"Metadata","sectionAnchor":"metadata","sectionRoute":"/metadata","paths":[{"operationId":"postMetadataList","pathRoute":"/metadata/list-metadata-fields","summary":"List metadata fields"},{"operationId":"postMetadataAdd","pathRoute":"/metadata/add-metadata-field","summary":"Add metadata field"},{"operationId":"postMetadataUpdate","pathRoute":"/metadata/update-metadata-field","summary":"Update metadata field"},{"operationId":"postMetadataDelete","pathRoute":"/metadata/delete-metadata-field","summary":"Delete metadata field"}],"subSections":[]},{"sectionTitle":"Rejects","sectionAnchor":"rejects","sectionRoute":"/rejects","paths":[{"operationId":"postRejectsAdd","pathRoute":"/rejects/add-email-to-denylist","summary":"Add email to denylist"},{"operationId":"postRejectsAddSms","pathRoute":"/rejects/add-phone-number-to-sms-denylist","summary":"Add phone number to SMS denylist"},{"operationId":"postRejectsDelete","pathRoute":"/rejects/delete-email-from-denylist","summary":"Delete email from denylist"},{"operationId":"postRejectsDeleteSms","pathRoute":"/rejects/delete-phone-number-from-sms-denylist","summary":"Delete phone number from SMS denylist"},{"operationId":"postRejectsList","pathRoute":"/rejects/list-denylisted-emails","summary":"List denylisted emails"},{"operationId":"postRejectsListSms","pathRoute":"/rejects/list-sms-denylist-entries","summary":"List SMS denylist entries"}],"subSections":[]},{"sectionTitle":"Senders","sectionAnchor":"senders","sectionRoute":"/senders","paths":[{"operationId":"postSendersList","pathRoute":"/senders/list-account-senders","summary":"List account senders"},{"operationId":"postSendersDomains","pathRoute":"/senders/list-sender-domains","summary":"List sender domains"},{"operationId":"postSendersAddDomain","pathRoute":"/senders/add-sender-domain","summary":"Add sender domain"},{"operationId":"postSendersDeleteDomain","pathRoute":"/senders/delete-sender-domain","summary":"Delete sender domain"},{"operationId":"postSendersCheckDomain","pathRoute":"/senders/check-domain-settings","summary":"Check domain settings"},{"operationId":"postSendersVerifyDomain","pathRoute":"/senders/verify-domain","summary":"Verify domain"},{"operationId":"postSendersInfo","pathRoute":"/senders/get-sender-info","summary":"Get sender info"},{"operationId":"postSendersTimeSeries","pathRoute":"/senders/view-sender-history","summary":"View sender history"}],"subSections":[]},{"sectionTitle":"Subaccounts","sectionAnchor":"subaccounts","sectionRoute":"/subaccounts","paths":[{"operationId":"postSubaccountsList","pathRoute":"/subaccounts/list-subaccounts","summary":"List subaccounts"},{"operationId":"postSubaccountsAdd","pathRoute":"/subaccounts/add-subaccount","summary":"Add subaccount"},{"operationId":"postSubaccountsInfo","pathRoute":"/subaccounts/get-subaccount-info","summary":"Get subaccount info"},{"operationId":"postSubaccountsUpdate","pathRoute":"/subaccounts/update-subaccount","summary":"Update subaccount"},{"operationId":"postSubaccountsDelete","pathRoute":"/subaccounts/delete-subaccount","summary":"Delete subaccount"},{"operationId":"postSubaccountsPause","pathRoute":"/subaccounts/pause-subaccount","summary":"Pause subaccount"},{"operationId":"postSubaccountsResume","pathRoute":"/subaccounts/resume-subaccount","summary":"Resume subaccount"}],"subSections":[]},{"sectionTitle":"Tags","sectionAnchor":"tags","sectionRoute":"/tags","paths":[{"operationId":"postTagsList","pathRoute":"/tags/list-tags","summary":"List tags"},{"operationId":"postTagsDelete","pathRoute":"/tags/delete-tag","summary":"Delete tag"},{"operationId":"postTagsInfo","pathRoute":"/tags/get-tag-info","summary":"Get tag info"},{"operationId":"postTagsTimeSeries","pathRoute":"/tags/view-tag-history","summary":"View tag history"},{"operationId":"postTagsAllTimeSeries","pathRoute":"/tags/view-all-tags-history","summary":"View all tags history"}],"subSections":[]},{"sectionTitle":"Templates","sectionAnchor":"templates","sectionRoute":"/templates","paths":[{"operationId":"postTemplatesAdd","pathRoute":"/templates/add-template","summary":"Add template"},{"operationId":"postTemplatesInfo","pathRoute":"/templates/get-template-info","summary":"Get template info"},{"operationId":"postTemplatesUpdate","pathRoute":"/templates/update-template","summary":"Update template"},{"operationId":"postTemplatesPublish","pathRoute":"/templates/publish-template-content","summary":"Publish template content"},{"operationId":"postTemplatesDelete","pathRoute":"/templates/delete-template","summary":"Delete template"},{"operationId":"postTemplatesList","pathRoute":"/templates/list-templates","summary":"List templates"},{"operationId":"postTemplatesTimeSeries","pathRoute":"/templates/get-template-history","summary":"Get template history"},{"operationId":"postTemplatesRender","pathRoute":"/templates/render-html-template","summary":"Render html template"}],"subSections":[]},{"sectionTitle":"Templates (MC)","sectionAnchor":"mctemplates","sectionRoute":"/mctemplates","paths":[{"operationId":"postMcTemplatesInfo","pathRoute":"/mctemplates/get-mailchimp-template-info","summary":"Get Mailchimp Template info"},{"operationId":"postMcTemplatesList","pathRoute":"/mctemplates/list-mailchimp-transactional-templates","summary":"List Mailchimp Transactional Templates"},{"operationId":"postMcTemplatesTimeSeries","pathRoute":"/mctemplates/get-mailchimp-transactional-template-time-series","summary":"Get Mailchimp Transactional Template Time Series"},{"operationId":"postMcTemplatesRender","pathRoute":"/mctemplates/render-mailchimp-transactional-template","summary":"Render Mailchimp Transactional Template"}],"subSections":[]},{"sectionTitle":"URLs","sectionAnchor":"urls","sectionRoute":"/urls","paths":[{"operationId":"postUrlsAddTrackingDomain","pathRoute":"/urls/add-tracking-domains","summary":"Add tracking domains"},{"operationId":"postUrlsCheckTrackingDomain","pathRoute":"/urls/check-cname-settings","summary":"Check cname settings"},{"operationId":"postUrlsDeleteTrackingDomain","pathRoute":"/urls/delete-tracking-domain","summary":"Delete tracking domain"},{"operationId":"postUrlsTrackingDomains","pathRoute":"/urls/list-tracking-domains","summary":"List tracking domains"}],"subSections":[]},{"sectionTitle":"Users","sectionAnchor":"users","sectionRoute":"/users","paths":[{"operationId":"postUsersInfo","pathRoute":"/users/get-user-info","summary":"Get user info"},{"operationId":"postUsersPing","pathRoute":"/users/ping","summary":"Ping"},{"operationId":"postUsersPing2","pathRoute":"/users/ping-2","summary":"Ping 2"},{"operationId":"postUsersSenders","pathRoute":"/users/list-account-senders","summary":"List account senders"}],"subSections":[]},{"sectionTitle":"Webhooks","sectionAnchor":"webhooks","sectionRoute":"/webhooks","paths":[{"operationId":"postWebhooksList","pathRoute":"/webhooks/list-webhooks","summary":"List webhooks"},{"operationId":"postWebhooksAdd","pathRoute":"/webhooks/add-webhook","summary":"Add webhook"},{"operationId":"postWebhooksInfo","pathRoute":"/webhooks/get-webhook-info","summary":"Get webhook info"},{"operationId":"postWebhooksUpdate","pathRoute":"/webhooks/update-webhook","summary":"Update webhook"},{"operationId":"postWebhooksDelete","pathRoute":"/webhooks/delete-webhook","summary":"Delete webhook"}],"subSections":[]}]},"refData":{"nodes":[{"sectionTitle":"Allowlists","sectionAnchor":"allowlists","sectionDescription":"Add, list, or delete from your Rejection Allowlist.","sectionRoute":"/allowlists","paths":[{"operationId":"postAllowlistsAdd","pathRoute":"/allowlists/add-email-to-allowlist","description":"Adds an email to your email rejection allowlist. If the address is currently on your denylist, that denylist entry will be removed automatically.","summary":"Add email to allowlist","endpoint":"/allowlists/add","verb":"post","tags":["allowlists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.allowlists.add({\n email: \"Erwin_DuBuque78@gmail.com\",\n });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->allowlists->add([\n \"email\" => \"Alexander_Kuphal@hotmail.com\",\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.allowlists.add({\"email\": \"Clovis.Crooks@yahoo.com\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.allowlists.add({ 'email' => 'Urban.Becker86@gmail.com' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/allowlists/add \\\n -d '{\"key\":\"\",\"email\":\"\",\"comment\":\"\"}'"}]},{"operationId":"postAllowlistsList","pathRoute":"/allowlists/list-allowlisted-emails","description":"Retrieves your email rejection allowlist. You can provide an email address or search prefix to limit the results. Returns up to 1000 results.","summary":"List allowlisted emails","endpoint":"/allowlists/list","verb":"post","tags":["allowlists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.allowlists.list();\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->allowlists->list();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.allowlists.list()\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.allowlists.list\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/allowlists/list \\\n -d '{\"key\":\"\",\"email\":\"\"}'"}]},{"operationId":"postAllowlistsDelete","pathRoute":"/allowlists/remove-email-from-allowlist","description":"Removes an email address from the allowlist.","summary":"Remove email from allowlist","endpoint":"/allowlists/delete","verb":"post","tags":["allowlists"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.allowlists.delete({\n email: \"Declan_Reinger95@yahoo.com\",\n });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->allowlists->delete([\n \"email\" => \"Paolo.Hayes45@hotmail.com\",\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.allowlists.delete({\"email\": \"Noble20@gmail.com\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.allowlists.delete({ 'email' => 'Morris_Jenkins@hotmail.com' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/allowlists/delete \\\n -d '{\"key\":\"\",\"email\":\"\"}'"}]}],"subSections":[]},{"sectionTitle":"Exports","sectionAnchor":"exports","sectionDescription":"Start an export, or get information on export jobs in progress.","sectionRoute":"/exports","paths":[{"operationId":"postExportsInfo","pathRoute":"/exports/view-export-info","description":"Returns information about an export job. If the export job's state is 'complete', the returned data will include a URL you can use to fetch the results. Every export job produces a zip archive, but the format of the archive is distinct for each job type. The api calls that initiate exports include more details about the output format for that job type.","summary":"View export info","endpoint":"/exports/info","verb":"post","tags":["exports"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.exports.info({ id: \"id\" });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->exports->info([\"id\" => \"id\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.exports.info({\"id\": \"id\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.exports.info({ 'id' => 'id' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/exports/info \\\n -d '{\"key\":\"\",\"id\":\"\"}'"}]},{"operationId":"postExportsList","pathRoute":"/exports/list-exports","description":"Returns a list of your exports.","summary":"List exports","endpoint":"/exports/list","verb":"post","tags":["exports"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.exports.list();\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->exports->list();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.exports.list()\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.exports.list\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/exports/list \\\n -d '{\"key\":\"\"}'"}]},{"operationId":"postExportsRejects","pathRoute":"/exports/export-denylist","description":"Begins an export of your rejection denylist. The denylist will be exported to a zip archive containing a single file named rejects.csv that includes the following fields: email, reason, detail, created_at, expires_at, last_event_at, expires_at.","summary":"Export denylist","endpoint":"/exports/rejects","verb":"post","tags":["exports"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.exports.rejects();\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->exports->rejects();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.exports.rejects()\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.exports.rejects\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/exports/rejects \\\n -d '{\"key\":\"\",\"notify_email\":\"\"}'"}]},{"operationId":"postExportsWhitelist","pathRoute":"/exports/export-allowlist","description":"Begins an export of your rejection allowlist. The allowlist will be exported to a zip archive containing a single file named allowlist.csv that includes the following fields: email, detail, created_at.","summary":"Export Allowlist","endpoint":"/exports/whitelist","verb":"post","tags":["exports"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.exports.whitelist();\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->exports->whitelist();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.exports.whitelist()\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.exports.whitelist\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/exports/whitelist \\\n -d '{\"key\":\"\",\"notify_email\":\"\"}'"}]},{"operationId":"postExportsAllowlist","pathRoute":"/exports/export-allowlist","description":"Begins an export of your rejection allowlist. The allowlist will be exported to a zip archive containing a single file named allowlist.csv that includes the following fields: email, detail, created_at.","summary":"Export Allowlist","endpoint":"/exports/allowlist","verb":"post","tags":["exports"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.exports.allowlist();\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->exports->allowlist();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.exports.allowlist()\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.exports.allowlist\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/exports/allowlist \\\n -d '{\"key\":\"\",\"notify_email\":\"\"}'"}]},{"operationId":"postExportsActivity","pathRoute":"/exports/export-activity-history","description":"Begins an export of your activity history. The activity will be exported to a zip archive containing a single file named activity.csv in the same format as you would be able to export from your account's activity view. It includes the following fields: Date, Email Address, Sender, Subject, Status, Tags, Opens, Clicks, Bounce Detail. If you have configured any custom metadata fields, they will be included in the exported data.","summary":"Export activity history","endpoint":"/exports/activity","verb":"post","tags":["exports"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.exports.activity();\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->exports->activity();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.exports.activity()\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.exports.activity\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/exports/activity \\\n -d '{\"key\":\"\",\"notify_email\":\"\",\"date_from\":\"\",\"date_to\":\"\",\"tags\":[],\"senders\":[],\"states\":[],\"api_keys\":[]}'"}]}],"subSections":[]},{"sectionTitle":"IPs","sectionAnchor":"ips","sectionDescription":"Request and manage Dedicated IPs for your account, and set up reverse DNS.","sectionRoute":"/ips","paths":[{"operationId":"postIpsList","pathRoute":"/ips/list-ip-addresses","description":"Lists your dedicated IPs.","summary":"List ip addresses","endpoint":"/ips/list","verb":"post","tags":["ips"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.ips.list();\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->ips->list();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.ips.list()\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.ips.list\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/ips/list \\\n -d '{\"key\":\"\"}'"}]},{"operationId":"postIpsInfo","pathRoute":"/ips/get-ip-info","description":"Retrieves information about a single dedicated IP.","summary":"Get ip info","endpoint":"/ips/info","verb":"post","tags":["ips"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.ips.info();\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->ips->info();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.ips.info()\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.ips.info\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/ips/info \\\n -d '{\"key\":\"\",\"ip\":\"\"}'"}]},{"operationId":"postIpsProvision","pathRoute":"/ips/request-additional-ip","description":"Requests an additional dedicated IP for your account. Accounts may have one outstanding request at any time, and provisioning requests are processed within 24 hours.","summary":"Request additional ip","endpoint":"/ips/provision","verb":"post","tags":["ips"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.ips.provision();\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->ips->provision();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.ips.provision()\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.ips.provision\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/ips/provision \\\n -d '{\"key\":\"\",\"warmup\":false,\"pool\":\"\"}'"}]},{"operationId":"postIpsStartWarmup","pathRoute":"/ips/start-ip-warmup","description":"Begins the warmup process for a dedicated IP. During the warmup process, the Transactional API will gradually increase the percentage of your mail that is sent over the warming-up IP, over a period of roughly 30 days. The rest of your mail will be sent over shared IPs or other dedicated IPs in the same pool.","summary":"Start ip warmup","endpoint":"/ips/start-warmup","verb":"post","tags":["ips"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.ips.startWarmup({ ip: \"ip\" });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->ips->startWarmup([\"ip\" => \"ip\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.ips.start_warmup({\"ip\": \"ip\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.ips.start_warmup({ 'ip' => 'ip' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/ips/start-warmup \\\n -d '{\"key\":\"\",\"ip\":\"\"}'"}]},{"operationId":"postIpsCancelWarmup","pathRoute":"/ips/cancel-ip-warmup","description":"Cancels the warmup process for a dedicated IP.","summary":"Cancel ip warmup","endpoint":"/ips/cancel-warmup","verb":"post","tags":["ips"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.ips.cancelWarmup({ ip: \"ip\" });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->ips->cancelWarmup([\"ip\" => \"ip\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.ips.cancel_warmup({\"ip\": \"ip\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.ips.cancel_warmup({ 'ip' => 'ip' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/ips/cancel-warmup \\\n -d '{\"key\":\"\",\"ip\":\"\"}'"}]},{"operationId":"postIpsSetPool","pathRoute":"/ips/move-ip-to-different-pool","description":"Moves a dedicated IP to a different pool.","summary":"Move ip to different pool","endpoint":"/ips/set-pool","verb":"post","tags":["ips"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.ips.setPool({\n ip: \"ip\",\n pool: \"pool\",\n });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->ips->setPool([\"ip\" => \"ip\", \"pool\" => \"pool\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.ips.set_pool({\"ip\": \"ip\", \"pool\": \"pool\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.ips.set_pool({ 'ip' => 'ip', 'pool' => 'pool' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/ips/set-pool \\\n -d '{\"key\":\"\",\"ip\":\"\",\"pool\":\"\",\"create_pool\":false}'"}]},{"operationId":"postIpsDelete","pathRoute":"/ips/delete-ip-address","description":"Deletes a dedicated IP. This is permanent and cannot be undone.","summary":"Delete ip address","endpoint":"/ips/delete","verb":"post","tags":["ips"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.ips.delete({ ip: \"ip\" });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->ips->delete([\"ip\" => \"ip\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.ips.delete({\"ip\": \"ip\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.ips.delete({ 'ip' => 'ip' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/ips/delete \\\n -d '{\"key\":\"\",\"ip\":\"\"}'"}]},{"operationId":"postIpsListPools","pathRoute":"/ips/list-ip-pools","description":"Lists your dedicated IP pools.","summary":"List ip pools","endpoint":"/ips/list-pools","verb":"post","tags":["ips"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.ips.listPools();\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->ips->listPools();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.ips.list_pools()\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.ips.list_pools\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/ips/list-pools \\\n -d '{\"key\":\"\"}'"}]},{"operationId":"postIpsPoolInfo","pathRoute":"/ips/get-ip-pool-info","description":"Describes a single dedicated IP pool.","summary":"Get ip pool info","endpoint":"/ips/pool-info","verb":"post","tags":["ips"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.ips.poolInfo({ pool: \"pool\" });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->ips->poolInfo([\"pool\" => \"pool\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.ips.pool_info({\"pool\": \"pool\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.ips.pool_info({ 'pool' => 'pool' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/ips/pool-info \\\n -d '{\"key\":\"\",\"pool\":\"\"}'"}]},{"operationId":"postIpsCreatePool","pathRoute":"/ips/add-ip-pool","description":"Creates a pool and returns it. If a pool already exists with this name, no action will be performed.","summary":"Add ip pool","endpoint":"/ips/create-pool","verb":"post","tags":["ips"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.ips.createPool({ pool: \"pool\" });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->ips->createPool([\"pool\" => \"pool\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.ips.create_pool({\"pool\": \"pool\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.ips.create_pool({ 'pool' => 'pool' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/ips/create-pool \\\n -d '{\"key\":\"\",\"pool\":\"\"}'"}]},{"operationId":"postIpsDeletePool","pathRoute":"/ips/delete-ip-pool","description":"Deletes a pool. A pool must be empty before you can delete it, and you cannot delete your default pool.","summary":"Delete ip pool","endpoint":"/ips/delete-pool","verb":"post","tags":["ips"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.ips.deletePool({ pool: \"pool\" });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->ips->deletePool([\"pool\" => \"pool\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.ips.delete_pool({\"pool\": \"pool\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.ips.delete_pool({ 'pool' => 'pool' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/ips/delete-pool \\\n -d '{\"key\":\"\",\"pool\":\"\"}'"}]},{"operationId":"postIpsCheckCustomDns","pathRoute":"/ips/test-custom-dns","description":"Tests whether a domain name is valid for use as the custom reverse DNS for a dedicated IP.","summary":"Test custom dns","endpoint":"/ips/check-custom-dns","verb":"post","tags":["ips"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.ips.checkCustomDns({\n ip: \"ip\",\n domain: \"domain\",\n });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->ips->checkCustomDns([\n \"ip\" => \"ip\",\n \"domain\" => \"domain\",\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.ips.check_custom_dns({\"ip\": \"ip\", \"domain\": \"domain\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.ips.check_custom_dns({ 'ip' => 'ip', 'domain' => 'domain' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/ips/check-custom-dns \\\n -d '{\"key\":\"\",\"ip\":\"\",\"domain\":\"\"}'"}]},{"operationId":"postIpsSetCustomDns","pathRoute":"/ips/set-custom-dns","description":"Configures the custom DNS name for a dedicated IP.","summary":"Set custom dns","endpoint":"/ips/set-custom-dns","verb":"post","tags":["ips"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.ips.setCustomDns({\n ip: \"ip\",\n domain: \"domain\",\n });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->ips->setCustomDns([\"ip\" => \"ip\", \"domain\" => \"domain\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.ips.set_custom_dns({\"ip\": \"ip\", \"domain\": \"domain\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.ips.set_custom_dns({ 'ip' => 'ip', 'domain' => 'domain' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/ips/set-custom-dns \\\n -d '{\"key\":\"\",\"ip\":\"\",\"domain\":\"\"}'"}]}],"subSections":[]},{"sectionTitle":"Inbound","sectionAnchor":"inbound","sectionDescription":"Manage your inbound domains and routes.","sectionRoute":"/inbound","paths":[{"operationId":"postInboundDomains","pathRoute":"/inbound/list-inbound-domains","description":"List the domains that have been configured for inbound delivery.","summary":"List inbound domains","endpoint":"/inbound/domains","verb":"post","tags":["inbound"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.inbound.domains();\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->inbound->domains();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.inbound.domains()\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.inbound.domains\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/inbound/domains \\\n -d '{\"key\":\"\"}'"}]},{"operationId":"postInboundAddDomain","pathRoute":"/inbound/add-inbound-domain","description":"Add an inbound domain to your account.","summary":"Add inbound domain","endpoint":"/inbound/add-domain","verb":"post","tags":["inbound"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.inbound.addDomain({\n domain: \"domain\",\n });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->inbound->addDomain([\"domain\" => \"domain\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.inbound.add_domain({\"domain\": \"domain\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.inbound.add_domain({ 'domain' => 'domain' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/inbound/add-domain \\\n -d '{\"key\":\"\",\"domain\":\"\"}'"}]},{"operationId":"postInboundCheckDomain","pathRoute":"/inbound/check-domain-settings","description":"Check the MX settings for an inbound domain. The domain must have already been added with the add-domain call.","summary":"Check domain settings","endpoint":"/inbound/check-domain","verb":"post","tags":["inbound"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.inbound.checkDomain({\n domain: \"domain\",\n });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->inbound->checkDomain([\"domain\" => \"domain\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.inbound.check_domain({\"domain\": \"domain\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.inbound.check_domain({ 'domain' => 'domain' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/inbound/check-domain \\\n -d '{\"key\":\"\",\"domain\":\"\"}'"}]},{"operationId":"postInboundDeleteDomain","pathRoute":"/inbound/delete-inbound-domain","description":"Delete an inbound domain from the account. All mail will stop routing for this domain immediately.","summary":"Delete inbound domain","endpoint":"/inbound/delete-domain","verb":"post","tags":["inbound"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.inbound.deleteDomain({\n domain: \"domain\",\n });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->inbound->deleteDomain([\"domain\" => \"domain\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.inbound.delete_domain({\"domain\": \"domain\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.inbound.delete_domain({ 'domain' => 'domain' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/inbound/delete-domain \\\n -d '{\"key\":\"\",\"domain\":\"\"}'"}]},{"operationId":"postInboundRoutes","pathRoute":"/inbound/list-routes","description":"List the routes defined for an inbound domain or SMS program. Provide either domain or phone (not both).","summary":"List routes","endpoint":"/inbound/routes","verb":"post","tags":["inbound"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.inbound.routes();\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->inbound->routes();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.inbound.routes()\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.inbound.routes\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/inbound/routes \\\n -d '{\"key\":\"\",\"domain\":\"\",\"phone\":\"\"}'"}]},{"operationId":"postInboundAddRoute","pathRoute":"/inbound/add-route","description":"Add a new route to an inbound domain or SMS program. Provide either domain or phone (not both).","summary":"Add route","endpoint":"/inbound/add-route","verb":"post","tags":["inbound"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.inbound.addRoute({\n url: \"http://jada.org\",\n });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->inbound->addRoute([\"url\" => \"https://sonya.name\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.inbound.add_route({\"url\": \"https://harmon.org\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.inbound.add_route({ 'url' => 'http://elsie.org' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/inbound/add-route \\\n -d '{\"key\":\"\",\"domain\":\"\",\"phone\":\"\",\"pattern\":\"\",\"url\":\"\"}'"}]},{"operationId":"postInboundUpdateRoute","pathRoute":"/inbound/update-mailbox-route","description":"Update the pattern or webhook of an existing inbound mailbox route. If null is provided for any fields, the values will remain unchanged.","summary":"Update mailbox route","endpoint":"/inbound/update-route","verb":"post","tags":["inbound"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.inbound.updateRoute({ id: \"id\" });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->inbound->updateRoute([\"id\" => \"id\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.inbound.update_route({\"id\": \"id\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.inbound.update_route({ 'id' => 'id' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/inbound/update-route \\\n -d '{\"key\":\"\",\"id\":\"\",\"pattern\":\"\",\"url\":\"\"}'"}]},{"operationId":"postInboundDeleteRoute","pathRoute":"/inbound/delete-mailbox-route","description":"Delete an existing inbound mailbox route.","summary":"Delete mailbox route","endpoint":"/inbound/delete-route","verb":"post","tags":["inbound"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.inbound.deleteRoute({ id: \"id\" });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->inbound->deleteRoute([\"id\" => \"id\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.inbound.delete_route({\"id\": \"id\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.inbound.delete_route({ 'id' => 'id' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/inbound/delete-route \\\n -d '{\"key\":\"\",\"id\":\"\"}'"}]},{"operationId":"postInboundSendRaw","pathRoute":"/inbound/send-mime-document","description":"Take a raw MIME document destined for a domain with inbound domains set up, and send it to the inbound hook exactly as if it had been sent over SMTP.","summary":"Send mime document","endpoint":"/inbound/send-raw","verb":"post","tags":["inbound"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.inbound.sendRaw({\n raw_message: \"raw_message\",\n });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->inbound->sendRaw([\"raw_message\" => \"raw_message\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.inbound.send_raw({\"raw_message\": \"raw_message\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.inbound.send_raw({ 'raw_message' => 'raw_message' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/inbound/send-raw \\\n -d '{\"key\":\"\",\"raw_message\":\"\",\"to\":[],\"mail_from\":\"\",\"helo\":\"\",\"client_address\":\"\"}'"}]}],"subSections":[]},{"sectionTitle":"Messages","sectionAnchor":"messages","sectionDescription":"Send, schedule, or get information on your emails.","sectionRoute":"/messages","paths":[{"operationId":"postMessagesSend","pathRoute":"/messages/send-new-message","description":"Send a new transactional message through the Transactional API.","summary":"Send new message","endpoint":"/messages/send","verb":"post","tags":["messages"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.messages.send({ message: {} });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->messages->send([\"message\" => []]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.messages.send({\"message\": {}})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.messages.send({ 'message' => {} })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/messages/send \\\n -d '{\"key\":\"\",\"message\":{\"html\":\"\",\"text\":\"\",\"subject\":\"\",\"from_email\":\"\",\"from_name\":\"\",\"to\":[],\"headers\":{},\"important\":false,\"track_opens\":false,\"track_clicks\":false,\"auto_text\":false,\"auto_html\":false,\"inline_css\":false,\"url_strip_qs\":false,\"preserve_recipients\":false,\"view_content_link\":false,\"bcc_address\":\"\",\"tracking_domain\":\"\",\"signing_domain\":\"\",\"return_path_domain\":\"\",\"merge\":false,\"merge_language\":\"mailchimp\",\"global_merge_vars\":[],\"merge_vars\":[],\"tags\":[],\"subaccount\":\"\",\"google_analytics_domains\":[],\"google_analytics_campaign\":\"\",\"metadata\":{\"website\":\"\"},\"recipient_metadata\":[],\"attachments\":[],\"images\":[]},\"async\":false,\"ip_pool\":\"\",\"send_at\":\"\"}'"}]},{"operationId":"postMessagesSendSms","pathRoute":"/messages/send-sms-message","description":"Send a new SMS message through Mandrill","summary":"Send SMS message","endpoint":"/messages/send-sms","verb":"post","tags":["messages"],"deprecated":null,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.messages.sendSms({ message: {} });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->messages->sendSms([\"message\" => []]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.messages.send_sms({\"message\": {}})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.messages.send_sms({ 'message' => {} })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/messages/send-sms \\\n -d '{\"key\":\"\",\"message\":{\"sms\":{\"text\":\"\",\"to\":[],\"from\":\"\",\"consent\":\"onetime\",\"track_clicks\":false}},\"async\":false}'"}]},{"operationId":"postMessagesSendTemplate","pathRoute":"/messages/send-using-message-template","description":"Send a new transactional message through the Transactional API using a template.","summary":"Send using message template","endpoint":"/messages/send-template","verb":"post","tags":["messages"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.messages.sendTemplate({\n template_name: \"template_name\",\n template_content: [{}],\n message: {},\n });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->messages->sendTemplate([\n \"template_name\" => \"template_name\",\n \"template_content\" => [[]],\n \"message\" => [],\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.messages.send_template({\"template_name\": \"template_name\", \"template_content\": [{}], \"message\": {}})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result =\n client.messages.send_template(\n {\n 'template_name' => 'template_name',\n 'template_content' => [{}],\n 'message' => {}\n }\n )\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/messages/send-template \\\n -d '{\"key\":\"\",\"template_name\":\"\",\"template_content\":[],\"message\":{\"html\":\"\",\"text\":\"\",\"subject\":\"\",\"from_email\":\"\",\"from_name\":\"\",\"to\":[],\"headers\":{},\"important\":false,\"track_opens\":false,\"track_clicks\":false,\"auto_text\":false,\"auto_html\":false,\"inline_css\":false,\"url_strip_qs\":false,\"preserve_recipients\":false,\"view_content_link\":false,\"bcc_address\":\"\",\"tracking_domain\":\"\",\"signing_domain\":\"\",\"return_path_domain\":\"\",\"merge\":false,\"merge_language\":\"mailchimp\",\"global_merge_vars\":[],\"merge_vars\":[],\"tags\":[],\"subaccount\":\"\",\"google_analytics_domains\":[],\"google_analytics_campaign\":\"\",\"metadata\":{\"website\":\"\"},\"recipient_metadata\":[],\"attachments\":[],\"images\":[]},\"async\":false,\"ip_pool\":\"\",\"send_at\":\"\"}'"}]},{"operationId":"postMessagesSendMcTemplate","pathRoute":"/messages/send-using-mailchimp-template","description":"Send a new transactional message through Mandrill using a Mailchimp Transactional template.","summary":"Send using Mailchimp template","endpoint":"/messages/send-mc-template","verb":"post","tags":["messages"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.messages.sendMcTemplate({\n mc_template_id: 96274,\n message: {},\n });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->messages->sendMcTemplate([\n \"mc_template_id\" => 93635,\n \"message\" => [],\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.messages.send_mc_template({\"mc_template_id\": 25818, \"message\": {}})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result =\n client.messages.send_mc_template(\n { 'mc_template_id' => 80_195, 'message' => {} }\n )\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/messages/send-mc-template \\\n -d '{\"key\":\"\",\"mc_template_id\":0,\"mc_template_version\":\"draft\",\"message\":{\"html\":\"\",\"text\":\"\",\"subject\":\"\",\"from_email\":\"\",\"from_name\":\"\",\"to\":[],\"headers\":{},\"important\":false,\"track_opens\":false,\"track_clicks\":false,\"auto_text\":false,\"auto_html\":false,\"inline_css\":false,\"url_strip_qs\":false,\"preserve_recipients\":false,\"view_content_link\":false,\"bcc_address\":\"\",\"tracking_domain\":\"\",\"signing_domain\":\"\",\"return_path_domain\":\"\",\"merge\":false,\"merge_language\":\"mailchimp\",\"global_merge_vars\":[],\"merge_vars\":[],\"tags\":[],\"subaccount\":\"\",\"google_analytics_domains\":[],\"google_analytics_campaign\":\"\",\"metadata\":{\"website\":\"\"},\"recipient_metadata\":[],\"attachments\":[],\"images\":[]},\"async\":false,\"ip_pool\":\"\",\"send_at\":\"\"}'"}]},{"operationId":"postMessagesSearch","pathRoute":"/messages/search-messages-by-date","description":"Search recently sent messages and optionally narrow by date range, tags, senders, and API keys. If no date range is specified, results within the last 7 days are returned. This method may be called up to 20 times per minute. If you need the data more often, you can use /messages/info.json to get the information for a single message, or webhooks to push activity to your own application for querying.","summary":"Search messages by date","endpoint":"/messages/search","verb":"post","tags":["messages"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.messages.search();\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->messages->search();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.messages.search()\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.messages.search\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/messages/search \\\n -d '{\"key\":\"\",\"query\":\"\",\"date_from\":\"\",\"date_to\":\"\",\"tags\":[],\"senders\":[],\"api_keys\":[],\"limit\":0}'"}]},{"operationId":"postMessagesSearchTimeSeries","pathRoute":"/messages/search-messages-by-hour","description":"Search the content of recently sent messages and return the aggregated hourly stats for matching messages.","summary":"Search messages by hour","endpoint":"/messages/search-time-series","verb":"post","tags":["messages"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.messages.searchTimeSeries();\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->messages->searchTimeSeries();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.messages.search_time_series()\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.messages.search_time_series\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/messages/search-time-series \\\n -d '{\"key\":\"\",\"query\":\"\",\"date_from\":\"\",\"date_to\":\"\",\"tags\":[],\"senders\":[]}'"}]},{"operationId":"postMessagesInfo","pathRoute":"/messages/get-message-info","description":"Get the information for a single recently sent message.","summary":"Get message info","endpoint":"/messages/info","verb":"post","tags":["messages"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.messages.info({ id: \"id\" });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->messages->info([\"id\" => \"id\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.messages.info({\"id\": \"id\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.messages.info({ 'id' => 'id' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/messages/info \\\n -d '{\"key\":\"\",\"id\":\"\"}'"}]},{"operationId":"postMessagesContent","pathRoute":"/messages/get-message-content","description":"Get the full content of a recently sent message.","summary":"Get message content","endpoint":"/messages/content","verb":"post","tags":["messages"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.messages.content({ id: \"id\" });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->messages->content([\"id\" => \"id\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.messages.content({\"id\": \"id\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.messages.content({ 'id' => 'id' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/messages/content \\\n -d '{\"key\":\"\",\"id\":\"\"}'"}]},{"operationId":"postMessagesParse","pathRoute":"/messages/parse-mime-document","description":"Parse the full MIME document for an email message, returning the content of the message broken into its constituent pieces.","summary":"Parse mime document","endpoint":"/messages/parse","verb":"post","tags":["messages"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.messages.parse({\n raw_message: \"raw_message\",\n });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->messages->parse([\"raw_message\" => \"raw_message\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.messages.parse({\"raw_message\": \"raw_message\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.messages.parse({ 'raw_message' => 'raw_message' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/messages/parse \\\n -d '{\"key\":\"\",\"raw_message\":\"\"}'"}]},{"operationId":"postMessagesSendRaw","pathRoute":"/messages/send-mime-document","description":"Take a raw MIME document for a message, and send it exactly as if it were sent through the Transactional API's SMTP servers.","summary":"Send mime document","endpoint":"/messages/send-raw","verb":"post","tags":["messages"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.messages.sendRaw({\n raw_message: \"raw_message\",\n });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->messages->sendRaw([\"raw_message\" => \"raw_message\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.messages.send_raw({\"raw_message\": \"raw_message\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.messages.send_raw({ 'raw_message' => 'raw_message' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/messages/send-raw \\\n -d '{\"key\":\"\",\"raw_message\":\"\",\"from_email\":\"\",\"from_name\":\"\",\"to\":[],\"async\":false,\"ip_pool\":\"\",\"send_at\":\"\",\"return_path_domain\":\"\"}'"}]},{"operationId":"postMessagesListScheduled","pathRoute":"/messages/list-scheduled-emails","description":"Queries your scheduled emails.","summary":"List scheduled emails","endpoint":"/messages/list-scheduled","verb":"post","tags":["messages"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.messages.listScheduled();\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->messages->listScheduled();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.messages.list_scheduled()\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.messages.list_scheduled\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/messages/list-scheduled \\\n -d '{\"key\":\"\",\"to\":\"\"}'"}]},{"operationId":"postMessagesCancelScheduled","pathRoute":"/messages/cancel-scheduled-email","description":"Cancels a scheduled email.","summary":"Cancel scheduled email","endpoint":"/messages/cancel-scheduled","verb":"post","tags":["messages"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.messages.cancelScheduled({ id: \"id\" });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->messages->cancelScheduled([\"id\" => \"id\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.messages.cancel_scheduled({\"id\": \"id\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.messages.cancel_scheduled({ 'id' => 'id' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/messages/cancel-scheduled \\\n -d '{\"key\":\"\",\"id\":\"\"}'"}]},{"operationId":"postMessagesReschedule","pathRoute":"/messages/reschedule-email","description":"Reschedules a scheduled email.","summary":"Reschedule email","endpoint":"/messages/reschedule","verb":"post","tags":["messages"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.messages.reschedule({\n id: \"id\",\n send_at: \"2026-04-09T14:21:53.934Z\",\n });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->messages->reschedule([\n \"id\" => \"id\",\n \"send_at\" => \"2026-04-09T14:21:53.941Z\",\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.messages.reschedule({\"id\": \"id\", \"send_at\": \"2026-04-09T14:21:53.943Z\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result =\n client.messages.reschedule(\n { 'id' => 'id', 'send_at' => '2026-04-09T14:21:53.943Z' }\n )\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/messages/reschedule \\\n -d '{\"key\":\"\",\"id\":\"\",\"send_at\":\"\"}'"}]}],"subSections":[]},{"sectionTitle":"Metadata","sectionAnchor":"metadata","sectionDescription":"Manage your custom metadata fields in your account.","sectionRoute":"/metadata","paths":[{"operationId":"postMetadataList","pathRoute":"/metadata/list-metadata-fields","description":"Get the list of custom metadata fields indexed for the account.","summary":"List metadata fields","endpoint":"/metadata/list","verb":"post","tags":["metadata"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.metadata.list();\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->metadata->list();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.metadata.list()\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.metadata.list\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/metadata/list \\\n -d '{\"key\":\"\"}'"}]},{"operationId":"postMetadataAdd","pathRoute":"/metadata/add-metadata-field","description":"Add a new custom metadata field to be indexed for the account.","summary":"Add metadata field","endpoint":"/metadata/add","verb":"post","tags":["metadata"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.metadata.add({ name: \"name\" });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->metadata->add([\"name\" => \"name\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.metadata.add({\"name\": \"name\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.metadata.add({ 'name' => 'name' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/metadata/add \\\n -d '{\"key\":\"\",\"name\":\"\",\"view_template\":\"\"}'"}]},{"operationId":"postMetadataUpdate","pathRoute":"/metadata/update-metadata-field","description":"Update an existing custom metadata field.","summary":"Update metadata field","endpoint":"/metadata/update","verb":"post","tags":["metadata"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.metadata.update({\n name: \"name\",\n view_template: \"view_template\",\n });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->metadata->update([\n \"name\" => \"name\",\n \"view_template\" => \"view_template\",\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.metadata.update({\"name\": \"name\", \"view_template\": \"view_template\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result =\n client.metadata.update(\n { 'name' => 'name', 'view_template' => 'view_template' }\n )\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/metadata/update \\\n -d '{\"key\":\"\",\"name\":\"\",\"view_template\":\"\"}'"}]},{"operationId":"postMetadataDelete","pathRoute":"/metadata/delete-metadata-field","description":"Delete an existing custom metadata field. Deletion isn't instataneous, and /metadata/list will continue to return the field until the asynchronous deletion process is complete.","summary":"Delete metadata field","endpoint":"/metadata/delete","verb":"post","tags":["metadata"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.metadata.delete({ name: \"name\" });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->metadata->delete([\"name\" => \"name\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.metadata.delete({\"name\": \"name\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.metadata.delete({ 'name' => 'name' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/metadata/delete \\\n -d '{\"key\":\"\",\"name\":\"\"}'"}]}],"subSections":[]},{"sectionTitle":"Rejects","sectionAnchor":"rejects","sectionDescription":"Add, list, or delete from your Rejection Denylist.","sectionRoute":"/rejects","paths":[{"operationId":"postRejectsAdd","pathRoute":"/rejects/add-email-to-denylist","description":"Adds an email to your email rejection denylist. Addresses that you add manually will never expire and there is no reputation penalty for removing them from your denylist. Attempting to denylist an address that has been added to the allowlist will have no effect.","summary":"Add email to denylist","endpoint":"/rejects/add","verb":"post","tags":["rejects"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.rejects.add({\n email: \"Dalton16@gmail.com\",\n });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->rejects->add([\"email\" => \"Sydney_Lindgren@gmail.com\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.rejects.add({\"email\": \"Clifton41@yahoo.com\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.rejects.add({ 'email' => 'Luther.Torp43@gmail.com' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/rejects/add \\\n -d '{\"key\":\"\",\"email\":\"\",\"comment\":\"\",\"subaccount\":\"\"}'"}]},{"operationId":"postRejectsAddSms","pathRoute":"/rejects/add-phone-number-to-sms-denylist","description":"Adds a phone number to your SMS rejection denylist. Phone numbers that you add manually will never expire and there is no reputation penalty for removing them from your denylist.","summary":"Add phone number to SMS denylist","endpoint":"/rejects/add-sms","verb":"post","tags":["rejects"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.rejects.addSms({\n phone: \"+12025551234\",\n });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->rejects->addSms([\"phone\" => \"+12025551234\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.rejects.add_sms({\"phone\": \"+12025551234\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.rejects.add_sms({ 'phone' => '+12025551234' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/rejects/add-sms \\\n -d '{\"key\":\"\",\"phone\":\"\",\"comment\":\"\",\"subaccount\":\"\"}'"}]},{"operationId":"postRejectsDelete","pathRoute":"/rejects/delete-email-from-denylist","description":"Deletes an email rejection. There is no limit to how many rejections you can remove from your denylist, but keep in mind that each deletion has an affect on your reputation.","summary":"Delete email from denylist","endpoint":"/rejects/delete","verb":"post","tags":["rejects"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.rejects.delete({\n email: \"Jovani95@yahoo.com\",\n });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->rejects->delete([\"email\" => \"Korey66@gmail.com\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.rejects.delete({\"email\": \"Kelly_Jacobs@yahoo.com\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.rejects.delete({ 'email' => 'Celestine79@hotmail.com' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/rejects/delete \\\n -d '{\"key\":\"\",\"email\":\"\",\"subaccount\":\"\"}'"}]},{"operationId":"postRejectsDeleteSms","pathRoute":"/rejects/delete-phone-number-from-sms-denylist","description":"Deletes an SMS rejection. There is no limit to how many rejections you can remove from your denylist, but keep in mind that each deletion has an affect on your reputation.","summary":"Delete phone number from SMS denylist","endpoint":"/rejects/delete-sms","verb":"post","tags":["rejects"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.rejects.deleteSms({\n phone: \"+12025551234\",\n });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->rejects->deleteSms([\"phone\" => \"+12025551234\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.rejects.delete_sms({\"phone\": \"+12025551234\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.rejects.delete_sms({ 'phone' => '+12025551234' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/rejects/delete-sms \\\n -d '{\"key\":\"\",\"phone\":\"\",\"subaccount\":\"\"}'"}]},{"operationId":"postRejectsList","pathRoute":"/rejects/list-denylisted-emails","description":"Retrieves your email rejection denylist. You can provide an email address to limit the results. Returns up to 1000 results. By default, entries that have expired are excluded from the results; set include_expired to true to include them.","summary":"List denylisted emails","endpoint":"/rejects/list","verb":"post","tags":["rejects"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.rejects.list();\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->rejects->list();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.rejects.list()\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.rejects.list\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/rejects/list \\\n -d '{\"key\":\"\",\"email\":\"\",\"include_expired\":false,\"subaccount\":\"\"}'"}]},{"operationId":"postRejectsListSms","pathRoute":"/rejects/list-sms-denylist-entries","description":"Retrieves your SMS rejection denylist. You can provide a phone number to limit the results. Returns up to 1000 results. By default, entries that have expired are excluded from the results; set include_expired to true to include them.","summary":"List SMS denylist entries","endpoint":"/rejects/list-sms","verb":"post","tags":["rejects"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.rejects.listSms();\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->rejects->listSms();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.rejects.list_sms()\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.rejects.list_sms\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/rejects/list-sms \\\n -d '{\"key\":\"\",\"phone\":\"\",\"include_expired\":false,\"subaccount\":\"\"}'"}]}],"subSections":[]},{"sectionTitle":"Senders","sectionAnchor":"senders","sectionDescription":"Manage or get information about your sending domains.","sectionRoute":"/senders","paths":[{"operationId":"postSendersList","pathRoute":"/senders/list-account-senders","description":"Return the senders that have tried to use this account.","summary":"List account senders","endpoint":"/senders/list","verb":"post","tags":["senders"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.senders.list();\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->senders->list();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.senders.list()\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.senders.list\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/senders/list \\\n -d '{\"key\":\"\"}'"}]},{"operationId":"postSendersDomains","pathRoute":"/senders/list-sender-domains","description":"Returns the sender domains that have been added to this account.","summary":"List sender domains","endpoint":"/senders/domains","verb":"post","tags":["senders"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.senders.domains();\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->senders->domains();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.senders.domains()\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.senders.domains\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/senders/domains \\\n -d '{\"key\":\"\"}'"}]},{"operationId":"postSendersAddDomain","pathRoute":"/senders/add-sender-domain","description":"Adds a sender domain to your account. Sender domains are added automatically as you send, but you can use this call to add them ahead of time.","summary":"Add sender domain","endpoint":"/senders/add-domain","verb":"post","tags":["senders"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.senders.addDomain({\n domain: \"domain\",\n });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->senders->addDomain([\"domain\" => \"domain\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.senders.add_domain({\"domain\": \"domain\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.senders.add_domain({ 'domain' => 'domain' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/senders/add-domain \\\n -d '{\"key\":\"\",\"domain\":\"\"}'"}]},{"operationId":"postSendersDeleteDomain","pathRoute":"/senders/delete-sender-domain","description":"Deletes an unverified sender domain from your account. Verified domains cannot be deleted via API and require login confirmation.","summary":"Delete sender domain","endpoint":"/senders/delete-domain","verb":"post","tags":["senders"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.senders.deleteDomain({\n domain: \"domain\",\n });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->senders->deleteDomain([\"domain\" => \"domain\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.senders.delete_domain({\"domain\": \"domain\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.senders.delete_domain({ 'domain' => 'domain' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/senders/delete-domain \\\n -d '{\"key\":\"\",\"domain\":\"\"}'"}]},{"operationId":"postSendersCheckDomain","pathRoute":"/senders/check-domain-settings","description":"Checks the SPF and DKIM settings for a domain, as well the domain verification. If you haven't already added this domain to your account, it will be added automatically.","summary":"Check domain settings","endpoint":"/senders/check-domain","verb":"post","tags":["senders"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.senders.checkDomain({\n domain: \"domain\",\n });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->senders->checkDomain([\"domain\" => \"domain\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.senders.check_domain({\"domain\": \"domain\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.senders.check_domain({ 'domain' => 'domain' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/senders/check-domain \\\n -d '{\"key\":\"\",\"domain\":\"\"}'"}]},{"operationId":"postSendersVerifyDomain","pathRoute":"/senders/verify-domain","description":"Sends a verification email in order to verify ownership of a domain. Domain verification is a required step to confirm ownership of a domain. Once a domain has been verified in a Transactional API account, other accounts may not have their messages signed by that domain unless they also verify the domain. This prevents other Transactional API accounts from sending mail signed by your domain.","summary":"Verify domain","endpoint":"/senders/verify-domain","verb":"post","tags":["senders"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.senders.verifyDomain({\n domain: \"domain\",\n mailbox: \"mailbox\",\n });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->senders->verifyDomain([\n \"domain\" => \"domain\",\n \"mailbox\" => \"mailbox\",\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.senders.verify_domain({\"domain\": \"domain\", \"mailbox\": \"mailbox\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result =\n client.senders.verify_domain(\n { 'domain' => 'domain', 'mailbox' => 'mailbox' }\n )\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/senders/verify-domain \\\n -d '{\"key\":\"\",\"domain\":\"\",\"mailbox\":\"\"}'"}]},{"operationId":"postSendersInfo","pathRoute":"/senders/get-sender-info","description":"Return more detailed information about a single sender, including aggregates of recent stats.","summary":"Get sender info","endpoint":"/senders/info","verb":"post","tags":["senders"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.senders.info({ address: \"address\" });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->senders->info([\"address\" => \"address\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.senders.info({\"address\": \"address\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.senders.info({ 'address' => 'address' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/senders/info \\\n -d '{\"key\":\"\",\"address\":\"\"}'"}]},{"operationId":"postSendersTimeSeries","pathRoute":"/senders/view-sender-history","description":"Return the recent history (hourly stats for the last 30 days) for a sender.","summary":"View sender history","endpoint":"/senders/time-series","verb":"post","tags":["senders"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.senders.timeSeries({\n address: \"address\",\n });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->senders->timeSeries([\"address\" => \"address\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.senders.time_series({\"address\": \"address\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.senders.time_series({ 'address' => 'address' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/senders/time-series \\\n -d '{\"key\":\"\",\"address\":\"\"}'"}]}],"subSections":[]},{"sectionTitle":"Subaccounts","sectionAnchor":"subaccounts","sectionDescription":"Manage your subaccounts, including the abilitiy to pause and resume sending.","sectionRoute":"/subaccounts","paths":[{"operationId":"postSubaccountsList","pathRoute":"/subaccounts/list-subaccounts","description":"Get the list of subaccounts defined for the account, optionally filtered by a prefix.","summary":"List subaccounts","endpoint":"/subaccounts/list","verb":"post","tags":["subaccounts"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.subaccounts.list();\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->subaccounts->list();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.subaccounts.list()\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.subaccounts.list\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/subaccounts/list \\\n -d '{\"key\":\"\",\"q\":\"\"}'"}]},{"operationId":"postSubaccountsAdd","pathRoute":"/subaccounts/add-subaccount","description":"Add a new subaccount.","summary":"Add subaccount","endpoint":"/subaccounts/add","verb":"post","tags":["subaccounts"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.subaccounts.add({ id: \"id\" });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->subaccounts->add([\"id\" => \"id\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.subaccounts.add({\"id\": \"id\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.subaccounts.add({ 'id' => 'id' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/subaccounts/add \\\n -d '{\"key\":\"\",\"id\":\"\",\"name\":\"\",\"notes\":\"\",\"custom_quota\":0}'"}]},{"operationId":"postSubaccountsInfo","pathRoute":"/subaccounts/get-subaccount-info","description":"Given the ID of an existing subaccount, return the data about it.","summary":"Get subaccount info","endpoint":"/subaccounts/info","verb":"post","tags":["subaccounts"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.subaccounts.info({ id: \"id\" });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->subaccounts->info([\"id\" => \"id\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.subaccounts.info({\"id\": \"id\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.subaccounts.info({ 'id' => 'id' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/subaccounts/info \\\n -d '{\"key\":\"\",\"id\":\"\"}'"}]},{"operationId":"postSubaccountsUpdate","pathRoute":"/subaccounts/update-subaccount","description":"Update an existing subaccount.","summary":"Update subaccount","endpoint":"/subaccounts/update","verb":"post","tags":["subaccounts"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.subaccounts.update({ id: \"id\" });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->subaccounts->update([\"id\" => \"id\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.subaccounts.update({\"id\": \"id\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.subaccounts.update({ 'id' => 'id' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/subaccounts/update \\\n -d '{\"key\":\"\",\"id\":\"\",\"name\":\"\",\"notes\":\"\",\"custom_quota\":0}'"}]},{"operationId":"postSubaccountsDelete","pathRoute":"/subaccounts/delete-subaccount","description":"Delete an existing subaccount. Any email related to the subaccount will be saved, but stats will be removed and any future sending calls to this subaccount will fail.","summary":"Delete subaccount","endpoint":"/subaccounts/delete","verb":"post","tags":["subaccounts"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.subaccounts.delete({ id: \"id\" });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->subaccounts->delete([\"id\" => \"id\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.subaccounts.delete({\"id\": \"id\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.subaccounts.delete({ 'id' => 'id' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/subaccounts/delete \\\n -d '{\"key\":\"\",\"id\":\"\"}'"}]},{"operationId":"postSubaccountsPause","pathRoute":"/subaccounts/pause-subaccount","description":"Pause a subaccount's sending. Any future emails delivered to this subaccount will be queued for a maximum of 3 days until the subaccount is resumed.","summary":"Pause subaccount","endpoint":"/subaccounts/pause","verb":"post","tags":["subaccounts"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.subaccounts.pause({ id: \"id\" });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->subaccounts->pause([\"id\" => \"id\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.subaccounts.pause({\"id\": \"id\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.subaccounts.pause({ 'id' => 'id' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/subaccounts/pause \\\n -d '{\"key\":\"\",\"id\":\"\"}'"}]},{"operationId":"postSubaccountsResume","pathRoute":"/subaccounts/resume-subaccount","description":"Resume a paused subaccount's sending.","summary":"Resume subaccount","endpoint":"/subaccounts/resume","verb":"post","tags":["subaccounts"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.subaccounts.resume({ id: \"id\" });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->subaccounts->resume([\"id\" => \"id\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.subaccounts.resume({\"id\": \"id\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.subaccounts.resume({ 'id' => 'id' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/subaccounts/resume \\\n -d '{\"key\":\"\",\"id\":\"\"}'"}]}],"subSections":[]},{"sectionTitle":"Tags","sectionAnchor":"tags","sectionDescription":"List, delete, or get information on your Tags and their sending statistics.","sectionRoute":"/tags","paths":[{"operationId":"postTagsList","pathRoute":"/tags/list-tags","description":"Return all of the user-defined tag information.","summary":"List tags","endpoint":"/tags/list","verb":"post","tags":["tags"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.tags.list();\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->tags->list();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.tags.list()\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.tags.list\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/tags/list \\\n -d '{\"key\":\"\"}'"}]},{"operationId":"postTagsDelete","pathRoute":"/tags/delete-tag","description":"Deletes a tag permanently. Deleting a tag removes the tag from any messages that have been sent, and also deletes the tag's stats. There is no way to undo this operation, so use it carefully.","summary":"Delete tag","endpoint":"/tags/delete","verb":"post","tags":["tags"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.tags.delete({ tag: \"tag\" });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->tags->delete([\"tag\" => \"tag\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.tags.delete({\"tag\": \"tag\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.tags.delete({ 'tag' => 'tag' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/tags/delete \\\n -d '{\"key\":\"\",\"tag\":\"\"}'"}]},{"operationId":"postTagsInfo","pathRoute":"/tags/get-tag-info","description":"Return more detailed information about a single tag, including aggregates of recent stats.","summary":"Get tag info","endpoint":"/tags/info","verb":"post","tags":["tags"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.tags.info({ tag: \"tag\" });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->tags->info([\"tag\" => \"tag\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.tags.info({\"tag\": \"tag\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.tags.info({ 'tag' => 'tag' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/tags/info \\\n -d '{\"key\":\"\",\"tag\":\"\"}'"}]},{"operationId":"postTagsTimeSeries","pathRoute":"/tags/view-tag-history","description":"Return the recent history (hourly stats for the last 30 days) for a tag.","summary":"View tag history","endpoint":"/tags/time-series","verb":"post","tags":["tags"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.tags.timeSeries({ tag: \"tag\" });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->tags->timeSeries([\"tag\" => \"tag\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.tags.time_series({\"tag\": \"tag\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.tags.time_series({ 'tag' => 'tag' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/tags/time-series \\\n -d '{\"key\":\"\",\"tag\":\"\"}'"}]},{"operationId":"postTagsAllTimeSeries","pathRoute":"/tags/view-all-tags-history","description":"Return the recent history (hourly stats for the last 30 days) for all tags.","summary":"View all tags history","endpoint":"/tags/all-time-series","verb":"post","tags":["tags"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.tags.allTimeSeries();\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->tags->allTimeSeries();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.tags.all_time_series()\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.tags.all_time_series\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/tags/all-time-series \\\n -d '{\"key\":\"\"}'"}]}],"subSections":[]},{"sectionTitle":"Templates","sectionAnchor":"templates","sectionDescription":"Manage templates created via the Mandrill UI or through the /templates endpoint.","sectionRoute":"/templates","paths":[{"operationId":"postTemplatesAdd","pathRoute":"/templates/add-template","description":"Add a new template.","summary":"Add template","endpoint":"/templates/add","verb":"post","tags":["templates"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.templates.add({ name: \"name\" });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->templates->add([\"name\" => \"name\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.templates.add({\"name\": \"name\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.templates.add({ 'name' => 'name' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/templates/add \\\n -d '{\"key\":\"\",\"name\":\"\",\"from_email\":\"\",\"from_name\":\"\",\"subject\":\"\",\"code\":\"\",\"text\":\"\",\"publish\":false,\"labels\":[]}'"}]},{"operationId":"postTemplatesInfo","pathRoute":"/templates/get-template-info","description":"Get the information for an existing template.","summary":"Get template info","endpoint":"/templates/info","verb":"post","tags":["templates"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.templates.info({ name: \"name\" });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->templates->info([\"name\" => \"name\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.templates.info({\"name\": \"name\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.templates.info({ 'name' => 'name' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/templates/info \\\n -d '{\"key\":\"\",\"name\":\"\"}'"}]},{"operationId":"postTemplatesUpdate","pathRoute":"/templates/update-template","description":"Update the code for an existing template. If null is provided for any fields, the values will remain unchanged.","summary":"Update template","endpoint":"/templates/update","verb":"post","tags":["templates"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.templates.update({ name: \"name\" });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->templates->update([\"name\" => \"name\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.templates.update({\"name\": \"name\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.templates.update({ 'name' => 'name' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/templates/update \\\n -d '{\"key\":\"\",\"name\":\"\",\"from_email\":\"\",\"from_name\":\"\",\"subject\":\"\",\"code\":\"\",\"text\":\"\",\"publish\":false,\"labels\":[]}'"}]},{"operationId":"postTemplatesPublish","pathRoute":"/templates/publish-template-content","description":"Publish the content for the template. Any new messages sent using this template will start using the content that was previously in draft.","summary":"Publish template content","endpoint":"/templates/publish","verb":"post","tags":["templates"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.templates.publish({ name: \"name\" });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->templates->publish([\"name\" => \"name\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.templates.publish({\"name\": \"name\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.templates.publish({ 'name' => 'name' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/templates/publish \\\n -d '{\"key\":\"\",\"name\":\"\"}'"}]},{"operationId":"postTemplatesDelete","pathRoute":"/templates/delete-template","description":"Delete a template.","summary":"Delete template","endpoint":"/templates/delete","verb":"post","tags":["templates"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.templates.delete({ name: \"name\" });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->templates->delete([\"name\" => \"name\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.templates.delete({\"name\": \"name\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.templates.delete({ 'name' => 'name' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/templates/delete \\\n -d '{\"key\":\"\",\"name\":\"\"}'"}]},{"operationId":"postTemplatesList","pathRoute":"/templates/list-templates","description":"Return a list of all the templates available to this user.","summary":"List templates","endpoint":"/templates/list","verb":"post","tags":["templates"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.templates.list();\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->templates->list();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.templates.list()\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.templates.list\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/templates/list \\\n -d '{\"key\":\"\",\"label\":\"\"}'"}]},{"operationId":"postTemplatesTimeSeries","pathRoute":"/templates/get-template-history","description":"Return the recent history (hourly stats for the last 30 days) for a template.","summary":"Get template history","endpoint":"/templates/time-series","verb":"post","tags":["templates"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.templates.timeSeries({ name: \"name\" });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->templates->timeSeries([\"name\" => \"name\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.templates.time_series({\"name\": \"name\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.templates.time_series({ 'name' => 'name' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/templates/time-series \\\n -d '{\"key\":\"\",\"name\":\"\"}'"}]},{"operationId":"postTemplatesRender","pathRoute":"/templates/render-html-template","description":"Inject content and optionally merge fields into a template, returning the HTML that results.","summary":"Render html template","endpoint":"/templates/render","verb":"post","tags":["templates"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.templates.render({\n template_name: \"template_name\",\n template_content: [{ name: \"name\", content: \"content\" }],\n });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->templates->render([\n \"template_name\" => \"template_name\",\n \"template_content\" => [[\"name\" => \"name\", \"content\" => \"content\"]],\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.templates.render({\"template_name\": \"template_name\", \"template_content\": [{\"name\": \"name\", \"content\": \"content\"}]})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result =\n client.templates.render(\n {\n 'template_name' => 'template_name',\n 'template_content' => [{ 'name' => 'name', 'content' => 'content' }]\n }\n )\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/templates/render \\\n -d '{\"key\":\"\",\"template_name\":\"\",\"template_content\":[],\"merge_vars\":[]}'"}]}],"subSections":[]},{"sectionTitle":"Templates (MC)","sectionAnchor":"mctemplates","sectionDescription":"Manage templates created via the Mailchimp UI.","sectionRoute":"/mctemplates","paths":[{"operationId":"postMcTemplatesInfo","pathRoute":"/mctemplates/get-mailchimp-template-info","description":"Get information about a Mailchimp Transactional template in your account.","summary":"Get Mailchimp Template info","endpoint":"/mctemplates/info","verb":"post","tags":["mctemplates"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.mctemplates.mcTemplatesInfo({\n mc_template_id: 27967,\n });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->mctemplates->mcTemplatesInfo([\n \"mc_template_id\" => 62932,\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.mctemplates.mc_templates_info({\"mc_template_id\": 97856})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.mctemplates.mc_templates_info({ 'mc_template_id' => 6105 })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/mctemplates/info \\\n -d '{\"key\":\"\",\"mc_template_id\":0}'"}]},{"operationId":"postMcTemplatesList","pathRoute":"/mctemplates/list-mailchimp-transactional-templates","description":"Return a list of all Mailchimp Transactional templates available to this user.","summary":"List Mailchimp Transactional Templates","endpoint":"/mctemplates/list","verb":"post","tags":["mctemplates"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.mctemplates.mcTemplatesList();\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->mctemplates->mcTemplatesList();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.mctemplates.mc_templates_list()\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.mctemplates.mc_templates_list\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/mctemplates/list \\\n -d '{\"key\":\"\",\"search_query\":\"\"}'"}]},{"operationId":"postMcTemplatesTimeSeries","pathRoute":"/mctemplates/get-mailchimp-transactional-template-time-series","description":"Return the recent history (hourly stats for the last 30 days) for a Mailchimp Transactional template. Returns an empty array if the template exists but has never been used to send messages.","summary":"Get Mailchimp Transactional Template Time Series","endpoint":"/mctemplates/time-series","verb":"post","tags":["mctemplates"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.mctemplates.mcTemplatesTimeSeries({\n mc_template_id: 54179,\n });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->mctemplates->mcTemplatesTimeSeries([\n \"mc_template_id\" => 31670,\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.mctemplates.mc_templates_time_series({\"mc_template_id\": 53520})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result =\n client.mctemplates.mc_templates_time_series({ 'mc_template_id' => 22_180 })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/mctemplates/time-series \\\n -d '{\"key\":\"\",\"mc_template_id\":0}'"}]},{"operationId":"postMcTemplatesRender","pathRoute":"/mctemplates/render-mailchimp-transactional-template","description":"Render a Mailchimp Transactional template with optional merge variables.","summary":"Render Mailchimp Transactional Template","endpoint":"/mctemplates/render","verb":"post","tags":["mctemplates"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.mctemplates.mcTemplatesRender({\n mc_template_id: 76833,\n });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->mctemplates->mcTemplatesRender([\n \"mc_template_id\" => 83324,\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.mctemplates.mc_templates_render({\"mc_template_id\": 77783})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result =\n client.mctemplates.mc_templates_render({ 'mc_template_id' => 15_690 })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/mctemplates/render \\\n -d '{\"key\":\"\",\"mc_template_id\":0,\"mc_template_version\":\"published\",\"merge_vars\":[]}'"}]}],"subSections":[]},{"sectionTitle":"URLs","sectionAnchor":"urls","sectionDescription":"Manage your tracking domains.","sectionRoute":"/urls","paths":[{"operationId":"postUrlsAddTrackingDomain","pathRoute":"/urls/add-tracking-domains","description":"Add a tracking domain to your account.","summary":"Add tracking domains","endpoint":"/urls/add-tracking-domain","verb":"post","tags":["urls"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.urls.addTrackingDomain({\n domain: \"domain\",\n });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->urls->addTrackingDomain([\"domain\" => \"domain\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.urls.add_tracking_domain({\"domain\": \"domain\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.urls.add_tracking_domain({ 'domain' => 'domain' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/urls/add-tracking-domain \\\n -d '{\"key\":\"\",\"domain\":\"\"}'"}]},{"operationId":"postUrlsCheckTrackingDomain","pathRoute":"/urls/check-cname-settings","description":"Checks the CNAME settings for a tracking domain. The domain must have been added already with the add-tracking-domain call.","summary":"Check cname settings","endpoint":"/urls/check-tracking-domain","verb":"post","tags":["urls"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.urls.checkTrackingDomain({\n domain: \"domain\",\n });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->urls->checkTrackingDomain([\"domain\" => \"domain\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.urls.check_tracking_domain({\"domain\": \"domain\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.urls.check_tracking_domain({ 'domain' => 'domain' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/urls/check-tracking-domain \\\n -d '{\"key\":\"\",\"domain\":\"\"}'"}]},{"operationId":"postUrlsDeleteTrackingDomain","pathRoute":"/urls/delete-tracking-domain","description":"Deletes an unverified tracking domain from your account. Valid tracking domains cannot be deleted via API and require login confirmation.","summary":"Delete tracking domain","endpoint":"/urls/delete-tracking-domain","verb":"post","tags":["urls"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.urls.deleteTrackingDomain({\n domain: \"domain\",\n });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->urls->deleteTrackingDomain([\"domain\" => \"domain\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.urls.delete_tracking_domain({\"domain\": \"domain\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.urls.delete_tracking_domain({ 'domain' => 'domain' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/urls/delete-tracking-domain \\\n -d '{\"key\":\"\",\"domain\":\"\"}'"}]},{"operationId":"postUrlsTrackingDomains","pathRoute":"/urls/list-tracking-domains","description":"Get the list of tracking domains set up for this account.","summary":"List tracking domains","endpoint":"/urls/tracking-domains","verb":"post","tags":["urls"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.urls.trackingDomains();\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->urls->trackingDomains();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.urls.tracking_domains()\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.urls.tracking_domains\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/urls/tracking-domains \\\n -d '{\"key\":\"\"}'"}]}],"subSections":[]},{"sectionTitle":"Users","sectionAnchor":"users","sectionDescription":"Get information about your account, or ping Transactional.","sectionRoute":"/users","paths":[{"operationId":"postUsersInfo","pathRoute":"/users/get-user-info","description":"Return the information about the API-connected user.","summary":"Get user info","endpoint":"/users/info","verb":"post","tags":["users"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.users.info();\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->users->info();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.users.info()\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.users.info\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/users/info \\\n -d '{\"key\":\"\"}'"}]},{"operationId":"postUsersPing","pathRoute":"/users/ping","description":"Validate an API key and respond to a ping.","summary":"Ping","endpoint":"/users/ping","verb":"post","tags":["users"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.users.ping();\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->users->ping();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.users.ping()\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.users.ping\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/users/ping \\\n -d '{\"key\":\"\"}'"}]},{"operationId":"postUsersPing2","pathRoute":"/users/ping-2","description":"Validate an API key and respond to a ping (JSON parser version).","summary":"Ping 2","endpoint":"/users/ping2","verb":"post","tags":["users"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.users.ping2();\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->users->ping2();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.users.ping2()\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.users.ping2\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/users/ping2 \\\n -d '{\"key\":\"\"}'"}]},{"operationId":"postUsersSenders","pathRoute":"/users/list-account-senders","description":"Return the senders that have tried to use this account, both verified and unverified.","summary":"List account senders","endpoint":"/users/senders","verb":"post","tags":["users"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.users.senders();\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->users->senders();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.users.senders()\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.users.senders\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/users/senders \\\n -d '{\"key\":\"\"}'"}]}],"subSections":[]},{"sectionTitle":"Webhooks","sectionAnchor":"webhooks","sectionDescription":"Manage the webhooks in your account.","sectionRoute":"/webhooks","paths":[{"operationId":"postWebhooksList","pathRoute":"/webhooks/list-webhooks","description":"Get the list of all webhooks defined on the account.","summary":"List webhooks","endpoint":"/webhooks/list","verb":"post","tags":["webhooks"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.webhooks.list();\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->webhooks->list();\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.webhooks.list()\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.webhooks.list\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/webhooks/list \\\n -d '{\"key\":\"\"}'"}]},{"operationId":"postWebhooksAdd","pathRoute":"/webhooks/add-webhook","description":"Add a new webhook.","summary":"Add webhook","endpoint":"/webhooks/add","verb":"post","tags":["webhooks"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.webhooks.add({\n url: \"https://omer.biz\",\n });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->webhooks->add([\"url\" => \"http://meagan.org\"]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.webhooks.add({\"url\": \"https://ambrose.biz\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.webhooks.add({ 'url' => 'https://aurelio.net' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/webhooks/add \\\n -d '{\"key\":\"\",\"url\":\"\",\"description\":\"\",\"events\":[]}'"}]},{"operationId":"postWebhooksInfo","pathRoute":"/webhooks/get-webhook-info","description":"Given the ID of an existing webhook, return the data about it.","summary":"Get webhook info","endpoint":"/webhooks/info","verb":"post","tags":["webhooks"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.webhooks.info({ id: 59900 });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->webhooks->info([\"id\" => 47682]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.webhooks.info({\"id\": 83577})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.webhooks.info({ 'id' => 99_480 })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/webhooks/info \\\n -d '{\"key\":\"\",\"id\":0}'"}]},{"operationId":"postWebhooksUpdate","pathRoute":"/webhooks/update-webhook","description":"Update an existing webhook.","summary":"Update webhook","endpoint":"/webhooks/update","verb":"post","tags":["webhooks"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.webhooks.update({\n id: 69311,\n url: \"http://elouise.net\",\n });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->webhooks->update([\n \"id\" => 4250,\n \"url\" => \"https://okey.name\",\n]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.webhooks.update({\"id\": 88287, \"url\": \"http://derrick.net\"})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result =\n client.webhooks.update({ 'id' => 87_332, 'url' => 'http://odie.info' })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/webhooks/update \\\n -d '{\"key\":\"\",\"id\":0,\"url\":\"\",\"description\":\"\",\"events\":[]}'"}]},{"operationId":"postWebhooksDelete","pathRoute":"/webhooks/delete-webhook","description":"Delete an existing webhook.","summary":"Delete webhook","endpoint":"/webhooks/delete","verb":"post","tags":["webhooks"],"deprecated":false,"snippets":[{"lang":"javascript","snippetStr":"const mailchimpClient = require(\"@mailchimp/mailchimp_transactional\")(\n \"YOUR_API_KEY\"\n);\n\nconst run = async () => {\n const response = await mailchimpClient.webhooks.delete({ id: 10896 });\n console.log(response);\n};\n\nrun();\n"},{"lang":"php","snippetStr":"setApiKey('YOUR_API_KEY');\n\n$response = $mailchimp->webhooks->delete([\"id\" => 18449]);\nprint_r($response);\n"},{"lang":"python","snippetStr":"import mailchimp_transactional as MailchimpTransactional\nfrom mailchimp_transactional.api_client import ApiClientError\n\ntry:\n mailchimp = MailchimpTransactional.Client(\"YOUR_API_KEY\")\n response = client.webhooks.delete({\"id\": 46598})\n print(response)\nexcept ApiClientError as error:\n print(\"An exception occurred: {}\".format(error.text))"},{"lang":"ruby","snippetStr":"require 'MailchimpTransactional'\n\nbegin\n client = MailchimpTransactional::Client.new(ENV['API_KEY'])\n result = client.webhooks.delete({ 'id' => 85_163 })\n p result\nrescue MailchimpTransactional::ApiError => e\n puts \"Error: #{e}\"\nend\n"},{"lang":"curl","snippetStr":"curl -X POST \\\n https://mandrillapp.com/api/1.3/webhooks/delete \\\n -d '{\"key\":\"\",\"id\":0}'"}]}],"subSections":[]}]}},"pageContext":{"product":"transactional","productLink":"Transactional","productPages":["landing","guide","docs","reference"],"pageVariant":"reference","withGuideData":false,"withDocData":false,"withRefData":true,"withLandingPageData":false,"specVersion":"1.4.1","specPermalink":"https://github.com/mailchimp/mailchimp-client-lib-codegen/blob/main/spec/transactional.openapi.json","id":"postRejectsAddSms","nodeType":"RefPath","pathAnchor":"postRejectsAddSms","sectionAnchor":"rejects"}},"staticQueryHashes":["1376854140","279774122","302783970","3547147324","3936069583"]}