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.

                          • Add tracking domains

                            post

                            /urls/add-tracking-domain

                            Add a tracking domain to your account.

                            body parameters

                            • keyrequired
                              string

                              a valid api key

                            • domainrequired
                              string

                              a domain name

                            Add tracking domains

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

                            Success Response

                            • HTTP Status 200

                              information about the tracking domain

                              • domain
                                string

                                the tracking domain name

                              • created_at
                                string

                                the date and time that the tracking domain was added as a UTC string in YYYY-MM-DD HH:MM:SS format

                              • last_tested_at
                                string

                                when the domain's DNS settings were last tested as a UTC string in YYYY-MM-DD HH:MM:SS format

                              • cname
                                object

                                details about the domain's CNAME record

                                Show Properties
                              • valid_tracking
                                boolean

                                whether this domain can be used as a tracking domain for email.

                            Example response

                            JSON
                            {
                              "domain": "string",
                              "created_at": "2019-08-24T14:15:22Z",
                              "last_tested_at": "2019-08-24T14:15:22Z",
                              "cname": {
                                "valid": true,
                                "valid_after": "string",
                                "error": "string"
                              },
                              "valid_tracking": true
                            }
                          • 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.