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.

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

                            • Get user info

                              post

                              /users/info

                              Return the information about the API-connected user.

                              body parameters

                              • keyrequired
                                string

                                a valid api key

                              Get user info

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

                              Success Response

                              • HTTP Status 200

                                the user information including username, key, reputation, quota, and historical sending stats

                                • username
                                  string

                                  the username of the user (used for SMTP authentication)

                                • created_at
                                  string

                                  the date and time that the user's Mandrill account was created as a UTC string in YYYY-MM-DD HH:MM:SS format

                                • public_id
                                  string

                                  a unique, permanent identifier for this user

                                • reputation
                                  integer

                                  the reputation of the user on a scale from 0 to 100, with 75 generally being a "good" reputation

                                • hourly_quota
                                  integer

                                  the maximum number of emails Mandrill will deliver for this user each hour. Any emails beyond that will be accepted and queued for later delivery. Users with higher reputations will have higher hourly quotas

                                • backlog
                                  integer

                                  the number of emails that are queued for delivery due to exceeding your monthly or hourly quotas

                                • stats
                                  object

                                  an aggregate summary of the account's sending stats

                                  Show Properties

                              Example response

                              JSON
                              {
                                "username": "string",
                                "created_at": "string",
                                "public_id": "string",
                                "reputation": 0,
                                "hourly_quota": 0,
                                "backlog": 0,
                                "stats": {
                                  "today": {
                                    "sent": 0,
                                    "hard_bounces": 0,
                                    "soft_bounces": 0,
                                    "rejects": 0,
                                    "complaints": 0,
                                    "unsubs": 0,
                                    "opens": 0,
                                    "unique_opens": 0,
                                    "clicks": 0,
                                    "unique_clicks": 0
                                  },
                                  "last_7_days": {
                                    "sent": 0,
                                    "hard_bounces": 0,
                                    "soft_bounces": 0,
                                    "rejects": 0,
                                    "complaints": 0,
                                    "unsubs": 0,
                                    "opens": 0,
                                    "unique_opens": 0,
                                    "clicks": 0,
                                    "unique_clicks": 0
                                  },
                                  "last_30_days": {
                                    "sent": 0,
                                    "hard_bounces": 0,
                                    "soft_bounces": 0,
                                    "rejects": 0,
                                    "complaints": 0,
                                    "unsubs": 0,
                                    "opens": 0,
                                    "unique_opens": 0,
                                    "clicks": 0,
                                    "unique_clicks": 0
                                  },
                                  "last_60_days": {
                                    "sent": 0,
                                    "hard_bounces": 0,
                                    "soft_bounces": 0,
                                    "rejects": 0,
                                    "complaints": 0,
                                    "unsubs": 0,
                                    "opens": 0,
                                    "unique_opens": 0,
                                    "clicks": 0,
                                    "unique_clicks": 0
                                  },
                                  "last_90_days": {
                                    "sent": 0,
                                    "hard_bounces": 0,
                                    "soft_bounces": 0,
                                    "rejects": 0,
                                    "complaints": 0,
                                    "unsubs": 0,
                                    "opens": 0,
                                    "unique_opens": 0,
                                    "clicks": 0,
                                    "unique_clicks": 0
                                  },
                                  "all_time": {
                                    "sent": 0,
                                    "hard_bounces": 0,
                                    "soft_bounces": 0,
                                    "rejects": 0,
                                    "complaints": 0,
                                    "unsubs": 0,
                                    "opens": 0,
                                    "unique_opens": 0,
                                    "clicks": 0,
                                    "unique_clicks": 0
                                  }
                                }
                              }
                            • 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.