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.

        • Delete ip address

          post

          /ips/delete

          Deletes a dedicated IP. This is permanent and cannot be undone.

          body parameters

          • keyrequired
            string

            a valid api key

          • iprequired
            string

            the dedicated ip to remove from your account

          Delete ip address

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

          Success Response

          • HTTP Status 200

            a description of the ip that was removed from your account.

            • ip
              string

              the ip address

            • deleted
              string

              a boolean indicating whether the ip was successfully deleted

          Example response

          JSON
          {
            "ip": "string",
            "deleted": "string"
          }
        • 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.