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.

                    • List subaccounts

                      post

                      /subaccounts/list

                      Get the list of subaccounts defined for the account, optionally filtered by a prefix.

                      body parameters

                      • keyrequired
                        string

                        a valid api key

                      • q
                        string

                        an optional prefix to filter the subaccounts' ids and names

                      List subaccounts

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

                      Success Response

                      • HTTP Status 200

                        the subaccounts for the account, up to a maximum of 1,000

                        • Array
                          object[]

                          the individual subaccount info

                          Show Properties

                      Example response

                      JSON
                      [
                        {
                          "id": "string",
                          "name": "string",
                          "custom_quota": 0,
                          "status": "active",
                          "reputation": 0,
                          "created_at": "2019-08-24T14:15:22Z",
                          "first_sent_at": "2019-08-24T14:15:22Z",
                          "sent_weekly": 0,
                          "sent_monthly": 0,
                          "sent_total": 0
                        }
                      ]
                    • 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.