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.

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

                • List denylisted emails

                  post

                  /rejects/list

                  Retrieves your email rejection denylist. You can provide an email address to limit the results. Returns up to 1000 results. By default, entries that have expired are excluded from the results; set include_expired to true to include them.

                  body parameters

                  • keyrequired
                    string

                    a valid api key

                  • email
                    string

                    an optional email address to search by

                  • include_expired
                    boolean

                    whether to include rejections that have already expired.

                  • subaccount
                    string

                    an optional unique identifier for the subaccount to limit the denylist

                  List denylisted emails

                  const mailchimpClient = require("@mailchimp/mailchimp_transactional")(
                    "YOUR_API_KEY"
                  );
                  
                  const run = async () => {
                    const response = await mailchimpClient.rejects.list();
                    console.log(response);
                  };
                  
                  run();
                  
                  

                  Success Response

                  • HTTP Status 200

                    Up to 1000 rejection entries

                    • Array
                      object[]

                      the information for each rejection entry

                      Show Properties

                  Example response

                  JSON
                  [
                    {
                      "email": "user@example.com",
                      "reason": "string",
                      "detail": "string",
                      "created_at": "2019-08-24T14:15:22Z",
                      "last_event_at": "2019-08-24T14:15:22Z",
                      "expires_at": "2019-08-24T14:15:22Z",
                      "expired": true,
                      "sender": {
                        "address": "user@example.com",
                        "created_at": "2019-08-24T14:15:22Z",
                        "sent": 0,
                        "hard_bounces": 0,
                        "soft_bounces": 0,
                        "rejects": 0,
                        "complaints": 0,
                        "unsubs": 0,
                        "opens": 0,
                        "clicks": 0,
                        "unique_opens": 0,
                        "unique_clicks": 0
                      },
                      "subaccount": "string"
                    }
                  ]
                • 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.