openapi: 3.1.0 info: title: Mailchimp Transactional API version: 1.0.0 description: >- The Mailchimp Transactional API (formerly Mandrill) enables sending personalized, one-to-one transactional emails such as password resets, order confirmations, and welcome messages. It provides high-deliverability email infrastructure with detailed analytics, templates, and webhook support. contact: name: Mailchimp API Support email: apihelp@mailchimp.com url: https://mailchimp.com/developer/transactional/ license: name: Mailchimp API Use Policy url: https://mailchimp.com/legal/api_use/ termsOfService: https://mailchimp.com/legal/terms/ servers: - url: https://mandrillapp.com/api/1.0 description: Mailchimp Transactional (Mandrill) Production API security: - apiKey: [] tags: - name: Allowlists description: >- Manage the allowlist of email addresses that bypass the rejection blacklist. - name: Exports description: Request and download data exports for messages, rejects, and allowlists. - name: IPs description: Manage dedicated IP addresses associated with the account. - name: Messages description: Send and search transactional messages, and retrieve message details. - name: Metadata description: >- Manage custom metadata fields that can be attached to messages for tracking and filtering. - name: Rejects description: >- Manage the rejection blacklist, which prevents delivery to addresses that have previously bounced or been reported as spam. - name: Senders description: >- Retrieve sender information and statistics for verified sending domains and email addresses. - name: Subaccounts description: >- Manage subaccounts for organizing sending and reporting within a single Mandrill account. - name: Templates description: >- Manage reusable email templates stored on the Mandrill server for use when sending transactional messages. - name: Users description: Retrieve information about the authenticated Mandrill account. - name: Webhooks description: Manage webhooks that receive event notifications for sent messages. paths: /messages/send: post: operationId: postMessagesSend summary: Mailchimp Send a Transactional Email description: >- Send a new transactional message through Mandrill. Supports HTML and plain-text content, inline images, attachments, merge variables, metadata, and per-recipient customization. tags: - Messages requestBody: required: true content: application/json: schema: type: object required: - key - message properties: key: type: string description: A valid Mandrill API key. message: $ref: '#/components/schemas/MessagePayload' async: type: boolean description: >- Enable background sending mode optimized for bulk sending. In async mode, the response will not include per-recipient status, and failures will be handled by retry or webhook. default: false ip_pool: type: string description: >- The name of the dedicated IP pool that should be used to send this message. send_at: type: string format: date-time description: >- Schedule the message for future delivery. The date/time must be in UTC and formatted as YYYY-MM-DD HH:MM:SS. Messages can be scheduled up to 7 days in advance. examples: PostmessagessendRequestExample: summary: Default postMessagesSend request x-microcks-default: true value: key: example_value message: html: example_value text: example_value subject: example_value from_email: user@example.com from_name: example_value to: - email: user@example.com name: Example Title type: to headers: example_value important: true track_opens: true track_clicks: true auto_text: true auto_html: true inline_css: true url_strip_qs: https://www.example.com preserve_recipients: true view_content_link: true bcc_address: example_value tracking_domain: example_value signing_domain: example_value return_path_domain: example_value merge: true merge_language: mailchimp global_merge_vars: - name: Example Title content: example_value merge_vars: - rcpt: example_value vars: {} tags: - example_value subaccount: example_value google_analytics_domains: - example_value google_analytics_campaign: example_value metadata: example_value recipient_metadata: - rcpt: example_value values: example_value attachments: - type: example_value name: Example Title content: example_value images: - type: example_value name: Example Title content: example_value async: true ip_pool: example_value send_at: '2026-01-15T10:30:00Z' responses: '200': description: >- An array of sending results, one per recipient. Each object contains the email address, status, reject reason (if any), and the message ID. content: application/json: schema: type: array items: $ref: '#/components/schemas/SendResult' examples: Postmessagessend200Example: summary: Default postMessagesSend 200 response x-microcks-default: true value: - email: user@example.com status: sent reject_reason: hard-bounce queued_reason: example_value _id: '500123' '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /messages/send-template: post: operationId: postMessagesSendTemplate summary: Mailchimp Send an Email Using a Template description: >- Send a new transactional message using a stored template. Template content blocks can be overridden with the template_content parameter. Merge variables in the template are populated from the message object. tags: - Messages requestBody: required: true content: application/json: schema: type: object required: - key - template_name - template_content - message properties: key: type: string description: A valid Mandrill API key. template_name: type: string description: >- The slug or name of the template stored in Mandrill to use for this message. template_content: type: array description: >- An array of objects with name/content pairs for injecting content into editable regions defined in the template using mc:edit attributes. items: type: object properties: name: type: string description: The name of the mc:edit content block to set. content: type: string description: The HTML content to replace the block with. message: $ref: '#/components/schemas/MessagePayload' async: type: boolean default: false description: Enable background sending mode. ip_pool: type: string description: The name of the dedicated IP pool to use. send_at: type: string format: date-time description: Schedule message for future delivery in UTC. examples: PostmessagessendtemplateRequestExample: summary: Default postMessagesSendTemplate request x-microcks-default: true value: key: example_value template_name: example_value template_content: - name: Example Title content: example_value message: html: example_value text: example_value subject: example_value from_email: user@example.com from_name: example_value to: - email: user@example.com name: Example Title type: to headers: example_value important: true track_opens: true track_clicks: true auto_text: true auto_html: true inline_css: true url_strip_qs: https://www.example.com preserve_recipients: true view_content_link: true bcc_address: example_value tracking_domain: example_value signing_domain: example_value return_path_domain: example_value merge: true merge_language: mailchimp global_merge_vars: - name: Example Title content: example_value merge_vars: - rcpt: example_value vars: {} tags: - example_value subaccount: example_value google_analytics_domains: - example_value google_analytics_campaign: example_value metadata: example_value recipient_metadata: - rcpt: example_value values: example_value attachments: - type: example_value name: Example Title content: example_value images: - type: example_value name: Example Title content: example_value async: true ip_pool: example_value send_at: '2026-01-15T10:30:00Z' responses: '200': description: An array of sending results, one per recipient. content: application/json: schema: type: array items: $ref: '#/components/schemas/SendResult' examples: Postmessagessendtemplate200Example: summary: Default postMessagesSendTemplate 200 response x-microcks-default: true value: - email: user@example.com status: sent reject_reason: hard-bounce queued_reason: example_value _id: '500123' '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /messages/search: post: operationId: postMessagesSearch summary: Mailchimp Search Sent Messages description: >- Search recently sent messages and return matching results. You can filter by sending status, sender, tags, recipient, subject, and date range. Results are limited to the last 7 days. tags: - Messages requestBody: required: true content: application/json: schema: type: object required: - key properties: key: type: string description: A valid Mandrill API key. query: type: string description: >- Search terms to filter results. Supports full-text search across message subject and email addresses. date_from: type: string format: date-time description: Start date for the search range (UTC). date_to: type: string format: date-time description: End date for the search range (UTC). tags: type: array items: type: string description: Tags that must be present on matching messages. senders: type: array items: type: string description: Sender addresses to filter by. api_keys: type: array items: type: string description: API keys to filter by for subaccount isolation. limit: type: integer default: 100 description: Maximum number of results to return (max 1000). examples: PostmessagessearchRequestExample: summary: Default postMessagesSearch request x-microcks-default: true value: key: example_value query: example_value date_from: '2026-01-15T10:30:00Z' date_to: '2026-01-15T10:30:00Z' tags: - example_value senders: - example_value api_keys: - example_value limit: 10 responses: '200': description: An array of message info objects matching the search criteria. content: application/json: schema: type: array items: $ref: '#/components/schemas/MessageInfo' examples: Postmessagessearch200Example: summary: Default postMessagesSearch 200 response x-microcks-default: true value: - ts: 10 _id: '500123' sender: example_value template: example_value subject: example_value email: user@example.com tags: - example_value opens: 10 opens_detail: - ts: 10 ip: example_value location: example_value ua: example_value clicks: 10 clicks_detail: - ts: 10 url: https://www.example.com ip: example_value location: example_value ua: example_value state: sent metadata: example_value '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /messages/search-time-series: post: operationId: postMessagesSearchTimeSeries summary: Mailchimp Search Message Time Series description: >- Search the content of recently sent messages and return aggregated hourly statistics for matching messages over time. tags: - Messages requestBody: required: true content: application/json: schema: type: object required: - key properties: key: type: string description: A valid Mandrill API key. query: type: string description: Search terms to filter results. date_from: type: string format: date-time description: Start date for the search range (UTC). date_to: type: string format: date-time description: End date for the search range (UTC). tags: type: array items: type: string description: Tags that must be present on matching messages. senders: type: array items: type: string description: Sender addresses to filter by. examples: PostmessagessearchtimeseriesRequestExample: summary: Default postMessagesSearchTimeSeries request x-microcks-default: true value: key: example_value query: example_value date_from: '2026-01-15T10:30:00Z' date_to: '2026-01-15T10:30:00Z' tags: - example_value senders: - example_value responses: '200': description: An array of time series data points with hourly statistics. content: application/json: schema: type: array items: $ref: '#/components/schemas/TimeSeries' examples: Postmessagessearchtimeseries200Example: summary: Default postMessagesSearchTimeSeries 200 response x-microcks-default: true value: - time: '2026-01-15T10:30:00Z' sent: 10 hard_bounces: 10 soft_bounces: 10 rejects: 10 complaints: 10 unsubs: 10 opens: 10 unique_opens: 10 clicks: 10 unique_clicks: 10 '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /messages/info: post: operationId: postMessagesInfo summary: Mailchimp Get Message Info description: >- Get the information for a single recently sent message including delivery status, open/click tracking, and metadata. tags: - Messages requestBody: required: true content: application/json: schema: type: object required: - key - id properties: key: type: string description: A valid Mandrill API key. id: type: string description: The unique message ID returned from a send call. examples: PostmessagesinfoRequestExample: summary: Default postMessagesInfo request x-microcks-default: true value: key: example_value id: abc123 responses: '200': description: Detailed information about the message. content: application/json: schema: $ref: '#/components/schemas/MessageDetail' examples: Postmessagesinfo200Example: summary: Default postMessagesInfo 200 response x-microcks-default: true value: {} '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /messages/content: post: operationId: postMessagesContent summary: Mailchimp Get Message Content description: >- Get the full content of a recently sent message including the HTML body, text body, headers, and attachments. tags: - Messages requestBody: required: true content: application/json: schema: type: object required: - key - id properties: key: type: string description: A valid Mandrill API key. id: type: string description: The unique message ID. examples: PostmessagescontentRequestExample: summary: Default postMessagesContent request x-microcks-default: true value: key: example_value id: abc123 responses: '200': description: The full content of the message. content: application/json: schema: $ref: '#/components/schemas/MessageContent' examples: Postmessagescontent200Example: summary: Default postMessagesContent 200 response x-microcks-default: true value: ts: 10 _id: '500123' from_email: user@example.com from_name: example_value subject: example_value to: email: user@example.com name: Example Title tags: - example_value headers: example_value text: example_value html: example_value attachments: - name: Example Title type: example_value content: example_value '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /messages/parse: post: operationId: postMessagesParse summary: Mailchimp Parse a Raw Mime Message description: >- Parse the full MIME document for an email message, returning the subject, recipients, HTML body, text body, headers, and attachments. tags: - Messages requestBody: required: true content: application/json: schema: type: object required: - key - raw_message properties: key: type: string description: A valid Mandrill API key. raw_message: type: string description: The full MIME document of the message to parse. examples: PostmessagesparseRequestExample: summary: Default postMessagesParse request x-microcks-default: true value: key: example_value raw_message: example_value responses: '200': description: The parsed message content. content: application/json: schema: $ref: '#/components/schemas/ParsedMessage' examples: Postmessagesparse200Example: summary: Default postMessagesParse 200 response x-microcks-default: true value: subject: example_value from_email: user@example.com from_name: example_value to: - email: user@example.com name: Example Title headers: example_value text: example_value html: example_value attachments: - name: Example Title type: example_value content: example_value images: - name: Example Title type: example_value content: example_value '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /messages/send-raw: post: operationId: postMessagesSendRaw summary: Mailchimp Send a Raw Mime Message description: >- Take a raw MIME document and send it exactly as provided. Mandrill will not modify the message content, but will track opens and clicks if the appropriate headers are included. tags: - Messages requestBody: required: true content: application/json: schema: type: object required: - key - raw_message properties: key: type: string description: A valid Mandrill API key. raw_message: type: string description: The full MIME document of the message to send. from_email: type: string format: email description: >- Override the from address in the raw message. If not specified, the from address in the raw message is used. from_name: type: string description: Override the from name in the raw message. to: type: array items: type: string format: email description: >- Override the recipients in the raw message. If not provided, recipients from the MIME headers are used. async: type: boolean default: false description: Enable background sending mode. ip_pool: type: string description: The name of the dedicated IP pool to use. send_at: type: string format: date-time description: Schedule message for future delivery in UTC. return_path_domain: type: string description: Custom domain for the return-path header. examples: PostmessagessendrawRequestExample: summary: Default postMessagesSendRaw request x-microcks-default: true value: key: example_value raw_message: example_value from_email: user@example.com from_name: example_value to: - example_value async: true ip_pool: example_value send_at: '2026-01-15T10:30:00Z' return_path_domain: example_value responses: '200': description: An array of sending results, one per recipient. content: application/json: schema: type: array items: $ref: '#/components/schemas/SendResult' examples: Postmessagessendraw200Example: summary: Default postMessagesSendRaw 200 response x-microcks-default: true value: - email: user@example.com status: sent reject_reason: hard-bounce queued_reason: example_value _id: '500123' '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /messages/list-scheduled: post: operationId: postMessagesListScheduled summary: Mailchimp List Scheduled Messages description: >- Get a list of messages that are scheduled for future delivery. Messages can be scheduled up to 7 days in advance. tags: - Messages requestBody: required: true content: application/json: schema: type: object required: - key properties: key: type: string description: A valid Mandrill API key. to: type: string format: email description: >- Optional recipient email address to restrict results to messages scheduled for a specific recipient. examples: PostmessageslistscheduledRequestExample: summary: Default postMessagesListScheduled request x-microcks-default: true value: key: example_value to: example_value responses: '200': description: An array of scheduled message objects. content: application/json: schema: type: array items: $ref: '#/components/schemas/ScheduledMessage' examples: Postmessageslistscheduled200Example: summary: Default postMessagesListScheduled 200 response x-microcks-default: true value: - _id: '500123' created_at: '2026-01-15T10:30:00Z' send_at: '2026-01-15T10:30:00Z' from_email: user@example.com to: example_value subject: example_value '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /messages/cancel-scheduled: post: operationId: postMessagesCancelScheduled summary: Mailchimp Cancel a Scheduled Message description: >- Cancel a message that has been scheduled for future delivery. The message must not have already been sent. tags: - Messages requestBody: required: true content: application/json: schema: type: object required: - key - id properties: key: type: string description: A valid Mandrill API key. id: type: string description: The unique ID of the scheduled message to cancel. examples: PostmessagescancelscheduledRequestExample: summary: Default postMessagesCancelScheduled request x-microcks-default: true value: key: example_value id: abc123 responses: '200': description: The details of the cancelled scheduled message. content: application/json: schema: $ref: '#/components/schemas/ScheduledMessage' examples: Postmessagescancelscheduled200Example: summary: Default postMessagesCancelScheduled 200 response x-microcks-default: true value: _id: '500123' created_at: '2026-01-15T10:30:00Z' send_at: '2026-01-15T10:30:00Z' from_email: user@example.com to: example_value subject: example_value '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /messages/reschedule: post: operationId: postMessagesReschedule summary: Mailchimp Reschedule a Message description: >- Reschedule a message that was previously scheduled for future delivery to a new date and time. tags: - Messages requestBody: required: true content: application/json: schema: type: object required: - key - id - send_at properties: key: type: string description: A valid Mandrill API key. id: type: string description: The unique ID of the scheduled message to reschedule. send_at: type: string format: date-time description: The new date and time to send the message in UTC. examples: PostmessagesrescheduleRequestExample: summary: Default postMessagesReschedule request x-microcks-default: true value: key: example_value id: abc123 send_at: '2026-01-15T10:30:00Z' responses: '200': description: The updated scheduled message details. content: application/json: schema: $ref: '#/components/schemas/ScheduledMessage' examples: Postmessagesreschedule200Example: summary: Default postMessagesReschedule 200 response x-microcks-default: true value: _id: '500123' created_at: '2026-01-15T10:30:00Z' send_at: '2026-01-15T10:30:00Z' from_email: user@example.com to: example_value subject: example_value '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /templates/add: post: operationId: postTemplatesAdd summary: Mailchimp Add a New Template description: >- Create a new template on the Mandrill server. Templates can contain merge variables and mc:edit content blocks for dynamic content injection at send time. tags: - Templates requestBody: required: true content: application/json: schema: type: object required: - key - name properties: key: type: string description: A valid Mandrill API key. name: type: string description: The name for the new template (must be unique). from_email: type: string format: email description: Default from address for the template. from_name: type: string description: Default from name for the template. subject: type: string description: Default subject line for the template. code: type: string description: The HTML code for the template with mc:edit regions. text: type: string description: Default text part of messages sent with this template. publish: type: boolean default: true description: Whether to publish the template immediately. labels: type: array items: type: string description: Array of up to 10 labels to organize templates. examples: PosttemplatesaddRequestExample: summary: Default postTemplatesAdd request x-microcks-default: true value: key: example_value name: Example Title from_email: user@example.com from_name: example_value subject: example_value code: example_value text: example_value publish: true labels: - example_value responses: '200': description: The newly created template object. content: application/json: schema: $ref: '#/components/schemas/TemplateInfo' examples: Posttemplatesadd200Example: summary: Default postTemplatesAdd 200 response x-microcks-default: true value: slug: example_value name: Example Title labels: - example_value code: example_value subject: example_value from_email: user@example.com from_name: example_value text: example_value publish_name: example_value publish_code: example_value publish_subject: example_value publish_from_email: user@example.com publish_from_name: example_value publish_text: example_value published_at: '2026-01-15T10:30:00Z' created_at: '2026-01-15T10:30:00Z' updated_at: '2026-01-15T10:30:00Z' '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /templates/info: post: operationId: postTemplatesInfo summary: Mailchimp Get Template Info description: >- Get the details for a specific template, including its code, default values, and publish status. tags: - Templates requestBody: required: true content: application/json: schema: type: object required: - key - name properties: key: type: string description: A valid Mandrill API key. name: type: string description: The name of the existing template. examples: PosttemplatesinfoRequestExample: summary: Default postTemplatesInfo request x-microcks-default: true value: key: example_value name: Example Title responses: '200': description: The template details. content: application/json: schema: $ref: '#/components/schemas/TemplateInfo' examples: Posttemplatesinfo200Example: summary: Default postTemplatesInfo 200 response x-microcks-default: true value: slug: example_value name: Example Title labels: - example_value code: example_value subject: example_value from_email: user@example.com from_name: example_value text: example_value publish_name: example_value publish_code: example_value publish_subject: example_value publish_from_email: user@example.com publish_from_name: example_value publish_text: example_value published_at: '2026-01-15T10:30:00Z' created_at: '2026-01-15T10:30:00Z' updated_at: '2026-01-15T10:30:00Z' '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /templates/update: post: operationId: postTemplatesUpdate summary: Mailchimp Update a Template description: >- Update an existing template with new values for any of its fields. Only the fields you include in the request body will be updated. tags: - Templates requestBody: required: true content: application/json: schema: type: object required: - key - name properties: key: type: string description: A valid Mandrill API key. name: type: string description: The name of the existing template to update. from_email: type: string format: email description: Updated default from address. from_name: type: string description: Updated default from name. subject: type: string description: Updated default subject line. code: type: string description: Updated HTML code for the template. text: type: string description: Updated default text part. publish: type: boolean description: Whether to publish the updated template immediately. labels: type: array items: type: string description: Updated array of labels. examples: PosttemplatesupdateRequestExample: summary: Default postTemplatesUpdate request x-microcks-default: true value: key: example_value name: Example Title from_email: user@example.com from_name: example_value subject: example_value code: example_value text: example_value publish: true labels: - example_value responses: '200': description: The updated template details. content: application/json: schema: $ref: '#/components/schemas/TemplateInfo' examples: Posttemplatesupdate200Example: summary: Default postTemplatesUpdate 200 response x-microcks-default: true value: slug: example_value name: Example Title labels: - example_value code: example_value subject: example_value from_email: user@example.com from_name: example_value text: example_value publish_name: example_value publish_code: example_value publish_subject: example_value publish_from_email: user@example.com publish_from_name: example_value publish_text: example_value published_at: '2026-01-15T10:30:00Z' created_at: '2026-01-15T10:30:00Z' updated_at: '2026-01-15T10:30:00Z' '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /templates/publish: post: operationId: postTemplatesPublish summary: Mailchimp Publish a Template description: >- Publish the most recent draft of an existing template, making it available for sending. tags: - Templates requestBody: required: true content: application/json: schema: type: object required: - key - name properties: key: type: string description: A valid Mandrill API key. name: type: string description: The name of the template to publish. examples: PosttemplatespublishRequestExample: summary: Default postTemplatesPublish request x-microcks-default: true value: key: example_value name: Example Title responses: '200': description: The published template details. content: application/json: schema: $ref: '#/components/schemas/TemplateInfo' examples: Posttemplatespublish200Example: summary: Default postTemplatesPublish 200 response x-microcks-default: true value: slug: example_value name: Example Title labels: - example_value code: example_value subject: example_value from_email: user@example.com from_name: example_value text: example_value publish_name: example_value publish_code: example_value publish_subject: example_value publish_from_email: user@example.com publish_from_name: example_value publish_text: example_value published_at: '2026-01-15T10:30:00Z' created_at: '2026-01-15T10:30:00Z' updated_at: '2026-01-15T10:30:00Z' '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /templates/delete: post: operationId: postTemplatesDelete summary: Mailchimp Delete a Template description: >- Permanently delete a template from the account. This action cannot be undone. tags: - Templates requestBody: required: true content: application/json: schema: type: object required: - key - name properties: key: type: string description: A valid Mandrill API key. name: type: string description: The name of the template to delete. examples: PosttemplatesdeleteRequestExample: summary: Default postTemplatesDelete request x-microcks-default: true value: key: example_value name: Example Title responses: '200': description: The deleted template details. content: application/json: schema: $ref: '#/components/schemas/TemplateInfo' examples: Posttemplatesdelete200Example: summary: Default postTemplatesDelete 200 response x-microcks-default: true value: slug: example_value name: Example Title labels: - example_value code: example_value subject: example_value from_email: user@example.com from_name: example_value text: example_value publish_name: example_value publish_code: example_value publish_subject: example_value publish_from_email: user@example.com publish_from_name: example_value publish_text: example_value published_at: '2026-01-15T10:30:00Z' created_at: '2026-01-15T10:30:00Z' updated_at: '2026-01-15T10:30:00Z' '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /templates/list: post: operationId: postTemplatesList summary: Mailchimp List Templates description: Get a list of all templates available in the account. tags: - Templates requestBody: required: true content: application/json: schema: type: object required: - key properties: key: type: string description: A valid Mandrill API key. label: type: string description: >- Optional label to filter results. Only templates with the given label will be returned. examples: PosttemplateslistRequestExample: summary: Default postTemplatesList request x-microcks-default: true value: key: example_value label: Example Title responses: '200': description: An array of template info objects. content: application/json: schema: type: array items: $ref: '#/components/schemas/TemplateInfo' examples: Posttemplateslist200Example: summary: Default postTemplatesList 200 response x-microcks-default: true value: - slug: example_value name: Example Title labels: - example_value code: example_value subject: example_value from_email: user@example.com from_name: example_value text: example_value publish_name: example_value publish_code: example_value publish_subject: example_value publish_from_email: user@example.com publish_from_name: example_value publish_text: example_value published_at: '2026-01-15T10:30:00Z' created_at: '2026-01-15T10:30:00Z' updated_at: '2026-01-15T10:30:00Z' '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /templates/time-series: post: operationId: postTemplatesTimeSeries summary: Mailchimp Get Template Time Series description: >- Return the recent sending history for a template, aggregated by hourly time slots. tags: - Templates requestBody: required: true content: application/json: schema: type: object required: - key - name properties: key: type: string description: A valid Mandrill API key. name: type: string description: The name of the existing template. examples: PosttemplatestimeseriesRequestExample: summary: Default postTemplatesTimeSeries request x-microcks-default: true value: key: example_value name: Example Title responses: '200': description: An array of time series data for the template. content: application/json: schema: type: array items: $ref: '#/components/schemas/TimeSeries' examples: Posttemplatestimeseries200Example: summary: Default postTemplatesTimeSeries 200 response x-microcks-default: true value: - time: '2026-01-15T10:30:00Z' sent: 10 hard_bounces: 10 soft_bounces: 10 rejects: 10 complaints: 10 unsubs: 10 opens: 10 unique_opens: 10 clicks: 10 unique_clicks: 10 '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /templates/render: post: operationId: postTemplatesRender summary: Mailchimp Render a Template description: >- Render a template with the provided merge variables and template content, returning the final HTML that would be sent. tags: - Templates requestBody: required: true content: application/json: schema: type: object required: - key - template_name - template_content properties: key: type: string description: A valid Mandrill API key. template_name: type: string description: The name of the template to render. template_content: type: array description: Content blocks to inject into mc:edit regions. items: type: object properties: name: type: string description: The name of the content block. content: type: string description: The content to inject. merge_vars: type: array description: Merge variables to use during rendering. items: type: object properties: name: type: string description: The merge variable name. content: type: string description: The merge variable value. examples: PosttemplatesrenderRequestExample: summary: Default postTemplatesRender request x-microcks-default: true value: key: example_value template_name: example_value template_content: - name: Example Title content: example_value merge_vars: - name: Example Title content: example_value responses: '200': description: The rendered template HTML. content: application/json: schema: type: object properties: html: type: string description: The rendered HTML of the template. examples: Posttemplatesrender200Example: summary: Default postTemplatesRender 200 response x-microcks-default: true value: html: example_value '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /tags/list: post: operationId: postTagsList summary: Mailchimp List Tags description: >- Get all the tags that have been used in the account, along with aggregate sending statistics for each tag. tags: [] requestBody: required: true content: application/json: schema: type: object required: - key properties: key: type: string description: A valid Mandrill API key. examples: PosttagslistRequestExample: summary: Default postTagsList request x-microcks-default: true value: key: example_value responses: '200': description: An array of tag objects with statistics. content: application/json: schema: type: array items: $ref: '#/components/schemas/TagInfo' examples: Posttagslist200Example: summary: Default postTagsList 200 response x-microcks-default: true value: - tag: example_value reputation: 10 sent: 10 hard_bounces: 10 soft_bounces: 10 rejects: 10 complaints: 10 unsubs: 10 opens: 10 clicks: 10 unique_opens: 10 unique_clicks: 10 '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /tags/info: post: operationId: postTagsInfo summary: Mailchimp Get Tag Info description: >- Return more detailed information about a single tag including aggregate statistics. tags: [] requestBody: required: true content: application/json: schema: type: object required: - key - tag properties: key: type: string description: A valid Mandrill API key. tag: type: string description: The tag name to retrieve information for. examples: PosttagsinfoRequestExample: summary: Default postTagsInfo request x-microcks-default: true value: key: example_value tag: example_value responses: '200': description: Detailed information about the tag. content: application/json: schema: $ref: '#/components/schemas/TagInfo' examples: Posttagsinfo200Example: summary: Default postTagsInfo 200 response x-microcks-default: true value: tag: example_value reputation: 10 sent: 10 hard_bounces: 10 soft_bounces: 10 rejects: 10 complaints: 10 unsubs: 10 opens: 10 clicks: 10 unique_opens: 10 unique_clicks: 10 '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /tags/delete: post: operationId: postTagsDelete summary: Mailchimp Delete a Tag description: >- Delete a tag permanently. Deleting a tag removes it from all messages that have been tagged with it, and permanently removes the tag statistics. tags: [] requestBody: required: true content: application/json: schema: type: object required: - key - tag properties: key: type: string description: A valid Mandrill API key. tag: type: string description: The tag name to delete. examples: PosttagsdeleteRequestExample: summary: Default postTagsDelete request x-microcks-default: true value: key: example_value tag: example_value responses: '200': description: The deleted tag object. content: application/json: schema: $ref: '#/components/schemas/TagInfo' examples: Posttagsdelete200Example: summary: Default postTagsDelete 200 response x-microcks-default: true value: tag: example_value reputation: 10 sent: 10 hard_bounces: 10 soft_bounces: 10 rejects: 10 complaints: 10 unsubs: 10 opens: 10 clicks: 10 unique_opens: 10 unique_clicks: 10 '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /tags/time-series: post: operationId: postTagsTimeSeries summary: Mailchimp Get Tag Time Series description: >- Return the recent sending history for a tag, aggregated by hourly time slots. tags: [] requestBody: required: true content: application/json: schema: type: object required: - key - tag properties: key: type: string description: A valid Mandrill API key. tag: type: string description: The tag name to retrieve time series for. examples: PosttagstimeseriesRequestExample: summary: Default postTagsTimeSeries request x-microcks-default: true value: key: example_value tag: example_value responses: '200': description: An array of time series data for the tag. content: application/json: schema: type: array items: $ref: '#/components/schemas/TimeSeries' examples: Posttagstimeseries200Example: summary: Default postTagsTimeSeries 200 response x-microcks-default: true value: - time: '2026-01-15T10:30:00Z' sent: 10 hard_bounces: 10 soft_bounces: 10 rejects: 10 complaints: 10 unsubs: 10 opens: 10 unique_opens: 10 clicks: 10 unique_clicks: 10 '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /tags/all-time-series: post: operationId: postTagsAllTimeSeries summary: Mailchimp Get All Tags Time Series description: >- Return hourly aggregated statistics for all tags in the account over the last 30 days. tags: [] requestBody: required: true content: application/json: schema: type: object required: - key properties: key: type: string description: A valid Mandrill API key. examples: PosttagsalltimeseriesRequestExample: summary: Default postTagsAllTimeSeries request x-microcks-default: true value: key: example_value responses: '200': description: An array of time series data points. content: application/json: schema: type: array items: $ref: '#/components/schemas/TimeSeries' examples: Posttagsalltimeseries200Example: summary: Default postTagsAllTimeSeries 200 response x-microcks-default: true value: - time: '2026-01-15T10:30:00Z' sent: 10 hard_bounces: 10 soft_bounces: 10 rejects: 10 complaints: 10 unsubs: 10 opens: 10 unique_opens: 10 clicks: 10 unique_clicks: 10 '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /senders/list: post: operationId: postSendersList summary: Mailchimp List Senders description: >- Get the list of all sender email addresses that have been used in the account, with aggregate statistics for each sender. tags: - Senders requestBody: required: true content: application/json: schema: type: object required: - key properties: key: type: string description: A valid Mandrill API key. examples: PostsenderslistRequestExample: summary: Default postSendersList request x-microcks-default: true value: key: example_value responses: '200': description: An array of sender objects with statistics. content: application/json: schema: type: array items: $ref: '#/components/schemas/SenderInfo' examples: Postsenderslist200Example: summary: Default postSendersList 200 response x-microcks-default: true value: - address: example_value created_at: '2026-01-15T10:30:00Z' sent: 10 hard_bounces: 10 soft_bounces: 10 rejects: 10 complaints: 10 unsubs: 10 opens: 10 clicks: 10 unique_opens: 10 unique_clicks: 10 '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /senders/domains: post: operationId: postSendersDomains summary: Mailchimp List Sender Domains description: >- Get the list of sender domains that have been configured for the account, including DKIM and SPF verification status. tags: - Senders requestBody: required: true content: application/json: schema: type: object required: - key properties: key: type: string description: A valid Mandrill API key. examples: PostsendersdomainsRequestExample: summary: Default postSendersDomains request x-microcks-default: true value: key: example_value responses: '200': description: An array of sender domain objects. content: application/json: schema: type: array items: $ref: '#/components/schemas/SenderDomain' examples: Postsendersdomains200Example: summary: Default postSendersDomains 200 response x-microcks-default: true value: - domain: example_value created_at: '2026-01-15T10:30:00Z' last_tested_at: '2026-01-15T10:30:00Z' spf: valid: '500123' valid_after: '2026-01-15T10:30:00Z' error: example_value dkim: valid: '500123' valid_after: '2026-01-15T10:30:00Z' error: example_value verified_at: '2026-01-15T10:30:00Z' valid_signing: true '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /senders/add-domain: post: operationId: postSendersAddDomain summary: Mailchimp Add a Sender Domain description: Add a new sender domain to the account for verification. tags: - Senders requestBody: required: true content: application/json: schema: type: object required: - key - domain properties: key: type: string description: A valid Mandrill API key. domain: type: string description: The domain name to add. examples: PostsendersadddomainRequestExample: summary: Default postSendersAddDomain request x-microcks-default: true value: key: example_value domain: example_value responses: '200': description: The newly added domain details. content: application/json: schema: $ref: '#/components/schemas/SenderDomain' examples: Postsendersadddomain200Example: summary: Default postSendersAddDomain 200 response x-microcks-default: true value: domain: example_value created_at: '2026-01-15T10:30:00Z' last_tested_at: '2026-01-15T10:30:00Z' spf: valid: '500123' valid_after: '2026-01-15T10:30:00Z' error: example_value dkim: valid: '500123' valid_after: '2026-01-15T10:30:00Z' error: example_value verified_at: '2026-01-15T10:30:00Z' valid_signing: true '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /senders/check-domain: post: operationId: postSendersCheckDomain summary: Mailchimp Check a Sender Domain description: >- Check the DNS settings for a sender domain to verify DKIM and SPF configuration status. tags: - Senders requestBody: required: true content: application/json: schema: type: object required: - key - domain properties: key: type: string description: A valid Mandrill API key. domain: type: string description: The domain name to check. examples: PostsenderscheckdomainRequestExample: summary: Default postSendersCheckDomain request x-microcks-default: true value: key: example_value domain: example_value responses: '200': description: The updated domain verification status. content: application/json: schema: $ref: '#/components/schemas/SenderDomain' examples: Postsenderscheckdomain200Example: summary: Default postSendersCheckDomain 200 response x-microcks-default: true value: domain: example_value created_at: '2026-01-15T10:30:00Z' last_tested_at: '2026-01-15T10:30:00Z' spf: valid: '500123' valid_after: '2026-01-15T10:30:00Z' error: example_value dkim: valid: '500123' valid_after: '2026-01-15T10:30:00Z' error: example_value verified_at: '2026-01-15T10:30:00Z' valid_signing: true '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /senders/verify-domain: post: operationId: postSendersVerifyDomain summary: Mailchimp Verify a Sender Domain description: >- Send a verification email to the specified mailbox at the domain to confirm domain ownership. tags: - Senders requestBody: required: true content: application/json: schema: type: object required: - key - domain - mailbox properties: key: type: string description: A valid Mandrill API key. domain: type: string description: The domain name to verify. mailbox: type: string description: >- The mailbox at the domain to which the verification email will be sent (e.g., postmaster). examples: PostsendersverifydomainRequestExample: summary: Default postSendersVerifyDomain request x-microcks-default: true value: key: example_value domain: example_value mailbox: example_value responses: '200': description: Verification status. content: application/json: schema: type: object properties: status: type: string description: The verification status. domain: type: string description: The domain being verified. email: type: string description: >- The email address where the verification message was sent. examples: Postsendersverifydomain200Example: summary: Default postSendersVerifyDomain 200 response x-microcks-default: true value: status: example_value domain: example_value email: user@example.com '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /senders/info: post: operationId: postSendersInfo summary: Mailchimp Get Sender Info description: >- Get detailed information for a single sender address, including aggregate sending statistics. tags: - Senders requestBody: required: true content: application/json: schema: type: object required: - key - address properties: key: type: string description: A valid Mandrill API key. address: type: string format: email description: The email address of the sender to retrieve info for. examples: PostsendersinfoRequestExample: summary: Default postSendersInfo request x-microcks-default: true value: key: example_value address: example_value responses: '200': description: The sender details. content: application/json: schema: $ref: '#/components/schemas/SenderInfo' examples: Postsendersinfo200Example: summary: Default postSendersInfo 200 response x-microcks-default: true value: address: example_value created_at: '2026-01-15T10:30:00Z' sent: 10 hard_bounces: 10 soft_bounces: 10 rejects: 10 complaints: 10 unsubs: 10 opens: 10 clicks: 10 unique_opens: 10 unique_clicks: 10 '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /senders/time-series: post: operationId: postSendersTimeSeries summary: Mailchimp Get Sender Time Series description: >- Return the recent sending history for a sender address, aggregated by hourly time slots. tags: - Senders requestBody: required: true content: application/json: schema: type: object required: - key - address properties: key: type: string description: A valid Mandrill API key. address: type: string format: email description: The sender address for time series data. examples: PostsenderstimeseriesRequestExample: summary: Default postSendersTimeSeries request x-microcks-default: true value: key: example_value address: example_value responses: '200': description: An array of time series data for the sender. content: application/json: schema: type: array items: $ref: '#/components/schemas/TimeSeries' examples: Postsenderstimeseries200Example: summary: Default postSendersTimeSeries 200 response x-microcks-default: true value: - time: '2026-01-15T10:30:00Z' sent: 10 hard_bounces: 10 soft_bounces: 10 rejects: 10 complaints: 10 unsubs: 10 opens: 10 unique_opens: 10 clicks: 10 unique_clicks: 10 '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /users/info: post: operationId: postUsersInfo summary: Mailchimp Get User Info description: >- Return the information about the API-connected user, including username, reputation, hourly quota, and account-level statistics. tags: - Users requestBody: required: true content: application/json: schema: type: object required: - key properties: key: type: string description: A valid Mandrill API key. examples: PostusersinfoRequestExample: summary: Default postUsersInfo request x-microcks-default: true value: key: example_value responses: '200': description: Account information for the authenticated user. content: application/json: schema: $ref: '#/components/schemas/UserInfo' examples: Postusersinfo200Example: summary: Default postUsersInfo 200 response x-microcks-default: true value: username: example_value created_at: '2026-01-15T10:30:00Z' public_id: '500123' reputation: 10 hourly_quota: https://www.example.com backlog: 10 stats: today: sent: 10 hard_bounces: 10 soft_bounces: 10 rejects: 10 complaints: 10 unsubs: 10 opens: 10 unique_opens: 10 clicks: 10 unique_clicks: 10 last_7_days: sent: 10 hard_bounces: 10 soft_bounces: 10 rejects: 10 complaints: 10 unsubs: 10 opens: 10 unique_opens: 10 clicks: 10 unique_clicks: 10 last_30_days: sent: 10 hard_bounces: 10 soft_bounces: 10 rejects: 10 complaints: 10 unsubs: 10 opens: 10 unique_opens: 10 clicks: 10 unique_clicks: 10 last_60_days: sent: 10 hard_bounces: 10 soft_bounces: 10 rejects: 10 complaints: 10 unsubs: 10 opens: 10 unique_opens: 10 clicks: 10 unique_clicks: 10 last_90_days: sent: 10 hard_bounces: 10 soft_bounces: 10 rejects: 10 complaints: 10 unsubs: 10 opens: 10 unique_opens: 10 clicks: 10 unique_clicks: 10 all_time: sent: 10 hard_bounces: 10 soft_bounces: 10 rejects: 10 complaints: 10 unsubs: 10 opens: 10 unique_opens: 10 clicks: 10 unique_clicks: 10 '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /users/ping: post: operationId: postUsersPing summary: Mailchimp Ping the Api description: >- Validate an API key and respond to a ping. Returns the string PONG! if the API key is valid. tags: - Users requestBody: required: true content: application/json: schema: type: object required: - key properties: key: type: string description: A valid Mandrill API key. examples: PostuserspingRequestExample: summary: Default postUsersPing request x-microcks-default: true value: key: example_value responses: '200': description: A successful ping response. content: application/json: schema: type: string example: PONG! description: The string PONG! confirming a valid API key. examples: Postusersping200Example: summary: Default postUsersPing 200 response x-microcks-default: true value: example_value '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /users/senders: post: operationId: postUsersSenders summary: Mailchimp List Account Senders description: >- Return the senders that have tried to use this account, both verified and unverified. tags: - Users requestBody: required: true content: application/json: schema: type: object required: - key properties: key: type: string description: A valid Mandrill API key. examples: PostuserssendersRequestExample: summary: Default postUsersSenders request x-microcks-default: true value: key: example_value responses: '200': description: An array of sender objects. content: application/json: schema: type: array items: $ref: '#/components/schemas/SenderInfo' examples: Postuserssenders200Example: summary: Default postUsersSenders 200 response x-microcks-default: true value: - address: example_value created_at: '2026-01-15T10:30:00Z' sent: 10 hard_bounces: 10 soft_bounces: 10 rejects: 10 complaints: 10 unsubs: 10 opens: 10 clicks: 10 unique_opens: 10 unique_clicks: 10 '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /webhooks/list: post: operationId: postWebhooksList summary: Mailchimp List Webhooks description: Get the list of all configured webhooks for the account. tags: - Webhooks requestBody: required: true content: application/json: schema: type: object required: - key properties: key: type: string description: A valid Mandrill API key. examples: PostwebhookslistRequestExample: summary: Default postWebhooksList request x-microcks-default: true value: key: example_value responses: '200': description: An array of webhook objects. content: application/json: schema: type: array items: $ref: '#/components/schemas/WebhookInfo' examples: Postwebhookslist200Example: summary: Default postWebhooksList 200 response x-microcks-default: true value: - id: abc123 url: https://www.example.com description: A sample description. auth_key: example_value events: - send created_at: '2026-01-15T10:30:00Z' last_sent_at: '2026-01-15T10:30:00Z' batches_sent: 10 events_sent: 10 last_error: example_value '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /webhooks/add: post: operationId: postWebhooksAdd summary: Mailchimp Add a Webhook description: >- Create a new webhook. Mandrill will attempt a HEAD request to the provided URL to verify the webhook endpoint. tags: - Webhooks requestBody: required: true content: application/json: schema: type: object required: - key - url properties: key: type: string description: A valid Mandrill API key. url: type: string format: uri description: The URL the webhook should POST event batches to. description: type: string description: An optional description of the webhook. events: type: array items: type: string enum: - send - hard_bounce - soft_bounce - open - click - spam - unsub - reject - deferral description: >- The message events that should trigger the webhook. If empty, all events will be sent. examples: PostwebhooksaddRequestExample: summary: Default postWebhooksAdd request x-microcks-default: true value: key: example_value url: https://www.example.com description: A sample description. events: - send responses: '200': description: The newly created webhook details. content: application/json: schema: $ref: '#/components/schemas/WebhookInfo' examples: Postwebhooksadd200Example: summary: Default postWebhooksAdd 200 response x-microcks-default: true value: id: abc123 url: https://www.example.com description: A sample description. auth_key: example_value events: - send created_at: '2026-01-15T10:30:00Z' last_sent_at: '2026-01-15T10:30:00Z' batches_sent: 10 events_sent: 10 last_error: example_value '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /webhooks/info: post: operationId: postWebhooksInfo summary: Mailchimp Get Webhook Info description: Get the details for a specific webhook by its unique ID. tags: - Webhooks requestBody: required: true content: application/json: schema: type: object required: - key - id properties: key: type: string description: A valid Mandrill API key. id: type: integer description: The unique identifier of the webhook. examples: PostwebhooksinfoRequestExample: summary: Default postWebhooksInfo request x-microcks-default: true value: key: example_value id: abc123 responses: '200': description: The webhook details. content: application/json: schema: $ref: '#/components/schemas/WebhookInfo' examples: Postwebhooksinfo200Example: summary: Default postWebhooksInfo 200 response x-microcks-default: true value: id: abc123 url: https://www.example.com description: A sample description. auth_key: example_value events: - send created_at: '2026-01-15T10:30:00Z' last_sent_at: '2026-01-15T10:30:00Z' batches_sent: 10 events_sent: 10 last_error: example_value '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /webhooks/update: post: operationId: postWebhooksUpdate summary: Mailchimp Update a Webhook description: Update the URL, description, or events for an existing webhook. tags: - Webhooks requestBody: required: true content: application/json: schema: type: object required: - key - id - url properties: key: type: string description: A valid Mandrill API key. id: type: integer description: The unique identifier of the webhook to update. url: type: string format: uri description: The new URL for the webhook. description: type: string description: Updated description. events: type: array items: type: string enum: - send - hard_bounce - soft_bounce - open - click - spam - unsub - reject - deferral description: Updated list of events that trigger the webhook. examples: PostwebhooksupdateRequestExample: summary: Default postWebhooksUpdate request x-microcks-default: true value: key: example_value id: abc123 url: https://www.example.com description: A sample description. events: - send responses: '200': description: The updated webhook details. content: application/json: schema: $ref: '#/components/schemas/WebhookInfo' examples: Postwebhooksupdate200Example: summary: Default postWebhooksUpdate 200 response x-microcks-default: true value: id: abc123 url: https://www.example.com description: A sample description. auth_key: example_value events: - send created_at: '2026-01-15T10:30:00Z' last_sent_at: '2026-01-15T10:30:00Z' batches_sent: 10 events_sent: 10 last_error: example_value '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /webhooks/delete: post: operationId: postWebhooksDelete summary: Mailchimp Delete a Webhook description: Permanently delete a webhook by its unique ID. tags: - Webhooks requestBody: required: true content: application/json: schema: type: object required: - key - id properties: key: type: string description: A valid Mandrill API key. id: type: integer description: The unique identifier of the webhook to delete. examples: PostwebhooksdeleteRequestExample: summary: Default postWebhooksDelete request x-microcks-default: true value: key: example_value id: abc123 responses: '200': description: The deleted webhook details. content: application/json: schema: $ref: '#/components/schemas/WebhookInfo' examples: Postwebhooksdelete200Example: summary: Default postWebhooksDelete 200 response x-microcks-default: true value: id: abc123 url: https://www.example.com description: A sample description. auth_key: example_value events: - send created_at: '2026-01-15T10:30:00Z' last_sent_at: '2026-01-15T10:30:00Z' batches_sent: 10 events_sent: 10 last_error: example_value '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /subaccounts/list: post: operationId: postSubaccountsList summary: Mailchimp List Subaccounts description: Get the list of subaccounts defined for the account. tags: - Subaccounts requestBody: required: true content: application/json: schema: type: object required: - key properties: key: type: string description: A valid Mandrill API key. q: type: string description: Optional prefix to filter subaccounts by ID or name. examples: PostsubaccountslistRequestExample: summary: Default postSubaccountsList request x-microcks-default: true value: key: example_value q: example_value responses: '200': description: An array of subaccount objects. content: application/json: schema: type: array items: $ref: '#/components/schemas/SubaccountInfo' examples: Postsubaccountslist200Example: summary: Default postSubaccountsList 200 response x-microcks-default: true value: - id: abc123 name: Example Title notes: example_value custom_quota: 10 status: active reputation: 10 created_at: '2026-01-15T10:30:00Z' first_sent_at: '2026-01-15T10:30:00Z' sent_weekly: 10 sent_monthly: 10 sent_total: 10 '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /subaccounts/add: post: operationId: postSubaccountsAdd summary: Mailchimp Add a Subaccount description: Create a new subaccount under the main account. tags: - Subaccounts requestBody: required: true content: application/json: schema: type: object required: - key - id properties: key: type: string description: A valid Mandrill API key. id: type: string description: A unique identifier for the new subaccount (max 255 chars). name: type: string description: An optional display name for the subaccount. notes: type: string description: Optional notes about the subaccount. custom_quota: type: integer description: >- An optional manual hourly quota for the subaccount. If not specified, the subaccount shares the parent account quota. examples: PostsubaccountsaddRequestExample: summary: Default postSubaccountsAdd request x-microcks-default: true value: key: example_value id: abc123 name: Example Title notes: example_value custom_quota: 10 responses: '200': description: The newly created subaccount details. content: application/json: schema: $ref: '#/components/schemas/SubaccountInfo' examples: Postsubaccountsadd200Example: summary: Default postSubaccountsAdd 200 response x-microcks-default: true value: id: abc123 name: Example Title notes: example_value custom_quota: 10 status: active reputation: 10 created_at: '2026-01-15T10:30:00Z' first_sent_at: '2026-01-15T10:30:00Z' sent_weekly: 10 sent_monthly: 10 sent_total: 10 '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /subaccounts/info: post: operationId: postSubaccountsInfo summary: Mailchimp Get Subaccount Info description: Get detailed information about a specific subaccount. tags: - Subaccounts requestBody: required: true content: application/json: schema: type: object required: - key - id properties: key: type: string description: A valid Mandrill API key. id: type: string description: The unique identifier for the subaccount. examples: PostsubaccountsinfoRequestExample: summary: Default postSubaccountsInfo request x-microcks-default: true value: key: example_value id: abc123 responses: '200': description: The subaccount details. content: application/json: schema: $ref: '#/components/schemas/SubaccountInfo' examples: Postsubaccountsinfo200Example: summary: Default postSubaccountsInfo 200 response x-microcks-default: true value: id: abc123 name: Example Title notes: example_value custom_quota: 10 status: active reputation: 10 created_at: '2026-01-15T10:30:00Z' first_sent_at: '2026-01-15T10:30:00Z' sent_weekly: 10 sent_monthly: 10 sent_total: 10 '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /subaccounts/update: post: operationId: postSubaccountsUpdate summary: Mailchimp Update a Subaccount description: Update an existing subaccount's name, notes, or quota. tags: - Subaccounts requestBody: required: true content: application/json: schema: type: object required: - key - id properties: key: type: string description: A valid Mandrill API key. id: type: string description: The unique identifier of the subaccount. name: type: string description: Updated display name. notes: type: string description: Updated notes. custom_quota: type: integer description: Updated manual hourly quota. examples: PostsubaccountsupdateRequestExample: summary: Default postSubaccountsUpdate request x-microcks-default: true value: key: example_value id: abc123 name: Example Title notes: example_value custom_quota: 10 responses: '200': description: The updated subaccount details. content: application/json: schema: $ref: '#/components/schemas/SubaccountInfo' examples: Postsubaccountsupdate200Example: summary: Default postSubaccountsUpdate 200 response x-microcks-default: true value: id: abc123 name: Example Title notes: example_value custom_quota: 10 status: active reputation: 10 created_at: '2026-01-15T10:30:00Z' first_sent_at: '2026-01-15T10:30:00Z' sent_weekly: 10 sent_monthly: 10 sent_total: 10 '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /subaccounts/delete: post: operationId: postSubaccountsDelete summary: Mailchimp Delete a Subaccount description: Permanently delete a subaccount. Any future email for the subaccount will be sent from the primary account. tags: - Subaccounts requestBody: required: true content: application/json: schema: type: object required: - key - id properties: key: type: string description: A valid Mandrill API key. id: type: string description: The unique identifier of the subaccount to delete. examples: PostsubaccountsdeleteRequestExample: summary: Default postSubaccountsDelete request x-microcks-default: true value: key: example_value id: abc123 responses: '200': description: The deleted subaccount details. content: application/json: schema: $ref: '#/components/schemas/SubaccountInfo' examples: Postsubaccountsdelete200Example: summary: Default postSubaccountsDelete 200 response x-microcks-default: true value: id: abc123 name: Example Title notes: example_value custom_quota: 10 status: active reputation: 10 created_at: '2026-01-15T10:30:00Z' first_sent_at: '2026-01-15T10:30:00Z' sent_weekly: 10 sent_monthly: 10 sent_total: 10 '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /subaccounts/pause: post: operationId: postSubaccountsPause summary: Mailchimp Pause a Subaccount description: >- Pause a subaccount's sending. Any future messages sent through the subaccount will be queued but not delivered until the subaccount is resumed. tags: - Subaccounts requestBody: required: true content: application/json: schema: type: object required: - key - id properties: key: type: string description: A valid Mandrill API key. id: type: string description: The unique identifier of the subaccount to pause. examples: PostsubaccountspauseRequestExample: summary: Default postSubaccountsPause request x-microcks-default: true value: key: example_value id: abc123 responses: '200': description: The paused subaccount details. content: application/json: schema: $ref: '#/components/schemas/SubaccountInfo' examples: Postsubaccountspause200Example: summary: Default postSubaccountsPause 200 response x-microcks-default: true value: id: abc123 name: Example Title notes: example_value custom_quota: 10 status: active reputation: 10 created_at: '2026-01-15T10:30:00Z' first_sent_at: '2026-01-15T10:30:00Z' sent_weekly: 10 sent_monthly: 10 sent_total: 10 '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /subaccounts/resume: post: operationId: postSubaccountsResume summary: Mailchimp Resume a Subaccount description: >- Resume a paused subaccount, allowing it to send messages again. tags: - Subaccounts requestBody: required: true content: application/json: schema: type: object required: - key - id properties: key: type: string description: A valid Mandrill API key. id: type: string description: The unique identifier of the subaccount to resume. examples: PostsubaccountsresumeRequestExample: summary: Default postSubaccountsResume request x-microcks-default: true value: key: example_value id: abc123 responses: '200': description: The resumed subaccount details. content: application/json: schema: $ref: '#/components/schemas/SubaccountInfo' examples: Postsubaccountsresume200Example: summary: Default postSubaccountsResume 200 response x-microcks-default: true value: id: abc123 name: Example Title notes: example_value custom_quota: 10 status: active reputation: 10 created_at: '2026-01-15T10:30:00Z' first_sent_at: '2026-01-15T10:30:00Z' sent_weekly: 10 sent_monthly: 10 sent_total: 10 '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /rejects/list: post: operationId: postRejectsList summary: Mailchimp List Rejections description: >- Retrieve all entries in the rejection blacklist. These are email addresses that have previously hard-bounced or been reported as spam, and will be automatically rejected. tags: - Rejects requestBody: required: true content: application/json: schema: type: object required: - key properties: key: type: string description: A valid Mandrill API key. email: type: string format: email description: Optional email address or prefix to filter results. include_expired: type: boolean default: false description: Whether to include expired rejections. subaccount: type: string description: Optional subaccount ID to restrict results. examples: PostrejectslistRequestExample: summary: Default postRejectsList request x-microcks-default: true value: key: example_value email: user@example.com include_expired: true subaccount: example_value responses: '200': description: An array of rejection entries. content: application/json: schema: type: array items: $ref: '#/components/schemas/RejectEntry' examples: Postrejectslist200Example: summary: Default postRejectsList 200 response x-microcks-default: true value: - email: user@example.com reason: hard-bounce detail: example_value created_at: '2026-01-15T10:30:00Z' last_event_at: '2026-01-15T10:30:00Z' expires_at: '2026-01-15T10:30:00Z' expired: true subaccount: example_value sender: address: example_value created_at: '2026-01-15T10:30:00Z' sent: 10 hard_bounces: 10 soft_bounces: 10 rejects: 10 complaints: 10 unsubs: 10 opens: 10 clicks: 10 '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /rejects/add: post: operationId: postRejectsAdd summary: Mailchimp Add a Rejection description: >- Manually add an email address to the rejection blacklist. Messages to this address will be rejected. tags: - Rejects requestBody: required: true content: application/json: schema: type: object required: - key - email properties: key: type: string description: A valid Mandrill API key. email: type: string format: email description: The email address to block. comment: type: string description: An optional comment about why the address was blacklisted. subaccount: type: string description: Optional subaccount to restrict the rejection to. examples: PostrejectsaddRequestExample: summary: Default postRejectsAdd request x-microcks-default: true value: key: example_value email: user@example.com comment: example_value subaccount: example_value responses: '200': description: Details about the newly added rejection. content: application/json: schema: type: object properties: email: type: string description: The email address that was added. added: type: boolean description: Whether the address was added to the blacklist. examples: Postrejectsadd200Example: summary: Default postRejectsAdd 200 response x-microcks-default: true value: email: user@example.com added: true '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /rejects/delete: post: operationId: postRejectsDelete summary: Mailchimp Delete a Rejection description: >- Remove an email address from the rejection blacklist, allowing messages to be delivered to it again. tags: - Rejects requestBody: required: true content: application/json: schema: type: object required: - key - email properties: key: type: string description: A valid Mandrill API key. email: type: string format: email description: The email address to remove from the blacklist. subaccount: type: string description: Optional subaccount that the rejection applies to. examples: PostrejectsdeleteRequestExample: summary: Default postRejectsDelete request x-microcks-default: true value: key: example_value email: user@example.com subaccount: example_value responses: '200': description: Details about the removed rejection. content: application/json: schema: type: object properties: email: type: string description: The email address that was removed. deleted: type: boolean description: Whether the address was removed from the blacklist. subaccount: type: string description: The subaccount blacklist the deletion applied to. examples: Postrejectsdelete200Example: summary: Default postRejectsDelete 200 response x-microcks-default: true value: email: user@example.com deleted: true subaccount: example_value '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /allowlists/list: post: operationId: postAllowlistsList summary: Mailchimp List Allowlist Entries description: >- Get all email addresses on the account allowlist. Allowlisted addresses bypass the rejection blacklist. tags: - Allowlists requestBody: required: true content: application/json: schema: type: object required: - key properties: key: type: string description: A valid Mandrill API key. email: type: string format: email description: Optional email address or prefix to filter results. examples: PostallowlistslistRequestExample: summary: Default postAllowlistsList request x-microcks-default: true value: key: example_value email: user@example.com responses: '200': description: An array of allowlist entries. content: application/json: schema: type: array items: $ref: '#/components/schemas/AllowlistEntry' examples: Postallowlistslist200Example: summary: Default postAllowlistsList 200 response x-microcks-default: true value: - email: user@example.com detail: example_value created_at: '2026-01-15T10:30:00Z' '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /allowlists/add: post: operationId: postAllowlistsAdd summary: Mailchimp Add an Allowlist Entry description: >- Add an email address to the allowlist, allowing messages to bypass the rejection blacklist. tags: - Allowlists requestBody: required: true content: application/json: schema: type: object required: - key - email properties: key: type: string description: A valid Mandrill API key. email: type: string format: email description: The email address to add to the allowlist. comment: type: string description: An optional comment about why the address was allowlisted. examples: PostallowlistsaddRequestExample: summary: Default postAllowlistsAdd request x-microcks-default: true value: key: example_value email: user@example.com comment: example_value responses: '200': description: Details about the allowlist addition. content: application/json: schema: type: object properties: email: type: string description: The email address added. added: type: boolean description: Whether the address was added. examples: Postallowlistsadd200Example: summary: Default postAllowlistsAdd 200 response x-microcks-default: true value: email: user@example.com added: true '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /allowlists/delete: post: operationId: postAllowlistsDelete summary: Mailchimp Delete an Allowlist Entry description: >- Remove an email address from the allowlist. The address will no longer bypass the rejection blacklist. tags: - Allowlists requestBody: required: true content: application/json: schema: type: object required: - key - email properties: key: type: string description: A valid Mandrill API key. email: type: string format: email description: The email address to remove from the allowlist. examples: PostallowlistsdeleteRequestExample: summary: Default postAllowlistsDelete request x-microcks-default: true value: key: example_value email: user@example.com responses: '200': description: Details about the allowlist removal. content: application/json: schema: type: object properties: email: type: string description: The email address removed. deleted: type: boolean description: Whether the address was removed. examples: Postallowlistsdelete200Example: summary: Default postAllowlistsDelete 200 response x-microcks-default: true value: email: user@example.com deleted: true '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /ips/list: post: operationId: postIpsList summary: Mailchimp List Dedicated Ips description: >- Get the list of dedicated IP addresses associated with the account, including their pool assignments, warmup status, and sending statistics. tags: - IPs requestBody: required: true content: application/json: schema: type: object required: - key properties: key: type: string description: A valid Mandrill API key. examples: PostipslistRequestExample: summary: Default postIpsList request x-microcks-default: true value: key: example_value responses: '200': description: An array of dedicated IP objects. content: application/json: schema: type: array items: $ref: '#/components/schemas/DedicatedIP' examples: Postipslist200Example: summary: Default postIpsList 200 response x-microcks-default: true value: - ip: example_value created_at: '2026-01-15T10:30:00Z' pool: example_value domain: example_value custom_dns: enabled: true valid: '500123' error: example_value warmup: warming_up: true start_at: '2026-01-15T10:30:00Z' end_at: '2026-01-15T10:30:00Z' '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /ips/info: post: operationId: postIpsInfo summary: Mailchimp Get Ip Info description: Get detailed information about a specific dedicated IP address. tags: - IPs requestBody: required: true content: application/json: schema: type: object required: - key - ip properties: key: type: string description: A valid Mandrill API key. ip: type: string description: The dedicated IP address. examples: PostipsinfoRequestExample: summary: Default postIpsInfo request x-microcks-default: true value: key: example_value ip: example_value responses: '200': description: The dedicated IP details. content: application/json: schema: $ref: '#/components/schemas/DedicatedIP' examples: Postipsinfo200Example: summary: Default postIpsInfo 200 response x-microcks-default: true value: ip: example_value created_at: '2026-01-15T10:30:00Z' pool: example_value domain: example_value custom_dns: enabled: true valid: '500123' error: example_value warmup: warming_up: true start_at: '2026-01-15T10:30:00Z' end_at: '2026-01-15T10:30:00Z' '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /ips/list-pools: post: operationId: postIpsListPools summary: Mailchimp List Ip Pools description: >- Get the list of IP pools defined for the account, with the IPs assigned to each pool. tags: - IPs requestBody: required: true content: application/json: schema: type: object required: - key properties: key: type: string description: A valid Mandrill API key. examples: PostipslistpoolsRequestExample: summary: Default postIpsListPools request x-microcks-default: true value: key: example_value responses: '200': description: An array of IP pool objects. content: application/json: schema: type: array items: $ref: '#/components/schemas/IPPool' examples: Postipslistpools200Example: summary: Default postIpsListPools 200 response x-microcks-default: true value: - name: Example Title created_at: '2026-01-15T10:30:00Z' ips: - {} '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /ips/create-pool: post: operationId: postIpsCreatePool summary: Mailchimp Create an Ip Pool description: Create a new IP pool for organizing dedicated IPs. tags: - IPs requestBody: required: true content: application/json: schema: type: object required: - key - pool properties: key: type: string description: A valid Mandrill API key. pool: type: string description: The name of the new pool. examples: PostipscreatepoolRequestExample: summary: Default postIpsCreatePool request x-microcks-default: true value: key: example_value pool: example_value responses: '200': description: The newly created IP pool. content: application/json: schema: $ref: '#/components/schemas/IPPool' examples: Postipscreatepool200Example: summary: Default postIpsCreatePool 200 response x-microcks-default: true value: name: Example Title created_at: '2026-01-15T10:30:00Z' ips: - ip: example_value created_at: '2026-01-15T10:30:00Z' pool: example_value domain: example_value custom_dns: {} warmup: {} '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /ips/delete-pool: post: operationId: postIpsDeletePool summary: Mailchimp Delete an Ip Pool description: >- Delete an IP pool. IPs in the pool will be moved to the default pool if one exists. tags: - IPs requestBody: required: true content: application/json: schema: type: object required: - key - pool properties: key: type: string description: A valid Mandrill API key. pool: type: string description: The name of the pool to delete. examples: PostipsdeletepoolRequestExample: summary: Default postIpsDeletePool request x-microcks-default: true value: key: example_value pool: example_value responses: '200': description: Deletion confirmation. content: application/json: schema: type: object properties: pool: type: string description: The name of the pool that was deleted. deleted: type: boolean description: Whether the pool was deleted. examples: Postipsdeletepool200Example: summary: Default postIpsDeletePool 200 response x-microcks-default: true value: pool: example_value deleted: true '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /exports/info: post: operationId: postExportsInfo summary: Mailchimp Get Export Info description: Get information about an individual data export job. tags: - Exports requestBody: required: true content: application/json: schema: type: object required: - key - id properties: key: type: string description: A valid Mandrill API key. id: type: string description: The unique identifier for the export job. examples: PostexportsinfoRequestExample: summary: Default postExportsInfo request x-microcks-default: true value: key: example_value id: abc123 responses: '200': description: The export job details. content: application/json: schema: $ref: '#/components/schemas/ExportJob' examples: Postexportsinfo200Example: summary: Default postExportsInfo 200 response x-microcks-default: true value: id: abc123 created_at: '2026-01-15T10:30:00Z' type: activity finished_at: '2026-01-15T10:30:00Z' state: waiting result_url: https://www.example.com '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /exports/list: post: operationId: postExportsList summary: Mailchimp List Exports description: Get a list of all data export jobs for the account. tags: - Exports requestBody: required: true content: application/json: schema: type: object required: - key properties: key: type: string description: A valid Mandrill API key. examples: PostexportslistRequestExample: summary: Default postExportsList request x-microcks-default: true value: key: example_value responses: '200': description: An array of export job objects. content: application/json: schema: type: array items: $ref: '#/components/schemas/ExportJob' examples: Postexportslist200Example: summary: Default postExportsList 200 response x-microcks-default: true value: - id: abc123 created_at: '2026-01-15T10:30:00Z' type: activity finished_at: '2026-01-15T10:30:00Z' state: waiting result_url: https://www.example.com '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /exports/rejects: post: operationId: postExportsRejects summary: Mailchimp Export Rejections description: >- Start a new export job for the account's rejection blacklist. When complete, a download URL is provided. tags: - Exports requestBody: required: true content: application/json: schema: type: object required: - key properties: key: type: string description: A valid Mandrill API key. notify_email: type: string format: email description: Email address to notify when the export is ready. examples: PostexportsrejectsRequestExample: summary: Default postExportsRejects request x-microcks-default: true value: key: example_value notify_email: user@example.com responses: '200': description: The export job details. content: application/json: schema: $ref: '#/components/schemas/ExportJob' examples: Postexportsrejects200Example: summary: Default postExportsRejects 200 response x-microcks-default: true value: id: abc123 created_at: '2026-01-15T10:30:00Z' type: activity finished_at: '2026-01-15T10:30:00Z' state: waiting result_url: https://www.example.com '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /exports/allowlist: post: operationId: postExportsAllowlist summary: Mailchimp Export Allowlist description: >- Start a new export job for the account's allowlist. When complete, a download URL is provided. tags: - Exports requestBody: required: true content: application/json: schema: type: object required: - key properties: key: type: string description: A valid Mandrill API key. notify_email: type: string format: email description: Email address to notify when the export is ready. examples: PostexportsallowlistRequestExample: summary: Default postExportsAllowlist request x-microcks-default: true value: key: example_value notify_email: user@example.com responses: '200': description: The export job details. content: application/json: schema: $ref: '#/components/schemas/ExportJob' examples: Postexportsallowlist200Example: summary: Default postExportsAllowlist 200 response x-microcks-default: true value: id: abc123 created_at: '2026-01-15T10:30:00Z' type: activity finished_at: '2026-01-15T10:30:00Z' state: waiting result_url: https://www.example.com '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /exports/activity: post: operationId: postExportsActivity summary: Mailchimp Export Message Activity description: >- Start a new export job for message activity history. The export includes detailed message logs for the specified date range. tags: - Exports requestBody: required: true content: application/json: schema: type: object required: - key properties: key: type: string description: A valid Mandrill API key. notify_email: type: string format: email description: Email address to notify when the export is ready. date_from: type: string format: date-time description: Start date for the activity export (UTC). date_to: type: string format: date-time description: End date for the activity export (UTC). tags: type: array items: type: string description: Tags to filter the activity export. senders: type: array items: type: string description: Sender addresses to filter the export. states: type: array items: type: string enum: - sent - rejected - bounced - soft-bounced - spam - unsub description: Message states to include in the export. api_keys: type: array items: type: string description: API keys to filter the export for subaccount isolation. examples: PostexportsactivityRequestExample: summary: Default postExportsActivity request x-microcks-default: true value: key: example_value notify_email: user@example.com date_from: '2026-01-15T10:30:00Z' date_to: '2026-01-15T10:30:00Z' tags: - example_value senders: - example_value states: - sent api_keys: - example_value responses: '200': description: The export job details. content: application/json: schema: $ref: '#/components/schemas/ExportJob' examples: Postexportsactivity200Example: summary: Default postExportsActivity 200 response x-microcks-default: true value: id: abc123 created_at: '2026-01-15T10:30:00Z' type: activity finished_at: '2026-01-15T10:30:00Z' state: waiting result_url: https://www.example.com '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /metadata/list: post: operationId: postMetadataList summary: Mailchimp List Metadata Fields description: >- Get the list of custom metadata fields defined for the account. Metadata fields can be attached to messages for tracking. tags: - Metadata requestBody: required: true content: application/json: schema: type: object required: - key properties: key: type: string description: A valid Mandrill API key. examples: PostmetadatalistRequestExample: summary: Default postMetadataList request x-microcks-default: true value: key: example_value responses: '200': description: An array of metadata field objects. content: application/json: schema: type: array items: $ref: '#/components/schemas/MetadataField' examples: Postmetadatalist200Example: summary: Default postMetadataList 200 response x-microcks-default: true value: - name: Example Title state: active view_template: example_value '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /metadata/add: post: operationId: postMetadataAdd summary: Mailchimp Add a Metadata Field description: >- Add a new custom metadata field that can be indexed and used for filtering in message searches. tags: - Metadata requestBody: required: true content: application/json: schema: type: object required: - key - name properties: key: type: string description: A valid Mandrill API key. name: type: string description: The unique name of the metadata field. view_template: type: string description: >- Mustache template to control how the metadata is displayed in the Mandrill UI. examples: PostmetadataaddRequestExample: summary: Default postMetadataAdd request x-microcks-default: true value: key: example_value name: Example Title view_template: example_value responses: '200': description: The newly created metadata field. content: application/json: schema: $ref: '#/components/schemas/MetadataField' examples: Postmetadataadd200Example: summary: Default postMetadataAdd 200 response x-microcks-default: true value: name: Example Title state: active view_template: example_value '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /metadata/update: post: operationId: postMetadataUpdate summary: Mailchimp Update a Metadata Field description: Update an existing metadata field's display template. tags: - Metadata requestBody: required: true content: application/json: schema: type: object required: - key - name properties: key: type: string description: A valid Mandrill API key. name: type: string description: The unique name of the metadata field to update. view_template: type: string description: Updated Mustache template for displaying the metadata. examples: PostmetadataupdateRequestExample: summary: Default postMetadataUpdate request x-microcks-default: true value: key: example_value name: Example Title view_template: example_value responses: '200': description: The updated metadata field. content: application/json: schema: $ref: '#/components/schemas/MetadataField' examples: Postmetadataupdate200Example: summary: Default postMetadataUpdate 200 response x-microcks-default: true value: name: Example Title state: active view_template: example_value '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /metadata/delete: post: operationId: postMetadataDelete summary: Mailchimp Delete a Metadata Field description: >- Permanently delete a metadata field. Metadata attached to messages using this field will no longer be searchable. tags: - Metadata requestBody: required: true content: application/json: schema: type: object required: - key - name properties: key: type: string description: A valid Mandrill API key. name: type: string description: The unique name of the metadata field to delete. examples: PostmetadatadeleteRequestExample: summary: Default postMetadataDelete request x-microcks-default: true value: key: example_value name: Example Title responses: '200': description: The deleted metadata field. content: application/json: schema: $ref: '#/components/schemas/MetadataField' examples: Postmetadatadelete200Example: summary: Default postMetadataDelete 200 response x-microcks-default: true value: name: Example Title state: active view_template: example_value '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/InvalidKeyError' '500': $ref: '#/components/responses/GeneralError' x-microcks-operation: delay: 0 dispatcher: FALLBACK components: securitySchemes: apiKey: type: apiKey in: header name: X-MC-ApiKey description: >- Mandrill uses API key authentication. The key is passed in the JSON request body as the "key" parameter for every call, or alternatively via the X-MC-ApiKey header. responses: ValidationError: description: The request parameters were invalid. content: application/json: schema: $ref: '#/components/schemas/Error' InvalidKeyError: description: The provided API key is not valid. content: application/json: schema: $ref: '#/components/schemas/Error' GeneralError: description: An unexpected error occurred on the server. content: application/json: schema: $ref: '#/components/schemas/Error' schemas: Error: type: object description: A standard error response from the Mandrill API. properties: status: type: string enum: - error description: Always "error" for error responses. example: error code: type: integer description: The numeric error code. example: 10 name: type: string description: The name/type of the error (e.g., Invalid_Key, ValidationError). example: Example Title message: type: string description: A human-readable description of the error. example: example_value MessagePayload: type: object description: >- The message object containing all parameters for a transactional email, including recipients, content, attachments, and tracking options. properties: html: type: string description: The full HTML content of the message. example: example_value text: type: string description: The full plain-text content of the message. example: example_value subject: type: string description: The message subject line. example: example_value from_email: type: string format: email description: The sender email address. example: user@example.com from_name: type: string description: The sender display name. example: example_value to: type: array description: An array of recipient objects. items: type: object required: - email properties: email: type: string format: email description: The recipient email address. name: type: string description: The recipient display name. type: type: string enum: - to - cc - bcc default: to description: The recipient type (to, cc, or bcc). example: [] headers: type: object additionalProperties: type: string description: Optional extra headers to add to the message (e.g., Reply-To). example: example_value important: type: boolean default: false description: Whether this message is important and should be delivered ahead of non-important messages. example: true track_opens: type: boolean description: Whether to enable open tracking for this message. example: true track_clicks: type: boolean description: Whether to enable click tracking for this message. example: true auto_text: type: boolean description: >- Whether to automatically generate a plain-text version from the HTML content. example: true auto_html: type: boolean description: >- Whether to automatically generate HTML from the plain-text content. example: true inline_css: type: boolean description: >- Whether to automatically inline all CSS styles from style blocks in the HTML content. example: true url_strip_qs: type: boolean description: Whether to strip query strings from URLs when aggregating tracked click data. example: https://www.example.com preserve_recipients: type: boolean description: Whether to show all recipients in the To header of each email. example: true view_content_link: type: boolean description: Whether to include a View Content Link in the Mandrill dashboard for this message. example: true bcc_address: type: string format: email description: An optional address to BCC on the message. example: example_value tracking_domain: type: string description: A custom domain to use for tracking opens and clicks. example: example_value signing_domain: type: string description: A custom domain to use for DKIM signing instead of the default. example: example_value return_path_domain: type: string description: A custom domain to use for the return-path header. example: example_value merge: type: boolean default: true description: Whether to evaluate merge tags in the message. example: true merge_language: type: string enum: - mailchimp - handlebars default: mailchimp description: The merge tag language to use (Mailchimp or Handlebars). example: mailchimp global_merge_vars: type: array description: Global merge variables applied to all recipients. items: type: object properties: name: type: string description: The global merge variable name. content: type: string description: The global merge variable value. example: [] merge_vars: type: array description: Per-recipient merge variables. items: type: object properties: rcpt: type: string format: email description: The recipient email address. vars: type: array items: type: object properties: name: type: string description: The merge variable name. content: type: string description: The merge variable value. example: [] tags: type: array items: type: string description: An array of string tags to apply to this message for analytics. example: [] subaccount: type: string description: The unique ID of a subaccount for this message. example: example_value google_analytics_domains: type: array items: type: string description: An array of domains for which Google Analytics tracking parameters will be appended. example: [] google_analytics_campaign: type: string description: The utm_campaign tracking parameter for Google Analytics. example: example_value metadata: type: object additionalProperties: type: string description: Key-value metadata to associate with the message. example: example_value recipient_metadata: type: array description: Per-recipient metadata. items: type: object properties: rcpt: type: string format: email description: The recipient email address. values: type: object additionalProperties: type: string description: Key-value metadata for this recipient. example: [] attachments: type: array description: An array of file attachments. items: type: object properties: type: type: string description: The MIME type of the attachment. name: type: string description: The file name of the attachment. content: type: string description: Base64-encoded content of the attachment. example: [] images: type: array description: An array of inline images referenced with "cid:" in the HTML content. items: type: object properties: type: type: string description: The MIME type of the image (e.g., image/png). name: type: string description: The Content-ID of the image, referenced as "cid:name" in HTML. content: type: string description: Base64-encoded content of the image. example: [] SendResult: type: object description: The result of sending a message to a single recipient. properties: email: type: string format: email description: The recipient email address. example: user@example.com status: type: string enum: - sent - queued - scheduled - rejected - invalid description: The sending status for this recipient. example: sent reject_reason: type: string enum: - hard-bounce - soft-bounce - spam - unsub - custom - invalid-sender - invalid - test-mode-limit - unsigned - rule description: The reason the message was rejected, if applicable. example: hard-bounce queued_reason: type: string description: The reason the message was queued instead of sent immediately. example: example_value _id: type: string description: The unique message ID for this recipient's message. example: '500123' MessageInfo: type: object description: Summary information about a sent message. properties: ts: type: integer description: The Unix timestamp when the message was sent. example: 10 _id: type: string description: The unique message ID. example: '500123' sender: type: string format: email description: The sender email address. example: example_value template: type: string description: The template slug used, if any. example: example_value subject: type: string description: The subject line of the message. example: example_value email: type: string format: email description: The recipient email address. example: user@example.com tags: type: array items: type: string description: Tags applied to the message. example: [] opens: type: integer description: The number of times the message was opened. example: 10 opens_detail: type: array items: type: object properties: ts: type: integer description: Unix timestamp of the open event. ip: type: string description: IP address from which the message was opened. location: type: string description: Approximate geographic location of the open. ua: type: string description: User agent string of the client. description: Detailed open tracking events. example: [] clicks: type: integer description: The number of link clicks in the message. example: 10 clicks_detail: type: array items: type: object properties: ts: type: integer description: Unix timestamp of the click event. url: type: string description: The URL that was clicked. ip: type: string description: IP address of the clicker. location: type: string description: Approximate geographic location of the click. ua: type: string description: User agent string of the client. description: Detailed click tracking events. example: [] state: type: string enum: - sent - bounced - rejected - soft-bounced - spam - unsub description: The current state of the message. example: sent metadata: type: object additionalProperties: type: string description: Custom metadata attached to the message. example: example_value MessageDetail: type: object description: Detailed information about a specific message. allOf: - $ref: '#/components/schemas/MessageInfo' - type: object properties: smtp_events: type: array description: SMTP event log for the message delivery. items: type: object properties: ts: type: integer description: Unix timestamp of the SMTP event. type: type: string description: The type of SMTP event. diag: type: string description: Diagnostic information from the receiving server. resends: type: array description: A list of resend attempts for this message. items: type: object properties: ts: type: integer description: Unix timestamp of the resend. MessageContent: type: object description: The full content of a sent message. properties: ts: type: integer description: Unix timestamp of when the message was sent. example: 10 _id: type: string description: The unique message ID. example: '500123' from_email: type: string format: email description: The sender email address. example: user@example.com from_name: type: string description: The sender display name. example: example_value subject: type: string description: The message subject line. example: example_value to: type: object properties: email: type: string format: email description: Recipient email address. name: type: string description: Recipient display name. description: The primary recipient. example: example_value tags: type: array items: type: string description: Tags applied to the message. example: [] headers: type: object additionalProperties: type: string description: The full message headers. example: example_value text: type: string description: The plain-text body of the message. example: example_value html: type: string description: The HTML body of the message. example: example_value attachments: type: array items: type: object properties: name: type: string description: The attachment file name. type: type: string description: The MIME type of the attachment. content: type: string description: Base64-encoded attachment content. description: File attachments included in the message. example: [] ParsedMessage: type: object description: A parsed MIME message. properties: subject: type: string description: The parsed subject line. example: example_value from_email: type: string format: email description: The parsed sender email address. example: user@example.com from_name: type: string description: The parsed sender name. example: example_value to: type: array items: type: object properties: email: type: string format: email name: type: string description: Parsed recipient list. example: [] headers: type: object additionalProperties: type: string description: All parsed headers. example: example_value text: type: string description: The plain-text body. example: example_value html: type: string description: The HTML body. example: example_value attachments: type: array items: type: object properties: name: type: string type: type: string content: type: string description: Parsed file attachments. example: [] images: type: array items: type: object properties: name: type: string type: type: string content: type: string description: Parsed inline images. example: [] ScheduledMessage: type: object description: A message scheduled for future delivery. properties: _id: type: string description: The unique scheduled message ID. example: '500123' created_at: type: string format: date-time description: When the scheduled message was created. example: '2026-01-15T10:30:00Z' send_at: type: string format: date-time description: When the message is scheduled to be sent. example: '2026-01-15T10:30:00Z' from_email: type: string format: email description: The sender email address. example: user@example.com to: type: string format: email description: The recipient email address. example: example_value subject: type: string description: The message subject line. example: example_value TemplateInfo: type: object description: Information about a Mandrill template. properties: slug: type: string description: The URL-safe slug for the template. example: example_value name: type: string description: The display name of the template. example: Example Title labels: type: array items: type: string description: Labels applied to the template for organization. example: [] code: type: string description: The HTML code of the template. example: example_value subject: type: string description: The default subject line. example: example_value from_email: type: string format: email description: The default from address. example: user@example.com from_name: type: string description: The default from name. example: example_value text: type: string description: The default text content. example: example_value publish_name: type: string description: The name of the published version. example: example_value publish_code: type: string description: The HTML code of the published version. example: example_value publish_subject: type: string description: The subject of the published version. example: example_value publish_from_email: type: string format: email description: The from address of the published version. example: user@example.com publish_from_name: type: string description: The from name of the published version. example: example_value publish_text: type: string description: The text content of the published version. example: example_value published_at: type: string format: date-time description: When the template was last published. example: '2026-01-15T10:30:00Z' created_at: type: string format: date-time description: When the template was created. example: '2026-01-15T10:30:00Z' updated_at: type: string format: date-time description: When the template was last updated. example: '2026-01-15T10:30:00Z' TagInfo: type: object description: Information and statistics for a message tag. properties: tag: type: string description: The tag name. example: example_value reputation: type: integer description: The reputation score for the tag (0-100). example: 10 sent: type: integer description: Total number of messages sent with this tag. example: 10 hard_bounces: type: integer description: Total hard bounces for messages with this tag. example: 10 soft_bounces: type: integer description: Total soft bounces for messages with this tag. example: 10 rejects: type: integer description: Total rejects for messages with this tag. example: 10 complaints: type: integer description: Total spam complaints for messages with this tag. example: 10 unsubs: type: integer description: Total unsubscribes for messages with this tag. example: 10 opens: type: integer description: Total opens for messages with this tag. example: 10 clicks: type: integer description: Total clicks for messages with this tag. example: 10 unique_opens: type: integer description: Unique opens for messages with this tag. example: 10 unique_clicks: type: integer description: Unique clicks for messages with this tag. example: 10 SenderInfo: type: object description: Information and statistics for a sender address. properties: address: type: string format: email description: The sender email address. example: example_value created_at: type: string format: date-time description: When the sender was first used. example: '2026-01-15T10:30:00Z' sent: type: integer description: Total number of messages sent from this address. example: 10 hard_bounces: type: integer description: Total hard bounces. example: 10 soft_bounces: type: integer description: Total soft bounces. example: 10 rejects: type: integer description: Total rejects. example: 10 complaints: type: integer description: Total spam complaints. example: 10 unsubs: type: integer description: Total unsubscribes. example: 10 opens: type: integer description: Total opens. example: 10 clicks: type: integer description: Total clicks. example: 10 unique_opens: type: integer description: Unique opens. example: 10 unique_clicks: type: integer description: Unique clicks. example: 10 SenderDomain: type: object description: Information about a configured sender domain. properties: domain: type: string description: The domain name. example: example_value created_at: type: string format: date-time description: When the domain was added. example: '2026-01-15T10:30:00Z' last_tested_at: type: string format: date-time description: When the domain settings were last tested. example: '2026-01-15T10:30:00Z' spf: type: object description: SPF verification details. properties: valid: type: boolean description: Whether the SPF record is valid. valid_after: type: string format: date-time description: When the SPF record was verified. error: type: string description: Any SPF verification error. example: example_value dkim: type: object description: DKIM verification details. properties: valid: type: boolean description: Whether the DKIM record is valid. valid_after: type: string format: date-time description: When the DKIM record was verified. error: type: string description: Any DKIM verification error. example: example_value verified_at: type: string format: date-time description: When the domain ownership was verified. example: '2026-01-15T10:30:00Z' valid_signing: type: boolean description: Whether the domain can be used for DKIM signing. example: true TimeSeries: type: object description: An hourly time series data point with sending statistics. properties: time: type: string format: date-time description: The hour this data point covers (UTC). example: '2026-01-15T10:30:00Z' sent: type: integer description: Number of messages sent. example: 10 hard_bounces: type: integer description: Number of hard bounces. example: 10 soft_bounces: type: integer description: Number of soft bounces. example: 10 rejects: type: integer description: Number of rejects. example: 10 complaints: type: integer description: Number of spam complaints. example: 10 unsubs: type: integer description: Number of unsubscribes. example: 10 opens: type: integer description: Number of opens. example: 10 unique_opens: type: integer description: Number of unique opens. example: 10 clicks: type: integer description: Number of clicks. example: 10 unique_clicks: type: integer description: Number of unique clicks. example: 10 UserInfo: type: object description: Account-level information for the authenticated Mandrill user. properties: username: type: string description: The account username. example: example_value created_at: type: string format: date-time description: When the account was created. example: '2026-01-15T10:30:00Z' public_id: type: string description: A unique public identifier for the account. example: '500123' reputation: type: integer description: The account sending reputation (0-100). example: 10 hourly_quota: type: integer description: The hourly email sending quota. example: https://www.example.com backlog: type: integer description: The number of messages in the send queue. example: 10 stats: type: object description: Account-level sending statistics. properties: today: $ref: '#/components/schemas/AccountStats' last_7_days: $ref: '#/components/schemas/AccountStats' last_30_days: $ref: '#/components/schemas/AccountStats' last_60_days: $ref: '#/components/schemas/AccountStats' last_90_days: $ref: '#/components/schemas/AccountStats' all_time: $ref: '#/components/schemas/AccountStats' example: example_value AccountStats: type: object description: Aggregate sending statistics for a time period. properties: sent: type: integer description: Total messages sent. example: 10 hard_bounces: type: integer description: Total hard bounces. example: 10 soft_bounces: type: integer description: Total soft bounces. example: 10 rejects: type: integer description: Total rejections. example: 10 complaints: type: integer description: Total spam complaints. example: 10 unsubs: type: integer description: Total unsubscribes. example: 10 opens: type: integer description: Total opens. example: 10 unique_opens: type: integer description: Unique opens. example: 10 clicks: type: integer description: Total clicks. example: 10 unique_clicks: type: integer description: Unique clicks. example: 10 WebhookInfo: type: object description: Information about a configured webhook. properties: id: type: integer description: The unique webhook identifier. example: abc123 url: type: string format: uri description: The webhook URL. example: https://www.example.com description: type: string description: A description of the webhook. example: A sample description. auth_key: type: string description: >- The key used to generate webhook signatures for verifying webhook authenticity. example: example_value events: type: array items: type: string enum: - send - hard_bounce - soft_bounce - open - click - spam - unsub - reject - deferral description: The events that trigger this webhook. example: [] created_at: type: string format: date-time description: When the webhook was created. example: '2026-01-15T10:30:00Z' last_sent_at: type: string format: date-time description: When the webhook last fired. example: '2026-01-15T10:30:00Z' batches_sent: type: integer description: Total number of event batches sent. example: 10 events_sent: type: integer description: Total number of events sent. example: 10 last_error: type: string description: The last error received from the webhook URL. example: example_value SubaccountInfo: type: object description: Information about a subaccount. properties: id: type: string description: The unique subaccount identifier. example: abc123 name: type: string description: The display name of the subaccount. example: Example Title notes: type: string description: Notes about the subaccount. example: example_value custom_quota: type: integer description: The manual hourly quota, if set. example: 10 status: type: string enum: - active - paused description: The current status of the subaccount. example: active reputation: type: integer description: The subaccount sending reputation (0-100). example: 10 created_at: type: string format: date-time description: When the subaccount was created. example: '2026-01-15T10:30:00Z' first_sent_at: type: string format: date-time description: When the subaccount first sent a message. example: '2026-01-15T10:30:00Z' sent_weekly: type: integer description: Messages sent in the last week. example: 10 sent_monthly: type: integer description: Messages sent in the last month. example: 10 sent_total: type: integer description: Total messages sent. example: 10 RejectEntry: type: object description: An entry in the rejection blacklist. properties: email: type: string format: email description: The rejected email address. example: user@example.com reason: type: string enum: - hard-bounce - soft-bounce - spam - unsub - custom description: The reason the address is on the blacklist. example: hard-bounce detail: type: string description: Extended details about the rejection. example: example_value created_at: type: string format: date-time description: When the entry was added to the blacklist. example: '2026-01-15T10:30:00Z' last_event_at: type: string format: date-time description: When the last event occurred for this address. example: '2026-01-15T10:30:00Z' expires_at: type: string format: date-time description: When the rejection expires (if applicable). example: '2026-01-15T10:30:00Z' expired: type: boolean description: Whether the rejection has expired. example: true subaccount: type: string description: The subaccount this rejection applies to, if any. example: example_value sender: type: object properties: address: type: string format: email created_at: type: string format: date-time sent: type: integer hard_bounces: type: integer soft_bounces: type: integer rejects: type: integer complaints: type: integer unsubs: type: integer opens: type: integer clicks: type: integer description: Sender statistics associated with the rejection. example: example_value AllowlistEntry: type: object description: An entry in the sending allowlist. properties: email: type: string format: email description: The allowlisted email address. example: user@example.com detail: type: string description: Details or comment about why the address is allowlisted. example: example_value created_at: type: string format: date-time description: When the entry was added to the allowlist. example: '2026-01-15T10:30:00Z' DedicatedIP: type: object description: Information about a dedicated IP address. properties: ip: type: string description: The dedicated IP address. example: example_value created_at: type: string format: date-time description: When the IP was provisioned. example: '2026-01-15T10:30:00Z' pool: type: string description: The IP pool this address belongs to. example: example_value domain: type: string description: The reverse DNS domain for the IP. example: example_value custom_dns: type: object properties: enabled: type: boolean description: Whether custom reverse DNS is enabled. valid: type: boolean description: Whether the custom DNS is valid. error: type: string description: Any DNS error. description: Custom DNS settings for the IP. example: example_value warmup: type: object properties: warming_up: type: boolean description: Whether the IP is currently in warmup mode. start_at: type: string format: date-time description: When the warmup started. end_at: type: string format: date-time description: When the warmup is expected to end. description: IP warmup status. example: example_value IPPool: type: object description: An IP pool grouping dedicated IPs. properties: name: type: string description: The pool name. example: Example Title created_at: type: string format: date-time description: When the pool was created. example: '2026-01-15T10:30:00Z' ips: type: array items: $ref: '#/components/schemas/DedicatedIP' description: The dedicated IPs in this pool. example: [] ExportJob: type: object description: Information about a data export job. properties: id: type: string description: The unique export job ID. example: abc123 created_at: type: string format: date-time description: When the export was created. example: '2026-01-15T10:30:00Z' type: type: string enum: - activity - reject - whitelist description: The type of data being exported. example: activity finished_at: type: string format: date-time description: When the export completed. example: '2026-01-15T10:30:00Z' state: type: string enum: - waiting - working - complete - error - expired description: The current state of the export. example: waiting result_url: type: string format: uri description: The URL to download the export file (when complete). example: https://www.example.com MetadataField: type: object description: A custom metadata field definition. properties: name: type: string description: The unique name of the metadata field. example: Example Title state: type: string enum: - active - delete - index description: The current state of the field. example: active view_template: type: string description: The Mustache template for displaying the field in the UI. example: example_value