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.

                  • Get sender info

                    post

                    /senders/info

                    Return more detailed information about a single sender, including aggregates of recent stats.

                    body parameters

                    • keyrequired
                      string

                      a valid api key

                    • addressrequired
                      string

                      the email address of the sender

                    Get sender info

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

                    Success Response

                    • HTTP Status 200

                      the detailed information on the sender

                      • address
                        string

                        the sender's email address

                      • created_at
                        string

                        the date and time that the sender was first seen by Mandrill as a UTC date string in YYYY-MM-DD HH:MM:SS format

                      • sent
                        integer

                        the total number of messages sent by this sender

                      • hard_bounces
                        integer

                        the total number of hard bounces by messages by this sender

                      • soft_bounces
                        integer

                        the total number of soft bounces by messages by this sender

                      • rejects
                        integer

                        the total number of rejected messages by this sender

                      • complaints
                        integer

                        the total number of spam complaints received for messages by this sender

                      • unsubs
                        integer

                        the total number of unsubscribe requests received for messages by this sender

                      • opens
                        integer

                        the total number of times messages by this sender have been opened

                      • clicks
                        integer

                        the total number of times tracked URLs in messages by this sender have been clicked

                      • stats
                        object

                        an aggregate summary of the sender's sending stats

                        Show Properties

                    Example response

                    JSON
                    {
                      "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,
                      "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
                        }
                      }
                    }
                  • 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.