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.

                          • Search most clicked urlsdeprecated

                            post

                            /urls/search

                            Return the 100 most clicked URLs that match the search query given.

                            body parameters

                            • keyrequired
                              string

                              a valid api key

                            • qrequired
                              string

                              a search query

                            Search most clicked urls

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

                            Success Response

                            • HTTP Status 200

                              the 100 most clicked URLs matching the search query

                              • Array
                                object[]

                                the URL matching the query

                                Show Properties

                            Example response

                            JSON
                            [
                              {
                                "url": "string",
                                "sent": 0,
                                "clicks": 0,
                                "unique_clicks": 0
                              }
                            ]
                          • 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.