{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs/email-api/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition","tabs","tab"]},"type":"markdown"},"seo":{"title":"Add URL Tags","siteUrl":"https://dev.mailjet.com/","projectTitle":"Mailjet Developer Documentation","description":"Append UTM and tracking parameters to every link in a Mailjet Send API v3.1 message using the URLTags property without editing individual URLs.","image":"https://dev.mailjet.com/og-image.png","lang":"en-US","keywords":["Mailjet API","Email API","Content API","SMTP Relay","transactional email","email delivery","Send API","email templates","developer documentation"],"meta":[{"name":"og:type","content":"website"},{"name":"og:site_name","content":"Mailjet Developer Documentation"},{"name":"twitter:card","content":"summary_large_image"},{"name":"robots","content":"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1"},{"name":"googlebot","content":"index, follow, max-snippet:-1, max-image-preview:large"}],"jsonLd":{"@context":"https://schema.org","@graph":[{"@type":"Organization","@id":"https://dev.mailjet.com/#organization","name":"Mailjet","alternateName":"Sinch Mailjet","url":"https://www.mailjet.com","logo":"https://assets.mailjet.com/lib/images/mailjetLogo/mj_logo_with_text_color.png","parentOrganization":{"@type":"Organization","name":"Sinch","url":"https://www.sinch.com"}},{"@type":"WebSite","@id":"https://dev.mailjet.com/#website","name":"Mailjet Developer Documentation","description":"Official developer documentation for the Mailjet Email API, Content API and SMTP Relay.","url":"https://dev.mailjet.com/","inLanguage":"en-US","publisher":{"@id":"https://dev.mailjet.com/#organization"},"potentialAction":{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https://dev.mailjet.com/search?q={search_term_string}"},"query-input":"required name=search_term_string"}}]},"llmstxt":{"hide":false,"title":"Mailjet Developer Documentation","description":"Developer documentation for the Mailjet Email API, Content API and SMTP Relay - guides, API references and code samples for sending, templating and tracking email at scale.","details":{"content":"Mailjet (part of Sinch) provides APIs for sending and managing email.\n\nThis documentation covers four main areas:\n\n- **Email API** - the Send API (v3 and v3.1) for transactional and marketing email,\n  plus contact management, segmentation, campaigns, statistics, webhooks, the Parse API\n  and the Mailjet Templating Language.\n- **Content API** - programmatic management of email templates, template contents,\n  images, labels and authentication tokens (v1).\n- **SMTP Relay** - sending through Mailjet's SMTP servers, including custom headers.\n- **API Reference** - the complete, generated reference for every endpoint, built directly\n  from the OpenAPI specifications.\n\nBase URL for all REST APIs: `https://api.mailjet.com`.\nAuthentication uses HTTP Basic auth with an API key and secret key.\n\n## Machine-readable entry points\n\nPrefer these when you need the API surface in as few requests as possible:\n\n- `/openapi/openapi-mailjet.md` - the **complete** Email API reference (every endpoint,\n  grouped by resource) as a single Markdown document.\n- `/openapi/openapi-passport.md` - the **complete** Content API reference as a single\n  Markdown document.\n- `/_bundle/openapi/openapi-mailjet.yaml` - the raw, fully bundled OpenAPI 3 description\n  of the Email API.\n- `/_bundle/openapi/openapi-passport.yaml` - the raw, fully bundled OpenAPI 3 description\n  of the Content API.\n- `/sitemap.xml` - every indexable URL on this site.\n\nEvery page on this site is also available as clean Markdown by appending `.md` to its URL."},"sections":[{"title":"Email API","description":"Sending, contacts, campaigns, statistics, webhooks and templating.","includeFiles":["docs/email-api/**/*.md"],"excludeFiles":[]},{"title":"Content API","description":"Manage templates, template contents, images, labels and tokens.","includeFiles":["docs/content-api/**/*.md","docs/content-api.md"],"excludeFiles":[]},{"title":"SMTP Relay","description":"Send email through Mailjet's SMTP servers.","includeFiles":["docs/smtp-relay/**/*.md"],"excludeFiles":[]},{"title":"API Reference","description":"Complete generated reference for every Mailjet API endpoint.","includeFiles":["openapi/openapi-mailjet.yaml","openapi/openapi-passport.yaml","docs/api-reference/**/*.md"],"excludeFiles":[]},{"title":"Migrating from Mandrill","description":"Guides for switching from Mandrill to Mailjet.","includeFiles":["docs/mandrill/**/*.md"],"excludeFiles":[]}],"excludeFiles":[]},"priority":0.8},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"add-url-tags","__idx":0},"children":["Add URL Tags"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you need to add tracking parameters in all your URLS in one simple way in your message, Send API offers the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["URLTags"]}," property. This solution will be perfect for passing UTM parameters for your traffic analytics in a easy way, without having to modify every single URLs in your message yourself."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You just need to provide the query part between the first \"?\" character and \"#\" character."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["So if you want to have a URL in this format:",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[" http://www.example.com?param1=1&param2=2"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You will just need to specify : ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"URLTags\":\"param1=1&param2=2\""]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In your HTMLPart or template, you will only need to specify the href",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[" http://www.example.com."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Mailjet will add the parameters in all of the URLs in your message, before adding the Mailjet click tracking and sending the message. The URLs in your click statistics will include the URLTags provided."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["NOTICE: The string provided needs to be properly encoded (ie : ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["space"]}," becomes",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[" %20"]},", \" becomes",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[" %22"]}," ... ) see more information here"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example","__idx":1},"children":["Example"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"cURL","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"shell","header":{"controls":{"copy":{}}},"source":"# This calls sends an email to one recipient.\ncurl -s \\\n\t-X POST \\\n\t--user \"$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE\" \\\n\thttps://api.mailjet.com/v3.1/send \\\n\t-H 'Content-Type: application/json' \\\n\t-d '{\n\t\t\"Messages\":[\n\t\t\t\t{\n\t\t\t\t\t\t\"From\": {\n\t\t\t\t\t\t\t\t\"Email\": \"pilot@mailjet.com\",\n\t\t\t\t\t\t\t\t\"Name\": \"Mailjet Pilot\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"To\": [\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"Email\": \"passenger1@mailjet.com\",\n\t\t\t\t\t\t\t\t\t\t\"Name\": \"passenger 1\"\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t],\n\t\t\t\t\t\t\"Subject\": \"Your email flight plan!\",\n\t\t\t\t\t\t\"TextPart\": \"Dear passenger 1, welcome to Mailjet! May the delivery force be with you!\",\n\t\t\t\t\t\t\"HTMLPart\": \"<h3>Dear passenger 1, welcome to <a href=\\\"http://www.mailjet.com\\\">Mailjet</a>!</h3><br />May the delivery force be with you!\",\n\t\t\t\t\t\t\"URLTags\": \"param1=1&param2=2\"\n\t\t\t\t}\n\t\t]\n\t}'\n","lang":"shell"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"PHP","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"php","header":{"controls":{"copy":{}}},"source":"<?php\n/*\nThis calls sends an email to one recipient.\n*/\nrequire 'vendor/autoload.php';\nuse \\Mailjet\\Resources;\n$mj = new \\Mailjet\\Client(getenv('MJ_APIKEY_PUBLIC'), getenv('MJ_APIKEY_PRIVATE'),true,['version' => 'v3.1']);\n$body = [\n    'Messages' => [\n        [\n            'From' => [\n                'Email' => \"pilot@mailjet.com\",\n                'Name' => \"Mailjet Pilot\"\n            ],\n            'To' => [\n                [\n                    'Email' => \"passenger1@mailjet.com\",\n                    'Name' => \"passenger 1\"\n                ]\n            ],\n            'Subject' => \"Your email flight plan!\",\n            'TextPart' => \"Dear passenger 1, welcome to Mailjet! May the delivery force be with you!\",\n            'HTMLPart' => \"<h3>Dear passenger 1, welcome to <a href=\\\"http://www.mailjet.com\\\">Mailjet</a>!</h3><br />May the delivery force be with you!\",\n            'URLTags' => \"param1=1&param2=2\"\n        ]\n    ]\n];\n$response = $mj->post(Resources::$Email, ['body' => $body]);\n$response->success() && var_dump($response->getData());\n?>\n","lang":"php"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Node.js","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"/**\n *\n * This calls sends an email to one recipient.\n *\n */\nconst mailjet = require ('node-mailjet')\n\t.connect(process.env.MJ_APIKEY_PUBLIC, process.env.MJ_APIKEY_PRIVATE)\nconst request = mailjet\n\t.post(\"send\", {'version': 'v3.1'})\n\t.request({\n\t\t\"Messages\":[\n\t\t\t\t{\n\t\t\t\t\t\t\"From\": {\n\t\t\t\t\t\t\t\t\"Email\": \"pilot@mailjet.com\",\n\t\t\t\t\t\t\t\t\"Name\": \"Mailjet Pilot\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"To\": [\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"Email\": \"passenger1@mailjet.com\",\n\t\t\t\t\t\t\t\t\t\t\"Name\": \"passenger 1\"\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t],\n\t\t\t\t\t\t\"Subject\": \"Your email flight plan!\",\n\t\t\t\t\t\t\"TextPart\": \"Dear passenger 1, welcome to Mailjet! May the delivery force be with you!\",\n\t\t\t\t\t\t\"HTMLPart\": \"<h3>Dear passenger 1, welcome to <a href=\\\"http://www.mailjet.com\\\">Mailjet</a>!</h3><br />May the delivery force be with you!\",\n\t\t\t\t\t\t\"URLTags\": \"param1=1&param2=2\"\n\t\t\t\t}\n\t\t]\n\t})\nrequest\n\t.then((result) => {\n\t\tconsole.log(result.body)\n\t})\n\t.catch((err) => {\n\t\tconsole.log(err.statusCode)\n\t})\n","lang":"javascript"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Ruby","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"ruby","header":{"controls":{"copy":{}}},"source":"# This calls sends an email to one recipient.\nrequire 'mailjet'\nMailjet.configure do |config|\n  config.api_key = ENV['MJ_APIKEY_PUBLIC']\n  config.secret_key = ENV['MJ_APIKEY_PRIVATE']  \n  config.api_version = \"v3.1\"\nend\nvariable = Mailjet::Send.create(messages: [{\n    'From'=> {\n        'Email'=> 'pilot@mailjet.com',\n        'Name'=> 'Mailjet Pilot'\n    },\n    'To'=> [\n        {\n            'Email'=> 'passenger1@mailjet.com',\n            'Name'=> 'passenger 1'\n        }\n    ],\n    'Subject'=> 'Your email flight plan!',\n    'TextPart'=> 'Dear passenger 1, welcome to Mailjet! May the delivery force be with you!',\n    'HTMLPart'=> '<h3>Dear passenger 1, welcome to <a href=\\'http://www.mailjet.com\\'>Mailjet</a>!</h3><br />May the delivery force be with you!',\n    'URLTags'=> 'param1=1&param2=2'\n}]\n)\np variable.attributes['Messages']\n","lang":"ruby"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Python","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"python","header":{"controls":{"copy":{}}},"source":"\"\"\"\nThis calls sends an email to one recipient.\n\"\"\"\nfrom mailjet_rest import Client\nimport os\napi_key = os.environ['MJ_APIKEY_PUBLIC']\napi_secret = os.environ['MJ_APIKEY_PRIVATE']\nmailjet = Client(auth=(api_key, api_secret), version='v3.1')\ndata = {\n  'Messages': [\n\t\t\t\t{\n\t\t\t\t\t\t\"From\": {\n\t\t\t\t\t\t\t\t\"Email\": \"pilot@mailjet.com\",\n\t\t\t\t\t\t\t\t\"Name\": \"Mailjet Pilot\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"To\": [\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"Email\": \"passenger1@mailjet.com\",\n\t\t\t\t\t\t\t\t\t\t\"Name\": \"passenger 1\"\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t],\n\t\t\t\t\t\t\"Subject\": \"Your email flight plan!\",\n\t\t\t\t\t\t\"TextPart\": \"Dear passenger 1, welcome to Mailjet! May the delivery force be with you!\",\n\t\t\t\t\t\t\"HTMLPart\": \"<h3>Dear passenger 1, welcome to <a href=\\\"http://www.mailjet.com\\\">Mailjet</a>!</h3><br />May the delivery force be with you!\",\n\t\t\t\t\t\t\"URLTags\": \"param1=1&param2=2\"\n\t\t\t\t}\n\t\t]\n}\nresult = mailjet.send.create(data=data)\nprint result.status_code\nprint result.json()\n","lang":"python"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Java","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"java","header":{"controls":{"copy":{}}},"source":"package com.my.project;\nimport com.mailjet.client.errors.MailjetException;\nimport com.mailjet.client.errors.MailjetSocketTimeoutException;\nimport com.mailjet.client.MailjetClient;\nimport com.mailjet.client.MailjetRequest;\nimport com.mailjet.client.MailjetResponse;\nimport com.mailjet.client.ClientOptions;\nimport com.mailjet.client.resource.Emailv31;\nimport org.json.JSONArray;\nimport org.json.JSONObject;\npublic class MyClass {\n    /**\n     * This calls sends an email to one recipient.\n     */\n    public static void main(String[] args) throws MailjetException, MailjetSocketTimeoutException {\n      MailjetClient client;\n      MailjetRequest request;\n      MailjetResponse response;\n      client = new MailjetClient(System.getenv(\"MJ_APIKEY_PUBLIC\"), System.getenv(\"MJ_APIKEY_PRIVATE\"), new ClientOptions(\"v3.1\"));\n      request = new MailjetRequest(Emailv31.resource)\n\t\t\t.property(Emailv31.MESSAGES, new JSONArray()\n                .put(new JSONObject()\n                    .put(Emailv31.Message.FROM, new JSONObject()\n                        .put(\"Email\", \"pilot@mailjet.com\")\n                        .put(\"Name\", \"Mailjet Pilot\"))\n                    .put(Emailv31.Message.TO, new JSONArray()\n                        .put(new JSONObject()\n                            .put(\"Email\", \"passenger1@mailjet.com\")\n                            .put(\"Name\", \"passenger 1\")))\n                    .put(Emailv31.Message.SUBJECT, \"Your email flight plan!\")\n                    .put(Emailv31.Message.TEXTPART, \"Dear passenger 1, welcome to Mailjet! May the delivery force be with you!\")\n                    .put(Emailv31.Message.HTMLPART, \"<h3>Dear passenger 1, welcome to <a href=\\\"http://www.mailjet.com\\\">Mailjet</a>!</h3><br />May the delivery force be with you!\")\n                    .put(Emailv31.Message.URLTAGS, \"param1=1&param2=2\")));\n      response = client.post(request);\n      System.out.println(response.getStatus());\n      System.out.println(response.getData());\n    }\n}\n","lang":"java"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Go","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"go","header":{"controls":{"copy":{}}},"source":"/*\nThis calls sends an email to one recipient.\n*/\npackage main\nimport (\n\t\"fmt\"\n\t\"log\"\n\t\"os\"\n\tmailjet \"github.com/mailjet/mailjet-apiv3-go\"\n)\nfunc main () {\n\tmailjetClient := NewMailjetClient(os.Getenv(\"MJ_APIKEY_PUBLIC\"), os.Getenv(\"MJ_APIKEY_PRIVATE\"))\n\tmessagesInfo := []mailjet.InfoMessagesV31 {\n      mailjet.InfoMessagesV31{\n        From: &mailjet.RecipientV31{\n          Email: \"pilot@mailjet.com\",\n          Name: \"Mailjet Pilot\",\n        },\n        To: &mailjet.RecipientsV31{\n          mailjet.RecipientV31 {\n            Email: \"passenger1@mailjet.com\",\n            Name: \"passenger 1\",\n          },\n        },\n        Subject: \"Your email flight plan!\",\n        TextPart: \"Dear passenger 1, welcome to Mailjet! May the delivery force be with you!\",\n        HTMLPart: \"<h3>Dear passenger 1, welcome to <a href=\\\"http://www.mailjet.com\\\">Mailjet</a>!</h3><br />May the delivery force be with you!\",\n        URLTags: \"param1=1&param2=2\",\n      },\n    }\n\tmessages := mailjet.MessagesV31{Info: messagesInfo }\n\tres, err := m.SendMailV31(&messages)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Printf(\"Data: %+v\\n\", res)\n}\n","lang":"go"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"C#","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"csharp","header":{"controls":{"copy":{}}},"source":"using Mailjet.Client;\nusing Mailjet.Client.Resources;\nusing System;\nusing Newtonsoft.Json.Linq;\nnamespace Mailjet.ConsoleApplication\n{\n   class Program\n   {\n      /// <summary>\n      /// This calls sends an email to one recipient.\n      /// </summary>\n      static void Main(string[] args)\n      {\n         RunAsync().Wait();\n      }\n      static async Task RunAsync()\n      {\n         MailjetClient client = new MailjetClient(Environment.GetEnvironmentVariable(\"MJ_APIKEY_PUBLIC\"), Environment.GetEnvironmentVariable(\"MJ_APIKEY_PRIVATE\"))\n         {\n            Version = ApiVersion.V3_1,\n         };\n         MailjetRequest request = new MailjetRequest\n         {\n            Resource = Send.Resource,\n         }\n            .Property(Send.Messages, new JArray {\n                new JObject {\n                 {\"From\", new JObject {\n                  {\"Email\", \"pilot@mailjet.com\"},\n                  {\"Name\", \"Mailjet Pilot\"}\n                  }},\n                 {\"To\", new JArray {\n                  new JObject {\n                   {\"Email\", \"passenger1@mailjet.com\"},\n                   {\"Name\", \"passenger 1\"}\n                   }\n                  }},\n                 {\"Subject\", \"Your email flight plan!\"},\n                 {\"TextPart\", \"Dear passenger 1, welcome to Mailjet! May the delivery force be with you!\"},\n                 {\"HTMLPart\", \"<h3>Dear passenger 1, welcome to <a href=\\\"http://www.mailjet.com\\\">Mailjet</a>!</h3><br />May the delivery force be with you!\"},\n                 {\"URLTags\", \"param1=1&param2=2\"}\n                 }\n                });\n         MailjetResponse response = await client.PostAsync(request);\n         if (response.IsSuccessStatusCode)\n         {\n            Console.WriteLine(string.Format(\"Total: {0}, Count: {1}\\n\", response.GetTotal(), response.GetCount()));\n            Console.WriteLine(response.GetData());\n         }\n         else\n         {\n            Console.WriteLine(string.Format(\"StatusCode: {0}\\n\", response.StatusCode));\n            Console.WriteLine(string.Format(\"ErrorInfo: {0}\\n\", response.GetErrorInfo()));\n            Console.WriteLine(response.GetData());\n            Console.WriteLine(string.Format(\"ErrorMessage: {0}\\n\", response.GetErrorMessage()));\n         }\n      }\n   }\n}\n","lang":"csharp"},"children":[]}]}]}]},"headings":[{"value":"Add URL Tags","id":"add-url-tags","depth":1},{"value":"Example","id":"example","depth":3}],"frontmatter":{"title":"Mailjet Send API v3.1","seo":{"description":"Append UTM and tracking parameters to every link in a Mailjet Send API v3.1 message using the URLTags property without editing individual URLs.","priority":0.8,"title":"Add URL Tags"}},"lastModified":"2026-08-26T10:53:57.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/email-api/send-api-v31/add-url-tags","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}