Short code to use instead of a generated one. Letters, numbers, hyphens and underscores only. Short codes are globally unique across every workspace, so a code taken elsewhere returns 409.
Plain-text password the visitor must enter. Stored as a bcrypt hash and never returned — responses expose hasPassword instead. Counts against the passwordProtectedLinks plan quota.
Country-specific destinations. Pick a country and enter the URL visitors from that country are sent to. Requires the geoTargeting plan feature. Every target URL runs through the same safety scan as url. A map of country code to URL ({"US": "https://acme.com/us"}) is also accepted.
Preview image for the link. Send an absolute URL, or upload the file inline by posting multipart/form-data with the JSON body in a payload part and the image in an ogImageFile part (PNG/JPEG/WebP, 5 MB max).
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"linkutm","colors":{"primary":"#ff6200","light":"#ff6200","dark":"#ff6200"},"logo":{"light":"https://mintcdn.com/utm-e577acb5/3C2acBV9fWv9F5zu/logo/light.svg?fit=max\u0026auto=format\u0026n=3C2acBV9fWv9F5zu\u0026q=85\u0026s=1a0ed464d45ea6d3c2e41d0c7e5ffe1f","dark":"https://mintcdn.com/utm-e577acb5/3C2acBV9fWv9F5zu/logo/dark.svg?fit=max\u0026auto=format\u0026n=3C2acBV9fWv9F5zu\u0026q=85\u0026s=fcfbf4a77cde2510404e49fc3e1dc061"},"favicon":"https://mintcdn.com/utm-e577acb5/QolUdNrEUEGDmCqg/favicon.svg?fit=max\u0026auto=format\u0026n=QolUdNrEUEGDmCqg\u0026q=85\u0026s=523d83fd0143da408255f709dcdc2f46","navbar":{"links":[{"href":"mailto:hello@linkutm.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.linkutm.com"}},"footer":{"socials":{"x":"https://x.com/linkutm_hq","facebook":"https://www.facebook.com/people/Linkutm/61583414725717","linkedin":"https://www.linkedin.com/company/linkutm","discord":"https://go.linkutm.com/discord"}},"contextual":{"options":["copy","view","chatgpt","claude","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Changelog","icon":"clock","href":"/changelog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"utm-e577acb5","hasAudioNarration":false,"actualSubdomain":"utm-e577acb5","customDomains":["docs.linkutm.com"],"gitSource":{"type":"github","owner":"bhargav19-root","repo":"docs","deployBranch":"updated_docs","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad5fe659abc0e0a9f4784f6","collectionId":"40371c53-9b88-4e8c-b460-92251e799aed","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad5fe659abc0e0a9f4784f6"},"entitlements":{},"buildId":"6ad5fe659abc0e0a9f4784f6","clientVersion":"0.0.4076","searchFilterCounts":[{"language":"default","tag":"Links","count":36},{"language":"default","tag":"API Reference","count":25},{"language":"default","tag":"Linkutm Links API","count":21},{"language":"default","tag":"Link Management","count":19},{"language":"default","tag":"Domains","count":7},{"language":"default","tag":"Folders","count":5},{"language":"default","tag":"UTM Standards","count":5},{"language":"default","tag":"Getting started","count":4},{"language":"default","tag":"Tags","count":4},{"language":"default","tag":"Workspaces \u0026 Team","count":4}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api/links/update","slug":"/api/links/update","pageMetadata":{"title":"Update a link","openapi":"PATCH /links/{id}","description":"Update a link. Omitted fields are left unchanged.","href":"/api/links/update"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Update a link. Omitted fields are left unchanged.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Update a link","openapi":"PATCH /links/{id}","description":"Update a link. Omitted fields are left unchanged.","href":"/api/links/update"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"updateLink","summary":"Update a link","tags":["Links"],"description":"Update a link. Omitted fields are left unchanged.","x-permission":"links.edit","parameters":["cdb4c15d-21ed-4ec3-80bd-47f4b132779d"],"requestBody":"6ce16e9b-fc2f-4af7-a283-8e718428f770","responses":{"200":"527ac59f-4a63-4992-868b-e6a025a4b956","400":"c59e7b1a-b579-43ac-9d84-4c2da4b46afb","401":"09a9970d-0034-4b01-a090-84a7ad39dbec","403":"9809fb68-0566-4bf5-9c38-a96148dfeaf8","404":"2a3f371d-3cdc-482f-9808-a43215e0b029","409":"299c2559-4298-412d-888d-22d382414ec0","500":"7f1d3d19-335b-4a50-a31b-248e5f26b6c3"},"method":"patch","type":"path","servers":["42407d43-bba1-4aa5-8fc3-db9fec6cb642"],"security":["4507dab4-7aee-4d72-b560-04992f6b9435","48d713e5-206e-44b3-902f-aef17052ddd6"],"path":"/links/{id}","baseUrlOptions":["https://api.linkutm.com/api/v1"],"title":"Update a link","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"cdb4c15d-21ed-4ec3-80bd-47f4b132779d":{"name":"id","in":"path","required":true,"description":"Link ID.","schema":{"type":"string","format":"uuid","isRequired":true,"description":"Link ID.","uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Every field is optional. Sending `null` for a nullable field clears it; omitting a field leaves it unchanged.","properties":{"url":{"type":"string","maxLength":2048,"description":"New destination URL. Re-runs the destination safety scan.","uniqueKey":"url","typeLabel":"string"},"archived":{"type":"boolean","description":"Archive or restore the link.","uniqueKey":"archived","typeLabel":"boolean"},"title":{"oneOf":[{"type":"string","description":"Internal name for the link.","maxLength":255,"example":"Spring campaign","uniqueKey":"title.oneOf.0","typeLabel":"string"},{"type":"null","description":"Internal name for the link.","maxLength":255,"example":"Spring campaign","uniqueKey":"title.oneOf.1","typeLabel":"null"}],"uniqueKey":"title","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","description":"Internal description.","maxLength":2000,"uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","description":"Internal description.","maxLength":2000,"uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"customSlug":{"type":"string","description":"Short code to use instead of a generated one. Letters, numbers, hyphens and underscores only. Short codes are globally unique across every workspace, so a code taken elsewhere returns `409`.","maxLength":50,"pattern":"^[a-zA-Z0-9_-]+$","example":"spring-sale","uniqueKey":"customSlug","typeLabel":"string"},"utmSource":{"oneOf":[{"type":"string","description":"`utm_source` appended to the destination URL.","maxLength":255,"example":"newsletter","uniqueKey":"utmSource.oneOf.0","typeLabel":"string"},{"type":"null","description":"`utm_source` appended to the destination URL.","maxLength":255,"example":"newsletter","uniqueKey":"utmSource.oneOf.1","typeLabel":"null"}],"uniqueKey":"utmSource","typeLabel":"string | null"},"utmMedium":{"oneOf":[{"type":"string","description":"`utm_medium` appended to the destination URL.","maxLength":255,"example":"email","uniqueKey":"utmMedium.oneOf.0","typeLabel":"string"},{"type":"null","description":"`utm_medium` appended to the destination URL.","maxLength":255,"example":"email","uniqueKey":"utmMedium.oneOf.1","typeLabel":"null"}],"uniqueKey":"utmMedium","typeLabel":"string | null"},"utmCampaign":{"oneOf":[{"type":"string","description":"`utm_campaign` appended to the destination URL.","maxLength":255,"example":"spring-2026","uniqueKey":"utmCampaign.oneOf.0","typeLabel":"string"},{"type":"null","description":"`utm_campaign` appended to the destination URL.","maxLength":255,"example":"spring-2026","uniqueKey":"utmCampaign.oneOf.1","typeLabel":"null"}],"uniqueKey":"utmCampaign","typeLabel":"string | null"},"utmTerm":{"oneOf":[{"type":"string","description":"`utm_term` appended to the destination URL.","maxLength":255,"uniqueKey":"utmTerm.oneOf.0","typeLabel":"string"},{"type":"null","description":"`utm_term` appended to the destination URL.","maxLength":255,"uniqueKey":"utmTerm.oneOf.1","typeLabel":"null"}],"uniqueKey":"utmTerm","typeLabel":"string | null"},"utmContent":{"oneOf":[{"type":"string","description":"`utm_content` appended to the destination URL.","maxLength":255,"uniqueKey":"utmContent.oneOf.0","typeLabel":"string"},{"type":"null","description":"`utm_content` appended to the destination URL.","maxLength":255,"uniqueKey":"utmContent.oneOf.1","typeLabel":"null"}],"uniqueKey":"utmContent","typeLabel":"string | null"},"customUtmParams":{"oneOf":[{"type":"object","description":"Workspace-defined UTM parameters, keyed by the parameter code configured under **Parameters**. Validated against the workspace's UTM rules.","additionalProperties":{"type":"string","uniqueKey":"customUtmParams.oneOf.0.additionalProperties","typeLabel":"string"},"example":{"partner":"acme"},"uniqueKey":"customUtmParams.oneOf.0","typeLabel":"object"},{"type":"null","description":"Workspace-defined UTM parameters, keyed by the parameter code configured under **Parameters**. Validated against the workspace's UTM rules.","additionalProperties":{"type":"string","uniqueKey":"customUtmParams.oneOf.1.additionalProperties","typeLabel":"string"},"example":{"partner":"acme"},"uniqueKey":"customUtmParams.oneOf.1","typeLabel":"null"}],"uniqueKey":"customUtmParams","typeLabel":"object | null"},"password":{"oneOf":[{"type":"string","description":"Plain-text password the visitor must enter. Stored as a bcrypt hash and never returned — responses expose `hasPassword` instead. Counts against the `passwordProtectedLinks` plan quota.","maxLength":200,"uniqueKey":"password.oneOf.0","typeLabel":"string"},{"type":"null","description":"Plain-text password the visitor must enter. Stored as a bcrypt hash and never returned — responses expose `hasPassword` instead. Counts against the `passwordProtectedLinks` plan quota.","maxLength":200,"uniqueKey":"password.oneOf.1","typeLabel":"null"}],"uniqueKey":"password","typeLabel":"string | null"},"expiresAt":{"oneOf":[{"type":"string","description":"ISO 8601 instant after which the link stops redirecting. Requires the `linkScheduling` plan feature.","format":"date-time","example":"2026-12-31T00:00:00.000Z","uniqueKey":"expiresAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"ISO 8601 instant after which the link stops redirecting. Requires the `linkScheduling` plan feature.","format":"date-time","example":"2026-12-31T00:00:00.000Z","uniqueKey":"expiresAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"expiresAt","typeLabel":"string\u003cdate-time> | null"},"scheduledAt":{"oneOf":[{"type":"string","description":"ISO 8601 instant before which the link does not redirect yet. Requires the `linkScheduling` plan feature.","format":"date-time","uniqueKey":"scheduledAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"ISO 8601 instant before which the link does not redirect yet. Requires the `linkScheduling` plan feature.","format":"date-time","uniqueKey":"scheduledAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"scheduledAt","typeLabel":"string\u003cdate-time> | null"},"schedulingTimezone":{"oneOf":[{"type":"string","description":"IANA timezone used to interpret the schedule in the UI.","maxLength":64,"example":"Asia/Kolkata","uniqueKey":"schedulingTimezone.oneOf.0","typeLabel":"string"},{"type":"null","description":"IANA timezone used to interpret the schedule in the UI.","maxLength":64,"example":"Asia/Kolkata","uniqueKey":"schedulingTimezone.oneOf.1","typeLabel":"null"}],"uniqueKey":"schedulingTimezone","typeLabel":"string | null"},"fallbackUrl":{"oneOf":[{"type":"string","description":"Where to send visitors once the link is expired, not yet live, or over its click limit.","maxLength":2048,"uniqueKey":"fallbackUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"Where to send visitors once the link is expired, not yet live, or over its click limit.","maxLength":2048,"uniqueKey":"fallbackUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"fallbackUrl","typeLabel":"string | null"},"clickLimit":{"oneOf":[{"type":"integer","description":"Stop redirecting after this many clicks.","minimum":1,"maximum":2147483647,"example":1000,"uniqueKey":"clickLimit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Stop redirecting after this many clicks.","minimum":1,"maximum":2147483647,"example":1000,"uniqueKey":"clickLimit.oneOf.1","typeLabel":"null"}],"uniqueKey":"clickLimit","typeLabel":"integer | null"},"iosUrl":{"oneOf":[{"type":"string","description":"Destination for iOS visitors. Requires the `deviceTargeting` plan feature.","maxLength":2048,"uniqueKey":"iosUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"Destination for iOS visitors. Requires the `deviceTargeting` plan feature.","maxLength":2048,"uniqueKey":"iosUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"iosUrl","typeLabel":"string | null"},"androidUrl":{"oneOf":[{"type":"string","description":"Destination for Android visitors. Requires the `deviceTargeting` plan feature.","maxLength":2048,"uniqueKey":"androidUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"Destination for Android visitors. Requires the `deviceTargeting` plan feature.","maxLength":2048,"uniqueKey":"androidUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"androidUrl","typeLabel":"string | null"},"geoTargets":{"oneOf":[{"type":"array","description":"Country-specific destinations. Pick a country and enter the URL visitors from that country are sent to. Requires the `geoTargeting` plan feature. Every target URL runs through the same safety scan as `url`. A map of country code to URL (`{\"US\": \"https://acme.com/us\"}`) is also accepted.","maxItems":100,"items":{"type":"object","required":["country","url"],"properties":{"country":{"type":"string","description":"ISO 3166-1 alpha-2 country code. The flag prefix is optional — `US` and `🇺🇸 US` are both accepted.","enum":["🇦🇩 AD","🇦🇪 AE","🇦🇫 AF","🇦🇬 AG","🇦🇮 AI","🇦🇱 AL","🇦🇲 AM","🇦🇴 AO","🇦🇶 AQ","🇦🇷 AR","🇦🇸 AS","🇦🇹 AT","🇦🇺 AU","🇦🇼 AW","🇦🇽 AX","🇦🇿 AZ","🇧🇦 BA","🇧🇧 BB","🇧🇩 BD","🇧🇪 BE","🇧🇫 BF","🇧🇬 BG","🇧🇭 BH","🇧🇮 BI","🇧🇯 BJ","🇧🇱 BL","🇧🇲 BM","🇧🇳 BN","🇧🇴 BO","🇧🇶 BQ","🇧🇷 BR","🇧🇸 BS","🇧🇹 BT","🇧🇻 BV","🇧🇼 BW","🇧🇾 BY","🇧🇿 BZ","🇨🇦 CA","🇨🇨 CC","🇨🇩 CD","🇨🇫 CF","🇨🇬 CG","🇨🇭 CH","🇨🇮 CI","🇨🇰 CK","🇨🇱 CL","🇨🇲 CM","🇨🇳 CN","🇨🇴 CO","🇨🇷 CR","🇨🇺 CU","🇨🇻 CV","🇨🇼 CW","🇨🇽 CX","🇨🇾 CY","🇨🇿 CZ","🇩🇪 DE","🇩🇯 DJ","🇩🇰 DK","🇩🇲 DM","🇩🇴 DO","🇩🇿 DZ","🇪🇨 EC","🇪🇪 EE","🇪🇬 EG","🇪🇭 EH","🇪🇷 ER","🇪🇸 ES","🇪🇹 ET","🇫🇮 FI","🇫🇯 FJ","🇫🇰 FK","🇫🇲 FM","🇫🇴 FO","🇫🇷 FR","🇬🇦 GA","🇬🇧 GB","🇬🇩 GD","🇬🇪 GE","🇬🇫 GF","🇬🇬 GG","🇬🇭 GH","🇬🇮 GI","🇬🇱 GL","🇬🇲 GM","🇬🇳 GN","🇬🇵 GP","🇬🇶 GQ","🇬🇷 GR","🇬🇸 GS","🇬🇹 GT","🇬🇺 GU","🇬🇼 GW","🇬🇾 GY","🇭🇰 HK","🇭🇲 HM","🇭🇳 HN","🇭🇷 HR","🇭🇹 HT","🇭🇺 HU","🇮🇩 ID","🇮🇪 IE","🇮🇱 IL","🇮🇲 IM","🇮🇳 IN","🇮🇴 IO","🇮🇶 IQ","🇮🇷 IR","🇮🇸 IS","🇮🇹 IT","🇯🇪 JE","🇯🇲 JM","🇯🇴 JO","🇯🇵 JP","🇰🇪 KE","🇰🇬 KG","🇰🇭 KH","🇰🇮 KI","🇰🇲 KM","🇰🇳 KN","🇰🇵 KP","🇰🇷 KR","🇰🇼 KW","🇰🇾 KY","🇰🇿 KZ","🇱🇦 LA","🇱🇧 LB","🇱🇨 LC","🇱🇮 LI","🇱🇰 LK","🇱🇷 LR","🇱🇸 LS","🇱🇹 LT","🇱🇺 LU","🇱🇻 LV","🇱🇾 LY","🇲🇦 MA","🇲🇨 MC","🇲🇩 MD","🇲🇪 ME","🇲🇫 MF","🇲🇬 MG","🇲🇭 MH","🇲🇰 MK","🇲🇱 ML","🇲🇲 MM","🇲🇳 MN","🇲🇴 MO","🇲🇵 MP","🇲🇶 MQ","🇲🇷 MR","🇲🇸 MS","🇲🇹 MT","🇲🇺 MU","🇲🇻 MV","🇲🇼 MW","🇲🇽 MX","🇲🇾 MY","🇲🇿 MZ","🇳🇦 NA","🇳🇨 NC","🇳🇪 NE","🇳🇫 NF","🇳🇬 NG","🇳🇮 NI","🇳🇱 NL","🇳🇴 NO","🇳🇵 NP","🇳🇷 NR","🇳🇺 NU","🇳🇿 NZ","🇴🇲 OM","🇵🇦 PA","🇵🇪 PE","🇵🇫 PF","🇵🇬 PG","🇵🇭 PH","🇵🇰 PK","🇵🇱 PL","🇵🇲 PM","🇵🇳 PN","🇵🇷 PR","🇵🇸 PS","🇵🇹 PT","🇵🇼 PW","🇵🇾 PY","🇶🇦 QA","🇷🇪 RE","🇷🇴 RO","🇷🇸 RS","🇷🇺 RU","🇷🇼 RW","🇸🇦 SA","🇸🇧 SB","🇸🇨 SC","🇸🇩 SD","🇸🇪 SE","🇸🇬 SG","🇸🇭 SH","🇸🇮 SI","🇸🇯 SJ","🇸🇰 SK","🇸🇱 SL","🇸🇲 SM","🇸🇳 SN","🇸🇴 SO","🇸🇷 SR","🇸🇸 SS","🇸🇹 ST","🇸🇻 SV","🇸🇽 SX","🇸🇾 SY","🇸🇿 SZ","🇹🇨 TC","🇹🇩 TD","🇹🇫 TF","🇹🇬 TG","🇹🇭 TH","🇹🇯 TJ","🇹🇰 TK","🇹🇱 TL","🇹🇲 TM","🇹🇳 TN","🇹🇴 TO","🇹🇷 TR","🇹🇹 TT","🇹🇻 TV","🇹🇼 TW","🇹🇿 TZ","🇺🇦 UA","🇺🇬 UG","🇺🇲 UM","🇺🇸 US","🇺🇾 UY","🇺🇿 UZ","🇻🇦 VA","🇻🇨 VC","🇻🇪 VE","🇻🇬 VG","🇻🇮 VI","🇻🇳 VN","🇻🇺 VU","🇼🇫 WF","🇼🇸 WS","🇾🇪 YE","🇾🇹 YT","🇿🇦 ZA","🇿🇲 ZM","🇿🇼 ZW"],"isRequired":true,"uniqueKey":"geoTargets.oneOf.0.items.[INDEX].country","typeLabel":"enum\u003cstring>"},"url":{"type":"string","format":"uri","description":"Destination for visitors from this country.","maxLength":2048,"isRequired":true,"uniqueKey":"geoTargets.oneOf.0.items.[INDEX].url","typeLabel":"string\u003curi>"}},"uniqueKey":"geoTargets.oneOf.0.items.[INDEX]","typeLabel":"object"},"example":[{"country":"🇺🇸 US","url":"https://acme.com/us"},{"country":"🇮🇳 IN","url":"https://acme.com/in"}],"uniqueKey":"geoTargets.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"Country-specific destinations. Pick a country and enter the URL visitors from that country are sent to. Requires the `geoTargeting` plan feature. Every target URL runs through the same safety scan as `url`. A map of country code to URL (`{\"US\": \"https://acme.com/us\"}`) is also accepted.","maxItems":100,"items":{"type":"object","required":["country","url"],"properties":{"country":{"type":"string","description":"ISO 3166-1 alpha-2 country code. The flag prefix is optional — `US` and `🇺🇸 US` are both accepted.","enum":["🇦🇩 AD","🇦🇪 AE","🇦🇫 AF","🇦🇬 AG","🇦🇮 AI","🇦🇱 AL","🇦🇲 AM","🇦🇴 AO","🇦🇶 AQ","🇦🇷 AR","🇦🇸 AS","🇦🇹 AT","🇦🇺 AU","🇦🇼 AW","🇦🇽 AX","🇦🇿 AZ","🇧🇦 BA","🇧🇧 BB","🇧🇩 BD","🇧🇪 BE","🇧🇫 BF","🇧🇬 BG","🇧🇭 BH","🇧🇮 BI","🇧🇯 BJ","🇧🇱 BL","🇧🇲 BM","🇧🇳 BN","🇧🇴 BO","🇧🇶 BQ","🇧🇷 BR","🇧🇸 BS","🇧🇹 BT","🇧🇻 BV","🇧🇼 BW","🇧🇾 BY","🇧🇿 BZ","🇨🇦 CA","🇨🇨 CC","🇨🇩 CD","🇨🇫 CF","🇨🇬 CG","🇨🇭 CH","🇨🇮 CI","🇨🇰 CK","🇨🇱 CL","🇨🇲 CM","🇨🇳 CN","🇨🇴 CO","🇨🇷 CR","🇨🇺 CU","🇨🇻 CV","🇨🇼 CW","🇨🇽 CX","🇨🇾 CY","🇨🇿 CZ","🇩🇪 DE","🇩🇯 DJ","🇩🇰 DK","🇩🇲 DM","🇩🇴 DO","🇩🇿 DZ","🇪🇨 EC","🇪🇪 EE","🇪🇬 EG","🇪🇭 EH","🇪🇷 ER","🇪🇸 ES","🇪🇹 ET","🇫🇮 FI","🇫🇯 FJ","🇫🇰 FK","🇫🇲 FM","🇫🇴 FO","🇫🇷 FR","🇬🇦 GA","🇬🇧 GB","🇬🇩 GD","🇬🇪 GE","🇬🇫 GF","🇬🇬 GG","🇬🇭 GH","🇬🇮 GI","🇬🇱 GL","🇬🇲 GM","🇬🇳 GN","🇬🇵 GP","🇬🇶 GQ","🇬🇷 GR","🇬🇸 GS","🇬🇹 GT","🇬🇺 GU","🇬🇼 GW","🇬🇾 GY","🇭🇰 HK","🇭🇲 HM","🇭🇳 HN","🇭🇷 HR","🇭🇹 HT","🇭🇺 HU","🇮🇩 ID","🇮🇪 IE","🇮🇱 IL","🇮🇲 IM","🇮🇳 IN","🇮🇴 IO","🇮🇶 IQ","🇮🇷 IR","🇮🇸 IS","🇮🇹 IT","🇯🇪 JE","🇯🇲 JM","🇯🇴 JO","🇯🇵 JP","🇰🇪 KE","🇰🇬 KG","🇰🇭 KH","🇰🇮 KI","🇰🇲 KM","🇰🇳 KN","🇰🇵 KP","🇰🇷 KR","🇰🇼 KW","🇰🇾 KY","🇰🇿 KZ","🇱🇦 LA","🇱🇧 LB","🇱🇨 LC","🇱🇮 LI","🇱🇰 LK","🇱🇷 LR","🇱🇸 LS","🇱🇹 LT","🇱🇺 LU","🇱🇻 LV","🇱🇾 LY","🇲🇦 MA","🇲🇨 MC","🇲🇩 MD","🇲🇪 ME","🇲🇫 MF","🇲🇬 MG","🇲🇭 MH","🇲🇰 MK","🇲🇱 ML","🇲🇲 MM","🇲🇳 MN","🇲🇴 MO","🇲🇵 MP","🇲🇶 MQ","🇲🇷 MR","🇲🇸 MS","🇲🇹 MT","🇲🇺 MU","🇲🇻 MV","🇲🇼 MW","🇲🇽 MX","🇲🇾 MY","🇲🇿 MZ","🇳🇦 NA","🇳🇨 NC","🇳🇪 NE","🇳🇫 NF","🇳🇬 NG","🇳🇮 NI","🇳🇱 NL","🇳🇴 NO","🇳🇵 NP","🇳🇷 NR","🇳🇺 NU","🇳🇿 NZ","🇴🇲 OM","🇵🇦 PA","🇵🇪 PE","🇵🇫 PF","🇵🇬 PG","🇵🇭 PH","🇵🇰 PK","🇵🇱 PL","🇵🇲 PM","🇵🇳 PN","🇵🇷 PR","🇵🇸 PS","🇵🇹 PT","🇵🇼 PW","🇵🇾 PY","🇶🇦 QA","🇷🇪 RE","🇷🇴 RO","🇷🇸 RS","🇷🇺 RU","🇷🇼 RW","🇸🇦 SA","🇸🇧 SB","🇸🇨 SC","🇸🇩 SD","🇸🇪 SE","🇸🇬 SG","🇸🇭 SH","🇸🇮 SI","🇸🇯 SJ","🇸🇰 SK","🇸🇱 SL","🇸🇲 SM","🇸🇳 SN","🇸🇴 SO","🇸🇷 SR","🇸🇸 SS","🇸🇹 ST","🇸🇻 SV","🇸🇽 SX","🇸🇾 SY","🇸🇿 SZ","🇹🇨 TC","🇹🇩 TD","🇹🇫 TF","🇹🇬 TG","🇹🇭 TH","🇹🇯 TJ","🇹🇰 TK","🇹🇱 TL","🇹🇲 TM","🇹🇳 TN","🇹🇴 TO","🇹🇷 TR","🇹🇹 TT","🇹🇻 TV","🇹🇼 TW","🇹🇿 TZ","🇺🇦 UA","🇺🇬 UG","🇺🇲 UM","🇺🇸 US","🇺🇾 UY","🇺🇿 UZ","🇻🇦 VA","🇻🇨 VC","🇻🇪 VE","🇻🇬 VG","🇻🇮 VI","🇻🇳 VN","🇻🇺 VU","🇼🇫 WF","🇼🇸 WS","🇾🇪 YE","🇾🇹 YT","🇿🇦 ZA","🇿🇲 ZM","🇿🇼 ZW"]},"url":{"type":"string","format":"uri","description":"Destination for visitors from this country.","maxLength":2048}}},"example":[{"country":"🇺🇸 US","url":"https://acme.com/us"},{"country":"🇮🇳 IN","url":"https://acme.com/in"}],"uniqueKey":"geoTargets.oneOf.1","typeLabel":"null"}],"uniqueKey":"geoTargets","typeLabel":"object[] | null"},"geoTargetingEnabled":{"type":"boolean","description":"Turns geo targeting on. Set automatically when `geoTargets` is supplied unless explicitly `false`.","uniqueKey":"geoTargetingEnabled","typeLabel":"boolean"},"ogTitle":{"oneOf":[{"type":"string","description":"Open Graph title used in link previews.","maxLength":255,"uniqueKey":"ogTitle.oneOf.0","typeLabel":"string"},{"type":"null","description":"Open Graph title used in link previews.","maxLength":255,"uniqueKey":"ogTitle.oneOf.1","typeLabel":"null"}],"uniqueKey":"ogTitle","typeLabel":"string | null"},"ogDescription":{"oneOf":[{"type":"string","description":"Open Graph description used in link previews.","maxLength":2000,"uniqueKey":"ogDescription.oneOf.0","typeLabel":"string"},{"type":"null","description":"Open Graph description used in link previews.","maxLength":2000,"uniqueKey":"ogDescription.oneOf.1","typeLabel":"null"}],"uniqueKey":"ogDescription","typeLabel":"string | null"},"ogImage":{"oneOf":[{"type":"string","description":"Preview image for the link. Send an absolute URL, or upload the file inline by posting `multipart/form-data` with the JSON body in a `payload` part and the image in an `ogImageFile` part (PNG/JPEG/WebP, 5 MB max).","maxLength":2048,"uniqueKey":"ogImage.oneOf.0","typeLabel":"string"},{"type":"null","description":"Preview image for the link. Send an absolute URL, or upload the file inline by posting `multipart/form-data` with the JSON body in a `payload` part and the image in an `ogImageFile` part (PNG/JPEG/WebP, 5 MB max).","maxLength":2048,"uniqueKey":"ogImage.oneOf.1","typeLabel":"null"}],"uniqueKey":"ogImage","typeLabel":"string | null"},"comments":{"type":"string","description":"Internal note. Never shown to visitors.","maxLength":2000,"uniqueKey":"comments","typeLabel":"string"},"folderId":{"oneOf":[{"type":"string","format":"uuid","description":"Folder to file the link under. Requires the `tagsAndFolders` plan feature.","uniqueKey":"folderId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Folder to file the link under. Requires the `tagsAndFolders` plan feature.","uniqueKey":"folderId.oneOf.1","typeLabel":"null"}],"uniqueKey":"folderId","typeLabel":"string\u003cuuid> | null"},"tagIds":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"tagIds.items.[INDEX]","typeLabel":"string\u003cuuid>"},"description":"Tags to attach. Every ID must belong to the same workspace. Requires the `tagsAndFolders` plan feature.","uniqueKey":"tagIds","typeLabel":"string\u003cuuid>[]"},"pixelIds":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"pixelIds.items.[INDEX]","typeLabel":"string\u003cuuid>"},"description":"Tracking pixels to fire on click. Every ID must belong to the same workspace.","uniqueKey":"pixelIds","typeLabel":"string\u003cuuid>[]"},"domainId":{"type":"string","format":"uuid","description":"Custom domain to build the short URL from. Defaults to the workspace's default domain, then to the system domain.","uniqueKey":"domainId","typeLabel":"string\u003cuuid>"},"templateId":{"oneOf":[{"type":"string","format":"uuid","description":"UTM template to apply to this link.","uniqueKey":"templateId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"UTM template to apply to this link.","uniqueKey":"templateId.oneOf.1","typeLabel":"null"}],"uniqueKey":"templateId","typeLabel":"string\u003cuuid> | null"},"cloakingEnabled":{"type":"boolean","description":"Serve the destination inside a frame instead of redirecting. Requires the `linkCloaking` plan feature.","uniqueKey":"cloakingEnabled","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"example":{"url":"https://acme.com/pricing","title":"Spring campaign","customSlug":"spring-sale","utmSource":"newsletter","utmMedium":"email","utmCampaign":"spring-2026"},"examples":{"Example":{"title":"Example","value":{"url":"https://acme.com/pricing","title":"Spring campaign","customSlug":"spring-sale","utmSource":"newsletter","utmMedium":"email","utmCampaign":"spring-2026"}}},"exampleType":"examples"},"multipart/form-data":{"schema":{"type":"object","properties":{"payload":{"type":"string","description":"The JSON body above, serialised as a string.","uniqueKey":"payload","typeLabel":"string"},"ogImageFile":{"type":"string","format":"binary","description":"Preview image to upload (5 MB max).","uniqueKey":"ogImageFile","typeLabel":"file"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"payload":"\u003cstring>","ogImageFile":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"examples"},"responses":{"527ac59f-4a63-4992-868b-e6a025a4b956":{"description":"The updated link.","content":{"application/json":{"schema":{"type":"object","description":"Full link record as returned by `GET /links/{id}`, `PATCH /links/{id}`, `DELETE /links/{id}` and `POST /links/upsert`.\n\nThe stored `password` is a bcrypt hash and is **never** serialised — the boolean `hasPassword` is returned in its place.","properties":{"id":{"type":"string","format":"uuid","uniqueKey":"id","typeLabel":"string\u003cuuid>"},"url":{"type":"string","description":"Destination URL.","example":"https://acme.com/pricing","uniqueKey":"url","typeLabel":"string"},"shortCode":{"type":"string","description":"Path segment of the short link.","example":"spring-sale","uniqueKey":"shortCode","typeLabel":"string"},"title":{"oneOf":[{"type":"string","example":"Spring campaign","uniqueKey":"title.oneOf.0","typeLabel":"string"},{"type":"null","example":"Spring campaign","uniqueKey":"title.oneOf.1","typeLabel":"null"}],"uniqueKey":"title","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"utmSource":{"oneOf":[{"type":"string","example":"newsletter","uniqueKey":"utmSource.oneOf.0","typeLabel":"string"},{"type":"null","example":"newsletter","uniqueKey":"utmSource.oneOf.1","typeLabel":"null"}],"uniqueKey":"utmSource","typeLabel":"string | null"},"utmMedium":{"oneOf":[{"type":"string","example":"email","uniqueKey":"utmMedium.oneOf.0","typeLabel":"string"},{"type":"null","example":"email","uniqueKey":"utmMedium.oneOf.1","typeLabel":"null"}],"uniqueKey":"utmMedium","typeLabel":"string | null"},"utmCampaign":{"oneOf":[{"type":"string","example":"spring-2026","uniqueKey":"utmCampaign.oneOf.0","typeLabel":"string"},{"type":"null","example":"spring-2026","uniqueKey":"utmCampaign.oneOf.1","typeLabel":"null"}],"uniqueKey":"utmCampaign","typeLabel":"string | null"},"utmTerm":{"oneOf":[{"type":"string","uniqueKey":"utmTerm.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"utmTerm.oneOf.1","typeLabel":"null"}],"uniqueKey":"utmTerm","typeLabel":"string | null"},"utmContent":{"oneOf":[{"type":"string","uniqueKey":"utmContent.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"utmContent.oneOf.1","typeLabel":"null"}],"uniqueKey":"utmContent","typeLabel":"string | null"},"customUtmParams":{"oneOf":[{"type":"object","description":"Workspace-defined UTM parameters, keyed by parameter code.","additionalProperties":{"type":"string","uniqueKey":"customUtmParams.oneOf.0.additionalProperties","typeLabel":"string"},"uniqueKey":"customUtmParams.oneOf.0","typeLabel":"object"},{"type":"null","description":"Workspace-defined UTM parameters, keyed by parameter code.","additionalProperties":{"type":"string","uniqueKey":"customUtmParams.oneOf.1.additionalProperties","typeLabel":"string"},"uniqueKey":"customUtmParams.oneOf.1","typeLabel":"null"}],"uniqueKey":"customUtmParams","typeLabel":"object | null"},"hasPassword":{"type":"boolean","description":"`true` when a password gate is set on the link.","uniqueKey":"hasPassword","typeLabel":"boolean"},"expiresAt":{"oneOf":[{"type":"string","description":"After this instant the link stops redirecting.","format":"date-time","uniqueKey":"expiresAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"After this instant the link stops redirecting.","format":"date-time","uniqueKey":"expiresAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"expiresAt","typeLabel":"string\u003cdate-time> | null"},"scheduledAt":{"oneOf":[{"type":"string","description":"Before this instant the link does not redirect yet.","format":"date-time","uniqueKey":"scheduledAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Before this instant the link does not redirect yet.","format":"date-time","uniqueKey":"scheduledAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"scheduledAt","typeLabel":"string\u003cdate-time> | null"},"schedulingTimezone":{"oneOf":[{"type":"string","example":"Asia/Kolkata","uniqueKey":"schedulingTimezone.oneOf.0","typeLabel":"string"},{"type":"null","example":"Asia/Kolkata","uniqueKey":"schedulingTimezone.oneOf.1","typeLabel":"null"}],"uniqueKey":"schedulingTimezone","typeLabel":"string | null"},"fallbackUrl":{"oneOf":[{"type":"string","description":"Used when the link is expired, not yet live, or click-limited.","uniqueKey":"fallbackUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"Used when the link is expired, not yet live, or click-limited.","uniqueKey":"fallbackUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"fallbackUrl","typeLabel":"string | null"},"clickLimit":{"oneOf":[{"type":"integer","example":1000,"uniqueKey":"clickLimit.oneOf.0","typeLabel":"integer"},{"type":"null","example":1000,"uniqueKey":"clickLimit.oneOf.1","typeLabel":"null"}],"uniqueKey":"clickLimit","typeLabel":"integer | null"},"clicks":{"type":"integer","example":42,"uniqueKey":"clicks","typeLabel":"integer"},"lastClickAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"lastClickAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"lastClickAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"lastClickAt","typeLabel":"string\u003cdate-time> | null"},"iosUrl":{"oneOf":[{"type":"string","description":"Deep link opened for iOS visitors.","uniqueKey":"iosUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"Deep link opened for iOS visitors.","uniqueKey":"iosUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"iosUrl","typeLabel":"string | null"},"androidUrl":{"oneOf":[{"type":"string","description":"Deep link opened for Android visitors.","uniqueKey":"androidUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"Deep link opened for Android visitors.","uniqueKey":"androidUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"androidUrl","typeLabel":"string | null"},"geoTargets":{"oneOf":[{"type":"object","description":"ISO 3166-1 alpha-2 country code to destination URL.","additionalProperties":{"type":"string","uniqueKey":"geoTargets.oneOf.0.additionalProperties","typeLabel":"string"},"example":{"US":"https://acme.com/us","IN":"https://acme.com/in"},"uniqueKey":"geoTargets.oneOf.0","typeLabel":"object"},{"type":"null","description":"ISO 3166-1 alpha-2 country code to destination URL.","additionalProperties":{"type":"string","uniqueKey":"geoTargets.oneOf.1.additionalProperties","typeLabel":"string"},"example":{"US":"https://acme.com/us","IN":"https://acme.com/in"},"uniqueKey":"geoTargets.oneOf.1","typeLabel":"null"}],"uniqueKey":"geoTargets","typeLabel":"object | null"},"geoTargetingEnabled":{"type":"boolean","uniqueKey":"geoTargetingEnabled","typeLabel":"boolean"},"ogTitle":{"oneOf":[{"type":"string","uniqueKey":"ogTitle.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"ogTitle.oneOf.1","typeLabel":"null"}],"uniqueKey":"ogTitle","typeLabel":"string | null"},"ogDescription":{"oneOf":[{"type":"string","uniqueKey":"ogDescription.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"ogDescription.oneOf.1","typeLabel":"null"}],"uniqueKey":"ogDescription","typeLabel":"string | null"},"ogImage":{"oneOf":[{"type":"string","description":"S3 key or absolute URL of the preview image.","uniqueKey":"ogImage.oneOf.0","typeLabel":"string"},{"type":"null","description":"S3 key or absolute URL of the preview image.","uniqueKey":"ogImage.oneOf.1","typeLabel":"null"}],"uniqueKey":"ogImage","typeLabel":"string | null"},"favicon":{"oneOf":[{"type":"string","uniqueKey":"favicon.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"favicon.oneOf.1","typeLabel":"null"}],"uniqueKey":"favicon","typeLabel":"string | null"},"comments":{"oneOf":[{"type":"string","description":"Internal note. Never shown to visitors.","uniqueKey":"comments.oneOf.0","typeLabel":"string"},{"type":"null","description":"Internal note. Never shown to visitors.","uniqueKey":"comments.oneOf.1","typeLabel":"null"}],"uniqueKey":"comments","typeLabel":"string | null"},"qrCodeEnabled":{"type":"boolean","uniqueKey":"qrCodeEnabled","typeLabel":"boolean"},"qrFgColor":{"oneOf":[{"type":"string","example":"#000000","uniqueKey":"qrFgColor.oneOf.0","typeLabel":"string"},{"type":"null","example":"#000000","uniqueKey":"qrFgColor.oneOf.1","typeLabel":"null"}],"uniqueKey":"qrFgColor","typeLabel":"string | null"},"qrBgColor":{"oneOf":[{"type":"string","example":"#ffffff","uniqueKey":"qrBgColor.oneOf.0","typeLabel":"string"},{"type":"null","example":"#ffffff","uniqueKey":"qrBgColor.oneOf.1","typeLabel":"null"}],"uniqueKey":"qrBgColor","typeLabel":"string | null"},"qrSize":{"oneOf":[{"type":"integer","example":512,"uniqueKey":"qrSize.oneOf.0","typeLabel":"integer"},{"type":"null","example":512,"uniqueKey":"qrSize.oneOf.1","typeLabel":"null"}],"uniqueKey":"qrSize","typeLabel":"integer | null"},"qrDesign":{"oneOf":[{"type":"object","additionalProperties":true,"uniqueKey":"qrDesign.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"uniqueKey":"qrDesign.oneOf.1","typeLabel":"null"}],"uniqueKey":"qrDesign","typeLabel":"object | null"},"cloakingEnabled":{"type":"boolean","description":"Serve the destination inside a frame instead of redirecting.","uniqueKey":"cloakingEnabled","typeLabel":"boolean"},"archived":{"type":"boolean","uniqueKey":"archived","typeLabel":"boolean"},"isActive":{"type":"boolean","uniqueKey":"isActive","typeLabel":"boolean"},"deletedAt":{"oneOf":[{"type":"string","description":"Set by `DELETE /links/{id}`. Deleted links are never returned by list endpoints.","format":"date-time","uniqueKey":"deletedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Set by `DELETE /links/{id}`. Deleted links are never returned by list endpoints.","format":"date-time","uniqueKey":"deletedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"deletedAt","typeLabel":"string\u003cdate-time> | null"},"safetyStatus":{"type":"string","description":"Result of the destination safety scan.","example":"safe","uniqueKey":"safetyStatus","typeLabel":"string"},"safetyCheckedAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"safetyCheckedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"safetyCheckedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"safetyCheckedAt","typeLabel":"string\u003cdate-time> | null"},"safetyReason":{"oneOf":[{"type":"string","uniqueKey":"safetyReason.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"safetyReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"safetyReason","typeLabel":"string | null"},"folderId":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"folderId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"folderId.oneOf.1","typeLabel":"null"}],"uniqueKey":"folderId","typeLabel":"string\u003cuuid> | null"},"domainId":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"domainId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"domainId.oneOf.1","typeLabel":"null"}],"uniqueKey":"domainId","typeLabel":"string\u003cuuid> | null"},"templateId":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"templateId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"templateId.oneOf.1","typeLabel":"null"}],"uniqueKey":"templateId","typeLabel":"string\u003cuuid> | null"},"workspaceId":{"type":"string","format":"uuid","uniqueKey":"workspaceId","typeLabel":"string\u003cuuid>"},"createdById":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"createdById.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"createdById.oneOf.1","typeLabel":"null"}],"uniqueKey":"createdById","typeLabel":"string\u003cuuid> | null"},"updatedById":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"updatedById.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"updatedById.oneOf.1","typeLabel":"null"}],"uniqueKey":"updatedById","typeLabel":"string\u003cuuid> | null"},"createdAt":{"type":"string","format":"date-time","uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"},"tags":{"type":"array","items":{"type":"object","description":"Join row between a link and a tag.","properties":{"id":{"type":"string","description":"ID of the join row, not of the tag.","uniqueKey":"tags.items.[INDEX].id","typeLabel":"string"},"tag":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"tags.items.[INDEX].tag.id","typeLabel":"string"},"name":{"type":"string","example":"paid-social","uniqueKey":"tags.items.[INDEX].tag.name","typeLabel":"string"},"color":{"type":"string","example":"#f97316","uniqueKey":"tags.items.[INDEX].tag.color","typeLabel":"string"}},"uniqueKey":"tags.items.[INDEX].tag","typeLabel":"object"}},"uniqueKey":"tags.items.[INDEX]","typeLabel":"object"},"uniqueKey":"tags","typeLabel":"object[]"},"pixels":{"type":"array","items":{"type":"object","properties":{"pixelId":{"type":"string","uniqueKey":"pixels.items.[INDEX].pixelId","typeLabel":"string"}},"uniqueKey":"pixels.items.[INDEX]","typeLabel":"object"},"uniqueKey":"pixels","typeLabel":"object[]"},"domain":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","uniqueKey":"domain.oneOf.0.id","typeLabel":"string"},"domain":{"type":"string","example":"go.acme.com","uniqueKey":"domain.oneOf.0.domain","typeLabel":"string"},"verified":{"type":"boolean","uniqueKey":"domain.oneOf.0.verified","typeLabel":"boolean"}},"uniqueKey":"domain.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"id":{"type":"string"},"domain":{"type":"string","example":"go.acme.com"},"verified":{"type":"boolean"}},"uniqueKey":"domain.oneOf.1","typeLabel":"null"}],"uniqueKey":"domain","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","url":"https://acme.com/pricing","shortCode":"spring-sale","title":"Spring campaign","description":"\u003cstring>","utmSource":"newsletter","utmMedium":"email","utmCampaign":"spring-2026","utmTerm":"\u003cstring>","utmContent":"\u003cstring>","customUtmParams":{},"hasPassword":true,"expiresAt":"2023-11-07T05:31:56Z","scheduledAt":"2023-11-07T05:31:56Z","schedulingTimezone":"Asia/Kolkata","fallbackUrl":"\u003cstring>","clickLimit":1000,"clicks":42,"lastClickAt":"2023-11-07T05:31:56Z","iosUrl":"\u003cstring>","androidUrl":"\u003cstring>","geoTargets":{"US":"https://acme.com/us","IN":"https://acme.com/in"},"geoTargetingEnabled":true,"ogTitle":"\u003cstring>","ogDescription":"\u003cstring>","ogImage":"\u003cstring>","favicon":"\u003cstring>","comments":"\u003cstring>","qrCodeEnabled":true,"qrFgColor":"#000000","qrBgColor":"#ffffff","qrSize":512,"qrDesign":{},"cloakingEnabled":true,"archived":true,"isActive":true,"deletedAt":"2023-11-07T05:31:56Z","safetyStatus":"safe","safetyCheckedAt":"2023-11-07T05:31:56Z","safetyReason":"\u003cstring>","folderId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","domainId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","templateId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","workspaceId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","createdById":"3c90c3cc-0d44-4b50-8888-8dd25736052a","updatedById":"3c90c3cc-0d44-4b50-8888-8dd25736052a","createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z","tags":[{"id":"\u003cstring>","tag":{"id":"\u003cstring>","name":"paid-social","color":"#f97316"}}],"pixels":[{"pixelId":"\u003cstring>"}],"domain":{"id":"\u003cstring>","domain":"go.acme.com","verified":true}}}},"exampleType":"generated"}},"exampleType":"generated"},"c59e7b1a-b579-43ac-9d84-4c2da4b46afb":{"description":"The link ID in the path is missing, blank, or is not a valid UUID, or the request body failed validation.","content":{"application/json":{"schema":{"type":"object","description":"Standard NestJS error envelope. `message` is a string for exceptions thrown by a service, and an array of strings when the global ValidationPipe rejects the body.","properties":{"statusCode":{"type":"integer","example":400,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"integer"},"message":{"oneOf":[{"type":"string","description":"Human-readable reason, or a list of field-level validation errors.","example":"Link not found","isRequired":true,"uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"message.oneOf.1.items.[INDEX]","typeLabel":"string"},"description":"Human-readable reason, or a list of field-level validation errors.","example":"Link not found","isRequired":true,"uniqueKey":"message.oneOf.1","typeLabel":"string[]"}],"isRequired":true,"uniqueKey":"message","typeLabel":"string | string[]"},"error":{"type":"string","example":"Bad Request","uniqueKey":"error","typeLabel":"string"}},"required":["statusCode","message"],"uniqueKey":"","typeLabel":"object"},"example":{"statusCode":400,"message":"Link ID must be a valid UUID","error":"Bad Request"},"examples":{"Example":{"title":"Example","value":{"statusCode":400,"message":"Link ID must be a valid UUID","error":"Bad Request"}}},"exampleType":"examples"}},"exampleType":"examples"},"09a9970d-0034-4b01-a090-84a7ad39dbec":{"description":"Missing, malformed, expired or revoked credentials.","content":{"application/json":{"schema":{"type":"object","description":"Standard NestJS error envelope. `message` is a string for exceptions thrown by a service, and an array of strings when the global ValidationPipe rejects the body.","properties":{"statusCode":{"type":"integer","example":400,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"integer"},"message":{"oneOf":[{"type":"string","description":"Human-readable reason, or a list of field-level validation errors.","example":"Link not found","isRequired":true,"uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"message.oneOf.1.items.[INDEX]","typeLabel":"string"},"description":"Human-readable reason, or a list of field-level validation errors.","example":"Link not found","isRequired":true,"uniqueKey":"message.oneOf.1","typeLabel":"string[]"}],"isRequired":true,"uniqueKey":"message","typeLabel":"string | string[]"},"error":{"type":"string","example":"Bad Request","uniqueKey":"error","typeLabel":"string"}},"required":["statusCode","message"],"uniqueKey":"","typeLabel":"object"},"example":{"statusCode":401,"message":"Invalid or expired API key","error":"Unauthorized"},"examples":{"Example":{"title":"Example","value":{"statusCode":401,"message":"Invalid or expired API key","error":"Unauthorized"}}},"exampleType":"examples"}},"exampleType":"examples"},"9809fb68-0566-4bf5-9c38-a96148dfeaf8":{"description":"Authenticated, but the role, plan or workspace membership does not allow this call.","content":{"application/json":{"schema":{"type":"object","description":"Standard NestJS error envelope. `message` is a string for exceptions thrown by a service, and an array of strings when the global ValidationPipe rejects the body.","properties":{"statusCode":{"type":"integer","example":400,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"integer"},"message":{"oneOf":[{"type":"string","description":"Human-readable reason, or a list of field-level validation errors.","example":"Link not found","isRequired":true,"uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"message.oneOf.1.items.[INDEX]","typeLabel":"string"},"description":"Human-readable reason, or a list of field-level validation errors.","example":"Link not found","isRequired":true,"uniqueKey":"message.oneOf.1","typeLabel":"string[]"}],"isRequired":true,"uniqueKey":"message","typeLabel":"string | string[]"},"error":{"type":"string","example":"Bad Request","uniqueKey":"error","typeLabel":"string"}},"required":["statusCode","message"],"uniqueKey":"","typeLabel":"object"},"example":{"statusCode":403,"message":"Please upgrade your plan to create more links.","error":"Forbidden"},"examples":{"Example":{"title":"Example","value":{"statusCode":403,"message":"Please upgrade your plan to create more links.","error":"Forbidden"}}},"exampleType":"examples"}},"exampleType":"examples"},"2a3f371d-3cdc-482f-9808-a43215e0b029":{"description":"The resource does not exist, or belongs to another workspace.","content":{"application/json":{"schema":{"type":"object","description":"Standard NestJS error envelope. `message` is a string for exceptions thrown by a service, and an array of strings when the global ValidationPipe rejects the body.","properties":{"statusCode":{"type":"integer","example":400,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"integer"},"message":{"oneOf":[{"type":"string","description":"Human-readable reason, or a list of field-level validation errors.","example":"Link not found","isRequired":true,"uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"message.oneOf.1.items.[INDEX]","typeLabel":"string"},"description":"Human-readable reason, or a list of field-level validation errors.","example":"Link not found","isRequired":true,"uniqueKey":"message.oneOf.1","typeLabel":"string[]"}],"isRequired":true,"uniqueKey":"message","typeLabel":"string | string[]"},"error":{"type":"string","example":"Bad Request","uniqueKey":"error","typeLabel":"string"}},"required":["statusCode","message"],"uniqueKey":"","typeLabel":"object"},"example":{"statusCode":404,"message":"Link not found","error":"Not Found"},"examples":{"Example":{"title":"Example","value":{"statusCode":404,"message":"Link not found","error":"Not Found"}}},"exampleType":"examples"}},"exampleType":"examples"},"299c2559-4298-412d-888d-22d382414ec0":{"description":"Conflicts with a resource that already exists.","content":{"application/json":{"schema":{"type":"object","description":"Standard NestJS error envelope. `message` is a string for exceptions thrown by a service, and an array of strings when the global ValidationPipe rejects the body.","properties":{"statusCode":{"type":"integer","example":400,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"integer"},"message":{"oneOf":[{"type":"string","description":"Human-readable reason, or a list of field-level validation errors.","example":"Link not found","isRequired":true,"uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"message.oneOf.1.items.[INDEX]","typeLabel":"string"},"description":"Human-readable reason, or a list of field-level validation errors.","example":"Link not found","isRequired":true,"uniqueKey":"message.oneOf.1","typeLabel":"string[]"}],"isRequired":true,"uniqueKey":"message","typeLabel":"string | string[]"},"error":{"type":"string","example":"Bad Request","uniqueKey":"error","typeLabel":"string"}},"required":["statusCode","message"],"uniqueKey":"","typeLabel":"object"},"example":{"statusCode":409,"message":"Short code already exists","error":"Conflict"},"examples":{"Example":{"title":"Example","value":{"statusCode":409,"message":"Short code already exists","error":"Conflict"}}},"exampleType":"examples"}},"exampleType":"examples"},"7f1d3d19-335b-4a50-a31b-248e5f26b6c3":{"description":"Unexpected server error. Safe to retry with backoff.","content":{"application/json":{"schema":{"type":"object","description":"Standard NestJS error envelope. `message` is a string for exceptions thrown by a service, and an array of strings when the global ValidationPipe rejects the body.","properties":{"statusCode":{"type":"integer","example":400,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"integer"},"message":{"oneOf":[{"type":"string","description":"Human-readable reason, or a list of field-level validation errors.","example":"Link not found","isRequired":true,"uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"message.oneOf.1.items.[INDEX]","typeLabel":"string"},"description":"Human-readable reason, or a list of field-level validation errors.","example":"Link not found","isRequired":true,"uniqueKey":"message.oneOf.1","typeLabel":"string[]"}],"isRequired":true,"uniqueKey":"message","typeLabel":"string | string[]"},"error":{"type":"string","example":"Bad Request","uniqueKey":"error","typeLabel":"string"}},"required":["statusCode","message"],"uniqueKey":"","typeLabel":"object"},"example":{"statusCode":500,"message":"Internal server error"},"examples":{"Example":{"title":"Example","value":{"statusCode":500,"message":"Internal server error"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"4507dab4-7aee-4d72-b560-04992f6b9435":{"ApiKeyAuth":{"type":"http","scheme":"bearer","description":"Workspace API key, sent as `Authorization: Bearer lk_live_…`.","scopes":[]}},"48d713e5-206e-44b3-902f-aef17052ddd6":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Dashboard session token from `POST /auth/login`.","scopes":[]}}},"servers":{"42407d43-bba1-4aa5-8fc3-db9fec6cb642":{"url":"https://api.linkutm.com/api/v1","description":"Local development"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Workspace API key, sent as `Authorization: Bearer lk_live_…`.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Workspace API key, sent as `Authorization: Bearer lk_live_…`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"ApiKeyAuth","name":"Authorization"}],"title":"ApiKeyAuth"},{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Dashboard session token from `POST /auth/login`.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Dashboard session token from `POST /auth/login`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"utm-e577acb5","siteName":"linkutm","title":"Update a link - linkutm","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-05T06:26:57.609Z","originalFileLocation":"api/links/update.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Update a link. Omitted fields are left unchanged.\">\u003cmeta data-mint-head name=\"application-name\" content=\"linkutm\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/utm-e577acb5/kgnP0ydCmdJcHumw/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/utm-e577acb5/kgnP0ydCmdJcHumw/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/utm-e577acb5/kgnP0ydCmdJcHumw/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/utm-e577acb5/kgnP0ydCmdJcHumw/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/utm-e577acb5/kgnP0ydCmdJcHumw/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/utm-e577acb5/kgnP0ydCmdJcHumw/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/utm-e577acb5/kgnP0ydCmdJcHumw/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/utm-e577acb5/kgnP0ydCmdJcHumw/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/utm-e577acb5/kgnP0ydCmdJcHumw/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update a link - linkutm\">\u003cmeta data-mint-head property=\"og:description\" content=\"Update a link. Omitted fields are left unchanged.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"linkutm\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.linkutm.com/api/links/update\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://utm-e577acb5.mintlify.site/_mintlify/api/og/v2?division=Links\u0026amp;title=Update+a+link\u0026amp;description=Update+a+link.+Omitted+fields+are+left+unchanged.\u0026amp;theme=765c4f27fee85dd05cdf6c69\u0026amp;signature=c78457d9d4e9833a6393dbb014ce8c6ea3858ffa567f441985bace87ee38c2d0\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Update a link - linkutm\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Update a link. Omitted fields are left unchanged.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://utm-e577acb5.mintlify.site/_mintlify/api/og/v2?division=Links\u0026amp;title=Update+a+link\u0026amp;description=Update+a+link.+Omitted+fields+are+left+unchanged.\u0026amp;theme=765c4f27fee85dd05cdf6c69\u0026amp;signature=c78457d9d4e9833a6393dbb014ce8c6ea3858ffa567f441985bace87ee38c2d0\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/utm-e577acb5/kgnP0ydCmdJcHumw/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"linkutm\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#ff6200\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.linkutm.com/api/links/update\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api/links/update.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.linkutm.com/#organization\",\"name\":\"linkutm\",\"url\":\"https://docs.linkutm.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/utm-e577acb5/3C2acBV9fWv9F5zu/logo/light.svg?fit=max\u0026auto=format\u0026n=3C2acBV9fWv9F5zu\u0026q=85\u0026s=1a0ed464d45ea6d3c2e41d0c7e5ffe1f\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.linkutm.com#website\",\"name\":\"linkutm\",\"url\":\"https://docs.linkutm.com\",\"publisher\":{\"@id\":\"https://docs.linkutm.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.linkutm.com/api/links/update#webpage\",\"url\":\"https://docs.linkutm.com/api/links/update\",\"name\":\"Update a link\",\"description\":\"Update a link. Omitted fields are left unchanged.\",\"dateModified\":\"2026-10-05T06:26:57.609Z\",\"isPartOf\":{\"@id\":\"https://docs.linkutm.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.linkutm.com/api/links/update#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.linkutm.com/api/links/update#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Linkutm Links API\",\"item\":\"https://docs.linkutm.com/api/links/create\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Links\",\"item\":\"https://docs.linkutm.com/api/links/create\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Update a link\",\"item\":\"https://docs.linkutm.com/api/links/update\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.linkutm.com/api/links/update#apireference\",\"headline\":\"Update a link\",\"name\":\"Update a link\",\"description\":\"Update a link. Omitted fields are left unchanged.\",\"url\":\"https://docs.linkutm.com/api/links/update\",\"mainEntityOfPage\":{\"@id\":\"https://docs.linkutm.com/api/links/update#webpage\"},\"dateModified\":\"2026-10-05T06:26:57.609Z\",\"publisher\":{\"@id\":\"https://docs.linkutm.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.linkutm.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"linkutm\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"linkutm","nav":{"global":{"anchors":[{"anchor":"Changelog","icon":"clock","href":"/changelog"}]},"tabs":[{"tab":"Links","pages":[{"title":"Links","href":"/getting-started/introduction"}]},{"tab":"Playbooks","pages":[{"title":"Playbooks","href":"/playbooks/utm-naming-convention"}]},{"tab":"Help","pages":[{"title":"Help","href":"/help/common-issues"}]},{"tab":"API Reference","groups":[{"group":"Getting started","pages":[{"title":"Introduction","href":"/api/introduction"},{"title":"Roles and permissions","href":"/api/roles"},{"title":"Errors","href":"/api/errors"},{"title":"Best practices","href":"/api/best-practices"}]},{"group":"Linkutm Links API","pages":[{"group":"Links","expanded":false,"pages":[{"title":"Create a link","openapi":"POST /links","href":"/api/links/create"},{"title":"List links","openapi":"GET /links","href":"/api/links/list"},{"title":"Retrieve a link","openapi":"GET /links/{id}","description":"Retrieve a link by ID.","href":"/api/links/get"},{"title":"Update a link","openapi":"PATCH /links/{id}","href":"/api/links/update"},{"title":"Delete a link","openapi":"DELETE /links/{id}","description":"Delete a link. It stops redirecting immediately but keeps its short code and click history.","href":"/api/links/delete"}]},{"group":"Domains","expanded":false,"pages":[{"title":"Create a domain","openapi":"POST /domains","href":"/api/domains/create"},{"title":"List domains","openapi":"GET /domains","href":"/api/domains/list"},{"title":"Verify a domain","openapi":"POST /domains/{id}/verify","href":"/api/domains/verify"},{"title":"Delete a domain","openapi":"DELETE /domains/{id}","href":"/api/domains/delete"},{"title":"Set the default domain","openapi":"POST /domains/{id}/set-default","href":"/api/domains/set-default"}]},{"group":"Folders","expanded":false,"pages":[{"title":"Create a folder","openapi":"POST /folders","href":"/api/folders/create"},{"title":"List folders","openapi":"GET /folders","href":"/api/folders/list"},{"title":"Update a folder","openapi":"PATCH /folders/{id}","href":"/api/folders/update"},{"title":"Delete a folder","openapi":"DELETE /folders/{id}","href":"/api/folders/delete"},{"title":"Set the default folder","openapi":"POST /folders/set-default","href":"/api/folders/set-default"}]},{"group":"Tags","expanded":false,"pages":[{"title":"Create a tag","openapi":"POST /tags","href":"/api/tags/create"},{"title":"List tags","openapi":"GET /tags","href":"/api/tags/list"},{"title":"Update a tag","openapi":"PATCH /tags/{id}","href":"/api/tags/update"},{"title":"Delete a tag","openapi":"DELETE /tags/{id}","href":"/api/tags/delete"}]},{"group":"Analytics","expanded":false,"pages":[{"title":"Workspace analytics","openapi":"GET /analytics","href":"/api/analytics/workspace"},{"title":"Link analytics","openapi":"GET /links/{linkId}/analytics","href":"/api/analytics/link"}]}]}]}]},"basePath":"","title":"Update a link - linkutm","buildId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","deploymentId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-i2a3QZ8E.js","utils-ChLwp8m0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DRktVTDc.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CA2pEs4T.js","snippetPresets-ClQ6XrKD.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Ct_Lv36y.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Cn2PYw9e.js","shallow-rkyymjXQ.js","getApiPlaygroundDisplay-BB9vkXtE.js","CodeSnippet-Bm5RU7m1.js","CodeSnippets-BgU9Deuz.js","Page-BUDYNlhG.js","getPastedJson-BD-6NNum.js","icon-8Z6tud2e.js","MethodPill-Tuzr4g3V.js","DuplicateIcon-0ceWFYhN.js","createIcon-FBXow_ST.js","DynamicMarkdown-CD8713Yy.js","SectionHeading-7zgzQbH-.js","axios-vUo_bRtp.js","Markdown-D7Ofw1oz.js","clsx-eKJ4rcii.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CwjSCXIK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-9EK5IAXV.js"]}