Mailchimp Developer LogoMailchimp Developer Wordmark

Transactional API

  • Allowlists

    Add, list, or delete from your Rejection Allowlist.

    • Add email to allowlist

      post

      /allowlists/add

      Adds an email to your email rejection allowlist. If the address is currently on your denylist, that denylist entry will be removed automatically.

      body parameters

      • keyrequired
        string

        a valid api key

      • emailrequired
        string

        an email address to add to the allowlist

      • comment
        string

        an optional description of why the email was added to the allowlist

      Add email to allowlist

      const mailchimpClient = require("@mailchimp/mailchimp_transactional")(
        "YOUR_API_KEY"
      );
      
      const run = async () => {
        const response = await mailchimpClient.allowlists.add({
          email: "Erwin_DuBuque78@gmail.com",
        });
        console.log(response);
      };
      
      run();
      
      

      Success Response

      • HTTP Status 200

        a status object containing the address and the result of the operation

        • email
          string

          the email address you provided

        • added
          boolean

          whether the operation succeeded

      Example response

      JSON
      {
        "email": "string",
        "added": true
      }
    • 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.

        • 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.