Mailchimp Developer LogoMailchimp Developer Wordmark

Transactional API

  • Allowlists

    Add, list, or delete from your Rejection Allowlist.

    • Exports

      Start an export, or get information on export jobs in progress.

      • IPs

        Request and manage Dedicated IPs for your account, and set up reverse DNS.

        • Start ip warmup

          post

          /ips/start-warmup

          Begins the warmup process for a dedicated IP. During the warmup process, the Transactional API will gradually increase the percentage of your mail that is sent over the warming-up IP, over a period of roughly 30 days. The rest of your mail will be sent over shared IPs or other dedicated IPs in the same pool.

          body parameters

          • keyrequired
            string

            a valid api key

          • iprequired
            string

            a dedicated ip address

          Start ip warmup

          const mailchimpClient = require("@mailchimp/mailchimp_transactional")(
            "YOUR_API_KEY"
          );
          
          const run = async () => {
            const response = await mailchimpClient.ips.startWarmup({ ip: "ip" });
            console.log(response);
          };
          
          run();
          
          

          Success Response

          • HTTP Status 200

            Information about the dedicated IP

            • ip
              string

              the ip address

            • created_at
              string

              the date and time that the dedicated IP was created as a UTC string in YYYY-MM-DD HH:MM:SS format

            • pool
              string

              the name of the pool that this dedicated IP belongs to

            • domain
              string

              the domain name (reverse dns) of this dedicated IP

            • custom_dns
              object

              information about the ip's custom dns, if it has been configured

              Show Properties
            • warmup
              object

              information about the ip's warmup status

              Show Properties

          Example response

          JSON
          {
            "ip": "string",
            "created_at": "2019-08-24T14:15:22Z",
            "pool": "string",
            "domain": "string",
            "custom_dns": {
              "enabled": true,
              "valid": true,
              "error": "string"
            },
            "warmup": {
              "warming_up": true,
              "start_at": "2019-08-24T14:15:22Z",
              "end_at": "2019-08-24T14:15:22Z"
            }
          }
        • Inbound

          Manage your inbound domains and routes.

          • Messages

            Send, schedule, or get information on your emails.

            • Metadata

              Manage your custom metadata fields in your account.

              • Rejects

                Add, list, or delete from your Rejection Denylist.

                • Senders

                  Manage or get information about your sending domains.

                  • Subaccounts

                    Manage your subaccounts, including the abilitiy to pause and resume sending.

                    • Tags

                      List, delete, or get information on your Tags and their sending statistics.

                      • Templates

                        Manage the Templates in your account.

                        • URLs

                          Manage your tracking domains. Some of these endpoints may be deprecated.

                          • Users

                            Get information about your account, or ping Transactional.

                            • Webhooks

                              Manage the webhooks in your account.

                              • Whitelists

                                Add, list, or delete from your Rejection Allowlist. These endpoints are being replaced with a series of functionally identical endpoints called /allowlists.