### Install Mailchimp Transactional Python Library via Setuptools Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Install the Python package using Setuptools. You can install it for the current user or for all users. ```sh python setup.py install --user ``` -------------------------------- ### IPs Start Warmup Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Starts the IP warmup process for a dedicated IP address. This gradually increases sending volume to build reputation. ```APIDOC ## POST /ips/start-warmup ### Description Starts the IP warmup process for a dedicated IP address. ### Method POST ### Endpoint /ips/start-warmup ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **ip** (string) - Required - The dedicated IP address to start warmup for. ``` -------------------------------- ### Import Mailchimp Transactional Library Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Import the mailchimp_transactional package after installation. ```python import mailchimp_transactional ``` -------------------------------- ### Install Mailchimp Transactional Python Library via Pip Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Install the Python package directly from GitHub using pip. You might need root permissions. ```sh pip install git+https://github.com/mailchimp/mailchimp-transactional-python.git ``` -------------------------------- ### Quick Start: Ping Mailchimp API Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Initialize the client with your API key and make a ping request to verify the API connection. Handles potential API client errors. ```python import mailchimp_transactional as MailchimpTransactional from mailchimp_transactional.api_client import ApiClientError try: mailchimp = MailchimpTransactional.Client('YOUR_API_KEY') response = mailchimp.users.ping() print('API called successfully: {}'.format(response)) except ApiClientError as error: print('An exception occurred: {}'.format(error.text)) ``` -------------------------------- ### Messages Send SMS Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Sends an SMS message. Note: SMS sending is a separate feature and may require specific setup. ```APIDOC ## POST /messages/send-sms ### Description Sends an SMS message. ### Method POST ### Endpoint /messages/send-sms ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **message** (object) - Required - A dictionary containing the SMS message details. - **text** (string) - Required - The text content of the SMS message. - **from** (string) - Required - The sender phone number or shortcode. - **to** (string) - Required - The recipient phone number. - **track_clicks** (boolean) - Optional - Whether to track clicks in the SMS. ``` -------------------------------- ### Publish a Template Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Use this snippet to publish a new or existing template. It requires the template name as an argument. ```python mailchimp.templates.publish({ name: 'My Template' }); ``` -------------------------------- ### Metadata List Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Retrieves a list of all metadata keys currently configured for your account. ```APIDOC ## POST /metadata/list ### Description Retrieves a list of all metadata keys. ### Method POST ### Endpoint /metadata/list ### Parameters #### Request Body - **key** (string) - Required - Your API key. ``` -------------------------------- ### Templates List Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Retrieves a list of all templates associated with your account. ```APIDOC ## POST /templates/list ### Description Retrieves a list of all templates. ### Method POST ### Endpoint /templates/list ### Parameters #### Request Body - **key** (string) - Required - Your API key. ``` -------------------------------- ### Templates Render Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Renders a template with the provided content. Useful for testing template output before publishing. ```APIDOC ## POST /templates/render ### Description Renders a template with provided content. ### Method POST ### Endpoint /templates/render ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **name** (string) - Required - The name of the template to render. - **content** (object) - Required - A dictionary of merge tag values to use when rendering the template. ``` -------------------------------- ### Set Default Output Format Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Configure the default response format for all subsequent API requests. Supported formats include 'json', 'xml', 'php', and 'yaml'. ```python mailchimp.set_default_output_format('xml'); ``` -------------------------------- ### IPs Provision Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Provisions a new dedicated IP address for your account. This is a paid service. ```APIDOC ## POST /ips/provision ### Description Provisions a new dedicated IP address. ### Method POST ### Endpoint /ips/provision ### Parameters #### Request Body - **key** (string) - Required - Your API key. ``` -------------------------------- ### Webhooks List Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Retrieves a list of all webhook URLs configured for your account. ```APIDOC ## POST /webhooks/list ### Description Retrieves a list of all webhook URLs. ### Method POST ### Endpoint /webhooks/list ### Parameters #### Request Body - **key** (string) - Required - Your API key. ``` -------------------------------- ### Users Info Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Retrieves information about your account, including your sending limits and current usage. ```APIDOC ## POST /users/info ### Description Retrieves information about your account. ### Method POST ### Endpoint /users/info ### Parameters #### Request Body - **key** (string) - Required - Your API key. ``` -------------------------------- ### Templates Add Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Adds a new template to your account. Templates can be used for sending standardized emails. ```APIDOC ## POST /templates/add ### Description Adds a new template to your account. ### Method POST ### Endpoint /templates/add ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **name** (string) - Required - The name of the template. - **code** (string) - Optional - The HTML code for the template. - **text** (string) - Optional - The plain-text version of the template. - **subject** (string) - Optional - The default subject line for the template. - **from_email** (string) - Optional - The default sender email address for the template. ``` -------------------------------- ### Tags List Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Retrieves a list of all tags currently used in your account. ```APIDOC ## POST /tags/list ### Description Retrieves a list of all tags. ### Method POST ### Endpoint /tags/list ### Parameters #### Request Body - **key** (string) - Required - Your API key. ``` -------------------------------- ### Templates Info Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Retrieves information about a specific template, including its content and metadata. ```APIDOC ## POST /templates/info ### Description Retrieves information about a specific template. ### Method POST ### Endpoint /templates/info ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **name** (string) - Required - The name of the template to retrieve information for. ``` -------------------------------- ### IPs Info Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Retrieves information about a specific dedicated IP address, including its warmup status. ```APIDOC ## POST /ips/info ### Description Retrieves information about a dedicated IP address. ### Method POST ### Endpoint /ips/info ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **ip** (string) - Required - The dedicated IP address to retrieve information for. ``` -------------------------------- ### Users Ping Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Pings the API to check if it's available and responsive. Returns a simple JSON object with a 'ping' key. ```APIDOC ## POST /users/ping ### Description Pings the API to check for responsiveness. ### Method POST ### Endpoint /users/ping ### Parameters #### Request Body - **key** (string) - Required - Your API key. ``` -------------------------------- ### Exports Whitelist Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Generates a CSV export of your whitelist data. Note: This is an alias for the 'allowlist' export. ```APIDOC ## POST /exports/whitelist ### Description Generates a CSV export of your whitelist data. ### Method POST ### Endpoint /exports/whitelist ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **notify_email** (string) - Optional - The email address to send the export to. ``` -------------------------------- ### IPs List Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Retrieves a list of all dedicated IP addresses associated with your account. ```APIDOC ## POST /ips/list ### Description Retrieves a list of all dedicated IP addresses. ### Method POST ### Endpoint /ips/list ### Parameters #### Request Body - **key** (string) - Required - Your API key. ``` -------------------------------- ### Senders Verify Domain Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Initiates the domain verification process for a sender domain. This typically involves setting up DNS records. ```APIDOC ## POST /senders/verify-domain ### Description Initiates the domain verification process for a sender domain. ### Method POST ### Endpoint /senders/verify-domain ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **domain** (string) - Required - The domain name to verify. ``` -------------------------------- ### MC Templates Render Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Renders a Mailchimp template with the provided content. Useful for testing template output. ```APIDOC ## POST /mctemplates/render ### Description Renders a Mailchimp template with provided content. ### Method POST ### Endpoint /mctemplates/render ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **slug** (string) - Required - The unique slug of the template. - **content** (object) - Required - A dictionary of merge tag values to use when rendering the template. ``` -------------------------------- ### Tags Info Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Retrieves information about a specific tag, including its sending activity. ```APIDOC ## POST /tags/info ### Description Retrieves information about a specific tag. ### Method POST ### Endpoint /tags/info ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **tag** (string) - Required - The tag to retrieve information for. ``` -------------------------------- ### Inbound Routes Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Retrieves a list of all routing rules for inbound emails. ```APIDOC ## POST /inbound/routes ### Description Retrieves a list of routing rules for inbound emails. ### Method POST ### Endpoint /inbound/routes ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **domain** (string) - Optional - Filter routes by a specific domain. ``` -------------------------------- ### Allowlists Add Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Adds an email address to an allowlist. This prevents the email address from being hard-bounced or permanently rejected. ```APIDOC ## POST /allowlists/add ### Description Adds an email address to an allowlist. ### Method POST ### Endpoint /allowlists/add ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **email** (string) - Required - The email address to add to the allowlist. - **tags** (array of strings) - Optional - An array of tags to associate with this allowlist entry. ``` -------------------------------- ### Rejects List Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Retrieves a list of all email addresses currently on your rejection blacklist. ```APIDOC ## POST /rejects/list ### Description Retrieves a list of all email addresses on your rejection blacklist. ### Method POST ### Endpoint /rejects/list ### Parameters #### Request Body - **key** (string) - Required - Your API key. ``` -------------------------------- ### Subaccounts Add Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Creates a new subaccount. Subaccounts allow you to manage separate sending identities and track usage independently. ```APIDOC ## POST /subaccounts/add ### Description Creates a new subaccount. ### Method POST ### Endpoint /subaccounts/add ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **name** (string) - Required - The name of the subaccount. - **notes** (string) - Optional - Notes about the subaccount. ``` -------------------------------- ### Exports Allowlist Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Generates a CSV export of your allowlist. ```APIDOC ## POST /exports/allowlist ### Description Generates a CSV export of your allowlist. ### Method POST ### Endpoint /exports/allowlist ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **notify_email** (string) - Optional - The email address to send the export to. ``` -------------------------------- ### Subaccounts Resume Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Resumes sending for a previously paused subaccount. ```APIDOC ## POST /subaccounts/resume ### Description Resumes sending for a paused subaccount. ### Method POST ### Endpoint /subaccounts/resume ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **id** (integer) - Required - The ID of the subaccount to resume. ``` -------------------------------- ### Webhooks Add Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Adds a webhook URL to receive real-time notifications about email events (e.g., opens, clicks, bounces). ```APIDOC ## POST /webhooks/add ### Description Adds a webhook URL to receive email event notifications. ### Method POST ### Endpoint /webhooks/add ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **url** (string) - Required - The URL to send webhook notifications to. - **events** (array of strings) - Optional - An array of specific events to receive notifications for (e.g., 'send', 'open', 'click', 'bounce'). If not provided, all events are sent. ``` -------------------------------- ### URLs Check Tracking Domain Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Checks the DNS configuration for a custom tracking domain to ensure it's set up correctly. ```APIDOC ## POST /urls/check-tracking-domain ### Description Checks the DNS configuration for a custom tracking domain. ### Method POST ### Endpoint /urls/check-tracking-domain ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **domain** (string) - Required - The custom tracking domain name to check. ``` -------------------------------- ### Exports Rejects Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Generates a CSV export of your reject data. ```APIDOC ## POST /exports/rejects ### Description Generates a CSV export of your reject data. ### Method POST ### Endpoint /exports/rejects ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **notify_email** (string) - Optional - The email address to send the export to. - **start_time** (string) - Optional - The start date/time for the export in YYYY-MM-DD HH:MM:SS format. - **end_time** (string) - Optional - The end date/time for the export in YYYY-MM-DD HH:MM:SS format. ``` -------------------------------- ### Allowlists List Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Retrieves a list of all email addresses currently on your allowlist. ```APIDOC ## POST /allowlists/list ### Description Retrieves a list of all email addresses on your allowlist. ### Method POST ### Endpoint /allowlists/list ### Parameters #### Request Body - **key** (string) - Required - Your API key. ``` -------------------------------- ### Set Single Request Output Format Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Override the default output format for a specific API request by including the 'outputFormat' parameter in the request body. ```python mailchimp.senders.list({ outputFormat: 'php' }); ``` -------------------------------- ### Templates Time Series Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Retrieves time-series data for template activity, showing metrics over time. ```APIDOC ## POST /templates/time-series ### Description Retrieves time-series data for template activity. ### Method POST ### Endpoint /templates/time-series ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **name** (string) - Required - The name of the template. - **start_time** (string) - Optional - The start date/time for the time series in YYYY-MM-DD HH:MM:SS format. - **end_time** (string) - Optional - The end date/time for the time series in YYYY-MM-DD HH:MM:SS format. - **ρες** (string) - Optional - The granularity of the time series data (e.g., 'hour', 'day', 'week', 'month'). ``` -------------------------------- ### Rejects Add Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Adds an email address to your rejection blacklist. Emails sent to these addresses will be automatically rejected. ```APIDOC ## POST /rejects/add ### Description Adds an email address to your rejection blacklist. ### Method POST ### Endpoint /rejects/add ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **email** (string) - Required - The email address to add to the rejection list. - **reason** (string) - Optional - A description of why the email address was rejected. ``` -------------------------------- ### Exports Info Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Retrieves information about your export requests. ```APIDOC ## POST /exports/info ### Description Retrieves information about your export requests. ### Method POST ### Endpoint /exports/info ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **exports_id** (string) - Required - The ID of the export to retrieve information for. ``` -------------------------------- ### IPs Create Pool Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Creates a new IP pool. IP pools allow you to group dedicated IPs for sending. ```APIDOC ## POST /ips/create-pool ### Description Creates a new IP pool. ### Method POST ### Endpoint /ips/create-pool ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **name** (string) - Required - The name of the IP pool. ``` -------------------------------- ### IPs List Pools Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Retrieves a list of all IP pools associated with your account. ```APIDOC ## POST /ips/list-pools ### Description Retrieves a list of all IP pools. ### Method POST ### Endpoint /ips/list-pools ### Parameters #### Request Body - **key** (string) - Required - Your API key. ``` -------------------------------- ### MC Templates List Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Retrieves a list of all Mailchimp templates associated with your account. ```APIDOC ## POST /mctemplates/list ### Description Retrieves a list of all Mailchimp templates. ### Method POST ### Endpoint /mctemplates/list ### Parameters #### Request Body - **key** (string) - Required - Your API key. ``` -------------------------------- ### URLs Tracking Domains Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Retrieves a list of all custom tracking domains configured for your account. ```APIDOC ## POST /urls/tracking-domains ### Description Retrieves a list of custom tracking domains. ### Method POST ### Endpoint /urls/tracking-domains ### Parameters #### Request Body - **key** (string) - Required - Your API key. ``` -------------------------------- ### Exports List Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Retrieves a list of your recent export requests. ```APIDOC ## POST /exports/list ### Description Retrieves a list of your recent export requests. ### Method POST ### Endpoint /exports/list ### Parameters #### Request Body - **key** (string) - Required - Your API key. ``` -------------------------------- ### Webhooks Info Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Retrieves information about a specific webhook, including the events it's configured to receive. ```APIDOC ## POST /webhooks/info ### Description Retrieves information about a specific webhook. ### Method POST ### Endpoint /webhooks/info ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **url** (string) - Required - The URL of the webhook to retrieve information for. ``` -------------------------------- ### Templates Publish Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Publishes a draft version of a template, making it available for use in sending emails. ```APIDOC ## POST /templates/publish ### Description Publishes a draft version of a template. ### Method POST ### Endpoint /templates/publish ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **name** (string) - Required - The name of the template to publish. ``` -------------------------------- ### Senders List Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Retrieves a list of all sender identities configured for your account. ```APIDOC ## POST /senders/list ### Description Retrieves a list of all sender identities. ### Method POST ### Endpoint /senders/list ### Parameters #### Request Body - **key** (string) - Required - Your API key. ``` -------------------------------- ### MC Templates Info Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Retrieves information about a specific Mailchimp template. ```APIDOC ## POST /mctemplates/info ### Description Retrieves information about a specific Mailchimp template. ### Method POST ### Endpoint /mctemplates/info ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **slug** (string) - Required - The unique slug of the template. ``` -------------------------------- ### Subaccounts List Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Retrieves a list of all subaccounts associated with your account. ```APIDOC ## POST /subaccounts/list ### Description Retrieves a list of all subaccounts. ### Method POST ### Endpoint /subaccounts/list ### Parameters #### Request Body - **key** (string) - Required - Your API key. ``` -------------------------------- ### IPs Pool Info Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Retrieves information about a specific IP pool, including the dedicated IPs within it. ```APIDOC ## POST /ips/pool-info ### Description Retrieves information about an IP pool. ### Method POST ### Endpoint /ips/pool-info ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **pool** (string) - Required - The name of the IP pool to retrieve information for. ``` -------------------------------- ### Senders Check Domain Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Checks the DNS records for a domain to ensure it's properly configured for sending email. ```APIDOC ## POST /senders/check-domain ### Description Checks the DNS records for a domain. ### Method POST ### Endpoint /senders/check-domain ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **domain** (string) - Required - The domain name to check. ``` -------------------------------- ### IPs Cancel Warmup Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Cancels the IP warmup process for a specific IP address. ```APIDOC ## POST /ips/cancel-warmup ### Description Cancels the IP warmup process for a specific IP address. ### Method POST ### Endpoint /ips/cancel-warmup ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **ip** (string) - Required - The IP address to cancel warmup for. ``` -------------------------------- ### Inbound Domains Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Retrieves a list of all domains configured for inbound email. ```APIDOC ## POST /inbound/domains ### Description Retrieves a list of domains configured for inbound email. ### Method POST ### Endpoint /inbound/domains ### Parameters #### Request Body - **key** (string) - Required - Your API key. ``` -------------------------------- ### Subaccounts Info Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Retrieves information about a specific subaccount, including its sending activity and status. ```APIDOC ## POST /subaccounts/info ### Description Retrieves information about a specific subaccount. ### Method POST ### Endpoint /subaccounts/info ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **id** (integer) - Required - The ID of the subaccount to retrieve information for. ``` -------------------------------- ### Tags All Time Series Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Retrieves aggregated time-series data for all tags associated with your account. ```APIDOC ## POST /tags/all-time-series ### Description Retrieves aggregated time-series data for all tags. ### Method POST ### Endpoint /tags/all-time-series ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **start_time** (string) - Optional - The start date/time for the time series in YYYY-MM-DD HH:MM:SS format. - **end_time** (string) - Optional - The end date/time for the time series in YYYY-MM-DD HH:MM:SS format. - **ρες** (string) - Optional - The granularity of the time series data (e.g., 'hour', 'day', 'week', 'month'). ``` -------------------------------- ### MC Templates Time Series Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Retrieves time-series data for Mailchimp templates, showing metrics over time. ```APIDOC ## POST /mctemplates/time-series ### Description Retrieves time-series data for Mailchimp templates. ### Method POST ### Endpoint /mctemplates/time-series ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **slug** (string) - Required - The unique slug of the template. - **start_time** (string) - Optional - The start date/time for the time series in YYYY-MM-DD HH:MM:SS format. - **end_time** (string) - Optional - The end date/time for the time series in YYYY-MM-DD HH:MM:SS format. ``` -------------------------------- ### Subaccounts Update Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Updates the settings for a specific subaccount, such as its name or notes. ```APIDOC ## POST /subaccounts/update ### Description Updates the settings for a specific subaccount. ### Method POST ### Endpoint /subaccounts/update ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **id** (integer) - Required - The ID of the subaccount to update. - **name** (string) - Optional - The new name for the subaccount. - **notes** (string) - Optional - New notes for the subaccount. ``` -------------------------------- ### Metadata Add Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Adds metadata to be tracked with your emails. Metadata can be used for custom reporting and segmentation. ```APIDOC ## POST /metadata/add ### Description Adds metadata to be tracked with your emails. ### Method POST ### Endpoint /metadata/add ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **name** (string) - Required - The name of the metadata key. - **value** (string) - Required - The value of the metadata. ``` -------------------------------- ### IPs Check Custom DNS Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Checks the custom DNS records for a dedicated IP address. ```APIDOC ## POST /ips/check-custom-dns ### Description Checks the custom DNS records for a dedicated IP address. ### Method POST ### Endpoint /ips/check-custom-dns ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **ip** (string) - Required - The dedicated IP address to check. ``` -------------------------------- ### Templates Update Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Updates an existing template with new content, subject, or sender information. ```APIDOC ## POST /templates/update ### Description Updates an existing template. ### Method POST ### Endpoint /templates/update ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **name** (string) - Required - The name of the template to update. - **code** (string) - Optional - The new HTML code for the template. - **text** (string) - Optional - The new plain-text version of the template. - **subject** (string) - Optional - The new default subject line for the template. - **from_email** (string) - Optional - The new default sender email address for the template. ``` -------------------------------- ### Exports Activity Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Generates a CSV export of your activity data. This includes information about emails sent, opened, clicked, bounced, etc. ```APIDOC ## POST /exports/activity ### Description Generates a CSV export of your activity data. ### Method POST ### Endpoint /exports/activity ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **notify_email** (string) - Optional - The email address to send the export to. If not provided, the export will be available for download via the API. - **start_time** (string) - Optional - The start date/time for the export in YYYY-MM-DD HH:MM:SS format. - **end_time** (string) - Optional - The end date/time for the export in YYYY-MM-DD HH:MM:SS format. ``` -------------------------------- ### URLs Add Tracking Domain Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Adds a custom domain for tracking clicks in your emails. This allows you to use your own domain for tracking links. ```APIDOC ## POST /urls/add-tracking-domain ### Description Adds a custom domain for tracking clicks. ### Method POST ### Endpoint /urls/add-tracking-domain ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **domain** (string) - Required - The custom domain name to use for tracking. ``` -------------------------------- ### Inbound Add Route Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Adds a routing rule for inbound emails to a specific domain. ```APIDOC ## POST /inbound/add-route ### Description Adds a routing rule for inbound emails. ### Method POST ### Endpoint /inbound/add-route ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **domain** (string) - Required - The domain name for the route. - **pattern** (string) - Optional - A pattern to match for the route (e.g., "*@yourdomain.com"). - **url** (string) - Required - The webhook URL to send matching emails to. ``` -------------------------------- ### Senders Domains Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Retrieves a list of all domains configured as sender identities. ```APIDOC ## POST /senders/domains ### Description Retrieves a list of domains configured as sender identities. ### Method POST ### Endpoint /senders/domains ### Parameters #### Request Body - **key** (string) - Required - Your API key. ``` -------------------------------- ### Users Ping2 Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md A more advanced ping endpoint that returns additional information about your account status. ```APIDOC ## POST /users/ping2 ### Description Pings the API and returns account status information. ### Method POST ### Endpoint /users/ping2 ### Parameters #### Request Body - **key** (string) - Required - Your API key. ``` -------------------------------- ### Users Senders Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Retrieves a list of sender statistics for your account, including total emails sent and delivery rates. ```APIDOC ## POST /users/senders ### Description Retrieves sender statistics for your account. ### Method POST ### Endpoint /users/senders ### Parameters #### Request Body - **key** (string) - Required - Your API key. ``` -------------------------------- ### Messages Info Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Retrieves information about a specific message, including its status and delivery details. ```APIDOC ## POST /messages/info ### Description Retrieves information about a specific message. ### Method POST ### Endpoint /messages/info ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **id** (string) - Required - The ID of the message to retrieve information for. ``` -------------------------------- ### IPs Set Custom DNS Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Sets the custom DNS records for a dedicated IP address. This is required for certain sending configurations. ```APIDOC ## POST /ips/set-custom-dns ### Description Sets the custom DNS records for a dedicated IP address. ### Method POST ### Endpoint /ips/set-custom-dns ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **ip** (string) - Required - The dedicated IP address to configure. - **domain** (string) - Required - The custom domain name to use for the IP. ``` -------------------------------- ### Messages Content Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Retrieves the full content of a specific message. ```APIDOC ## POST /messages/content ### Description Retrieves the full content of a specific message. ### Method POST ### Endpoint /messages/content ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **id** (string) - Required - The ID of the message to retrieve content for. ``` -------------------------------- ### Inbound Check Domain Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Checks the MX record configuration for a domain to ensure it's set up correctly for inbound email. ```APIDOC ## POST /inbound/check-domain ### Description Checks the MX record configuration for a domain. ### Method POST ### Endpoint /inbound/check-domain ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **domain** (string) - Required - The domain name to check. ``` -------------------------------- ### IPs Set Pool Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Assigns a dedicated IP address to an IP pool. ```APIDOC ## POST /ips/set-pool ### Description Assigns a dedicated IP address to an IP pool. ### Method POST ### Endpoint /ips/set-pool ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **ip** (string) - Required - The dedicated IP address to assign. - **pool** (string) - Required - The name of the IP pool to assign the IP to. ``` -------------------------------- ### Inbound Send Raw Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Sends a raw, MIME-formatted email. This is useful for sending emails with complex attachments or custom headers. ```APIDOC ## POST /inbound/send-raw ### Description Sends a raw, MIME-formatted email. ### Method POST ### Endpoint /inbound/send-raw ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **raw_message** (string) - Required - The raw MIME content of the email. - **to** (array of strings) - Optional - An array of recipient email addresses. - **mail_from** (string) - Optional - The sender email address. ``` -------------------------------- ### Rejects Delete Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Removes an email address from your rejection blacklist. ```APIDOC ## POST /rejects/delete ### Description Removes an email address from your rejection blacklist. ### Method POST ### Endpoint /rejects/delete ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **email** (string) - Required - The email address to remove from the rejection list. ``` -------------------------------- ### Rejects Add SMS Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Adds a phone number to your SMS rejection list. SMS messages sent to these numbers will be blocked. ```APIDOC ## POST /rejects/add-sms ### Description Adds a phone number to your SMS rejection list. ### Method POST ### Endpoint /rejects/add-sms ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **phone** (string) - Required - The phone number to add to the rejection list. - **reason** (string) - Optional - A description of why the phone number was rejected. ``` -------------------------------- ### Tags Time Series Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Retrieves time-series data for a specific tag, showing metrics over time. ```APIDOC ## POST /tags/time-series ### Description Retrieves time-series data for a specific tag. ### Method POST ### Endpoint /tags/time-series ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **tag** (string) - Required - The tag to retrieve time-series data for. - **start_time** (string) - Optional - The start date/time for the time series in YYYY-MM-DD HH:MM:SS format. - **end_time** (string) - Optional - The end date/time for the time series in YYYY-MM-DD HH:MM:SS format. - **ρες** (string) - Optional - The granularity of the time series data (e.g., 'hour', 'day', 'week', 'month'). ``` -------------------------------- ### Inbound Add Domain Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Adds a domain to your inbound domain settings. This allows you to receive emails at addresses on this domain. ```APIDOC ## POST /inbound/add-domain ### Description Adds a domain to your inbound domain settings. ### Method POST ### Endpoint /inbound/add-domain ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **domain** (string) - Required - The domain name to add. ``` -------------------------------- ### Metadata Update Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Updates the value of existing metadata. ```APIDOC ## POST /metadata/update ### Description Updates the value of existing metadata. ### Method POST ### Endpoint /metadata/update ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **name** (string) - Required - The name of the metadata key to update. - **value** (string) - Required - The new value for the metadata. ``` -------------------------------- ### Messages List Scheduled Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Retrieves a list of all messages that are currently scheduled to be sent. ```APIDOC ## POST /messages/list-scheduled ### Description Retrieves a list of scheduled messages. ### Method POST ### Endpoint /messages/list-scheduled ### Parameters #### Request Body - **key** (string) - Required - Your API API key. ``` -------------------------------- ### Messages Send Raw Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Sends a raw, MIME-formatted email. This is useful for sending emails with complex attachments or custom headers. ```APIDOC ## POST /messages/send-raw ### Description Sends a raw, MIME-formatted email. ### Method POST ### Endpoint /messages/send-raw ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **raw_message** (string) - Required - The raw MIME content of the email. - **to** (array of strings) - Optional - An array of recipient email addresses. - **mail_from** (string) - Optional - The sender email address. ``` -------------------------------- ### Senders Time Series Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Retrieves time-series data for sender activity, showing metrics over time. ```APIDOC ## POST /senders/time-series ### Description Retrieves time-series data for sender activity. ### Method POST ### Endpoint /senders/time-series ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **email** (string) - Required - The email address of the sender. - **start_time** (string) - Optional - The start date/time for the time series in YYYY-MM-DD HH:MM:SS format. - **end_time** (string) - Optional - The end date/time for the time series in YYYY-MM-DD HH:MM:SS format. ``` -------------------------------- ### Templates Delete Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Deletes a template from your account. ```APIDOC ## POST /templates/delete ### Description Deletes a template from your account. ### Method POST ### Endpoint /templates/delete ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **name** (string) - Required - The name of the template to delete. ``` -------------------------------- ### IPs Delete Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Deletes a dedicated IP address. This action is irreversible. ```APIDOC ## POST /ips/delete ### Description Deletes a dedicated IP address. ### Method POST ### Endpoint /ips/delete ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **ip** (string) - Required - The dedicated IP address to delete. ``` -------------------------------- ### Messages Send MC Template Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Sends an email using a Mailchimp template. This is ideal for marketing emails or transactional emails with complex formatting. ```APIDOC ## POST /messages/send-mc-template ### Description Sends an email using a Mailchimp template. ### Method POST ### Endpoint /messages/send-mc-template ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **message** (object) - Required - A dictionary containing the message details. - **subject** (string) - Required - The subject line of the email. - **from_email** (string) - Required - The sender's email address. - **to** (array of objects) - Required - An array of recipient objects. - **mc_template_slug** (string) - Required - The unique slug of the Mailchimp template. - **mc_template_content** (array of objects) - Required - An array of objects specifying content for template merge tags. - **bcc** (array of objects) - Optional - An array of BCC recipient objects. - **tags** (array of strings) - Optional - An array of tags to categorize the message. - **subaccount_id** (string) - Optional - The ID of the subaccount to send the message from. ``` -------------------------------- ### Senders Info Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Retrieves information about a specific sender, including their email address and associated domains. ```APIDOC ## POST /senders/info ### Description Retrieves information about a specific sender. ### Method POST ### Endpoint /senders/info ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **email** (string) - Required - The email address of the sender to retrieve information for. ``` -------------------------------- ### Inbound Update Route Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Updates an existing routing rule for inbound emails. ```APIDOC ## POST /inbound/update-route ### Description Updates an existing routing rule for inbound emails. ### Method POST ### Endpoint /inbound/update-route ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **id** (integer) - Required - The ID of the route to update. - **pattern** (string) - Optional - A new pattern to match for the route. - **url** (string) - Optional - The new webhook URL to send matching emails to. ``` -------------------------------- ### Rejects List SMS Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Retrieves a list of all phone numbers currently on your SMS rejection list. ```APIDOC ## POST /rejects/list-sms ### Description Retrieves a list of all phone numbers on your SMS rejection list. ### Method POST ### Endpoint /rejects/list-sms ### Parameters #### Request Body - **key** (string) - Required - Your API key. ``` -------------------------------- ### Senders Add Domain Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Adds a domain to your sender identity list. This allows you to send emails from addresses on this domain. ```APIDOC ## POST /senders/add-domain ### Description Adds a domain to your sender identity list. ### Method POST ### Endpoint /senders/add-domain ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **domain** (string) - Required - The domain name to add. ``` -------------------------------- ### Allowlists Delete Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Removes an email address from an allowlist. ```APIDOC ## POST /allowlists/delete ### Description Removes an email address from an allowlist. ### Method POST ### Endpoint /allowlists/delete ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **email** (string) - Required - The email address to remove from the allowlist. ``` -------------------------------- ### Messages Search Time Series Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Searches for messages within a specific time range and returns aggregated data. ```APIDOC ## POST /messages/search-time-series ### Description Searches for messages within a specific time range and returns aggregated data. ### Method POST ### Endpoint /messages/search-time-series ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **query** (string) - Optional - The search query. - **start_time** (string) - Optional - The start date/time for the search in YYYY-MM-DD HH:MM:SS format. - **end_time** (string) - Optional - The end date/time for the search in YYYY-MM-DD HH:MM:SS format. - **ρες** (string) - Optional - The granularity of the time series data (e.g., 'hour', 'day', 'week', 'month'). ``` -------------------------------- ### Messages Send Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Sends a transactional email message. This is the primary method for sending individual emails. ```APIDOC ## POST /messages/send ### Description Sends a transactional email message. ### Method POST ### Endpoint /messages/send ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **message** (object) - Required - A dictionary containing the message details. - **html** (string) - Optional - The HTML content of the email. - **text** (string) - Optional - The plain-text content of the email. - **subject** (string) - Required - The subject line of the email. - **from_email** (string) - Required - The sender's email address. - **to** (array of objects) - Required - An array of recipient objects, each with 'email' and optional 'name'. - **cc** (array of objects) - Optional - An array of CC recipient objects. - **bcc** (array of objects) - Optional - An array of BCC recipient objects. - **reply_to** (string) - Optional - The reply-to email address. - **attachments** (array of objects) - Optional - An array of attachment objects, each with 'content', 'type', and 'name'. - **images** (array of objects) - Optional - An array of image objects for embedded images. - **metadata** (object) - Optional - A dictionary of custom metadata to attach to the message. - **tags** (array of strings) - Optional - An array of tags to categorize the message. - **subaccount_id** (string) - Optional - The ID of the subaccount to send the message from. ``` -------------------------------- ### Subaccounts Delete Source: https://github.com/mailchimp/mailchimp-transactional-python/blob/master/README.md Deletes a subaccount. This action is irreversible and will also delete all associated data. ```APIDOC ## POST /subaccounts/delete ### Description Deletes a subaccount. ### Method POST ### Endpoint /subaccounts/delete ### Parameters #### Request Body - **key** (string) - Required - Your API key. - **id** (integer) - Required - The ID of the subaccount to delete. ```