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.

            • Get message info

              post

              /messages/info

              Get the information for a single recently sent message.

              body parameters

              • keyrequired
                string

                a valid api key

              • idrequired
                string

                the unique id of the message to get - passed as the "_id" field in webhooks, send calls, or search calls

              Get message info

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

              Success Response

              • HTTP Status 200

                the information for the message

                • ts
                  integer

                  the Unix timestamp from when this message was sent

                • _id
                  string

                  the message's unique id

                • sender
                  string

                  the email address of the sender

                • template
                  string

                  the unique name of the template used, if any

                • subject
                  string

                  the message's subject line

                • email
                  string

                  the recipient email address

                • tags
                  string[]

                  list of tags on this message

                • opens
                  integer

                  how many times has this message been opened

                • opens_detail
                  object[]

                  list of individual opens for the message

                  Show Properties
                • clicks
                  integer

                  how many times has a link been clicked in this message

                • clicks_detail
                  object[]

                  list of individual clicks for the message

                  Show Properties
                • state
                  string

                  sending status of this message Possible values: "sent", "bounced", or "rejected".

                • metadata
                  object

                  any custom metadata provided when the message was sent

                • smtp_events
                  object[]

                  a log of up to 3 smtp events for the message

                  Show Properties

              Example response

              JSON
              {
                "ts": 0,
                "_id": "string",
                "sender": "user@example.com",
                "template": "string",
                "subject": "string",
                "email": "user@example.com",
                "tags": [
                  "string"
                ],
                "opens": 0,
                "opens_detail": [
                  {
                    "ts": 0,
                    "ip": "string",
                    "location": "string",
                    "ua": "string"
                  }
                ],
                "clicks": 0,
                "clicks_detail": [
                  {
                    "ts": 0,
                    "url": "string",
                    "ip": "string",
                    "location": "string",
                    "ua": "string"
                  }
                ],
                "state": "sent",
                "metadata": {},
                "smtp_events": [
                  {
                    "ts": 0,
                    "type": "string",
                    "diag": "string"
                  }
                ]
              }
            • 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.

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