{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Bitsy Documentation","colors":{"primary":"#6F94CD","light":"#6F94CD","dark":"#6F94CD"},"favicon":"/favicon.png","logo":{"light":"https://mintcdn.com/bitsy/9K8FdriBrgvMAmLv/logo/bitsy_logo.png?fit=max\u0026auto=format\u0026n=9K8FdriBrgvMAmLv\u0026q=85\u0026s=7df7d878082ad64fbd4209e320b40b67","dark":"https://mintcdn.com/bitsy/9K8FdriBrgvMAmLv/logo/bitsy_logo.png?fit=max\u0026auto=format\u0026n=9K8FdriBrgvMAmLv\u0026q=85\u0026s=7df7d878082ad64fbd4209e320b40b67"},"api":{"openapi":"api-reference/openapi.json","playground":{"display":"interactive","proxy":false},"mdx":{"server":"https://api.bsy.sh/v1/","auth":{"method":"bearer","name":null}}},"appearance":{"default":"dark","strict":null},"navbar":{"links":[{"label":"Support","href":"mailto:[email protected]"},{"label":"Sign In","href":"https://bsy.sh/signin"}],"primary":{"type":"button","label":"Dashboard","href":"https://bsy.sh/admin/dashboard"}},"seo":{"indexing":"all"},"footer":{"socials":{"website":"https://bsy.sh/b/bitsy"}},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"bitsy","hasAudioNarration":false,"actualSubdomain":"bitsy","customDomains":["docs.bsy.sh"],"gitSource":{"type":"github","owner":"bitsy-bsy","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21e6554c43fec466d79881","collectionId":"bf7dfff2-b4e8-4908-b699-647a57ad18da","schemaVersion":"v2"},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{},"buildId":"6a21e6554c43fec466d79881:success","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"Documentation","count":10},{"language":"default","tag":"API Reference","count":9},{"language":"default","tag":"Bitsy Link Essentials","count":7},{"language":"default","tag":"Bitsy Link","count":6},{"language":"default","tag":"API Documentation","count":3},{"language":"default","tag":"Extensibility","count":1},{"language":"default","tag":"Get Started","count":1},{"language":"default","tag":"Video Tutorials","count":1}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/bitsy-link/create-link","slug":"/api-reference/bitsy-link/create-link","pageMetadata":{"title":"Create Bitsy Link","openapi":"POST /link/create","description":"Create a new Bitsy Link","href":"/api-reference/bitsy-link/create-link"},"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: \"Create a new Bitsy Link\"\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":"Create Bitsy Link","openapi":"POST /link/create","description":"Create a new Bitsy Link","href":"/api-reference/bitsy-link/create-link"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Create a new Bitsy Link","requestBody":"56b830a5-0dc3-4729-a56e-e2e3cde6eba4","responses":{"201":"8a653eb9-0472-4c71-84dc-11a5ba33836c","400":"31714cd5-9f59-4247-b64b-f7a01b1fa37c","401":"f40550ec-90dc-4df1-b7bd-d82412aed288","403":"9651267d-e0b2-4500-89bd-565e4ba1800b","422":"40cf6057-c678-4d64-a621-972ae06206f7","500":"b09c9e1e-d265-429d-bbbc-e0f51f6d83c1"},"method":"post","type":"path","servers":["d323a5b0-56e3-4738-b7eb-81e14653b668"],"security":["bb5b9219-4d3f-4165-adc4-fc162a0cbe7e"],"path":"/link/create","baseUrlOptions":["https://api.bsy.sh/v1"],"title":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","disableProxy":true},"dependencies":{"parameters":{},"requestBody":{"description":"Create a new Bitsy Link","content":{"application/json":{"schema":{"type":"object","required":["long_url"],"properties":{"long_url":{"type":"string","format":"uri","description":"The long URL that the shortened link will redirect to.","isRequired":true,"uniqueKey":"long_url","typeLabel":"string\u003curi>"},"domain":{"type":"string","format":"uuid","description":"The UUID of the domain where the link will be created.","uniqueKey":"domain","typeLabel":"string\u003cuuid>"},"favicon":{"type":"string","description":"URL of the favicon for the link.","uniqueKey":"favicon","typeLabel":"string"},"title":{"type":"string","maxLength":150,"description":"Title of the link, up to 150 characters.","uniqueKey":"title","typeLabel":"string"},"custom_link":{"type":"string","minLength":3,"maxLength":50,"description":"Custom slug for the link, between 3 and 50 characters.","uniqueKey":"custom_link","typeLabel":"string"},"tags":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"tags.items.[INDEX]","typeLabel":"string"},"description":"Array of tags associated with the link.","uniqueKey":"tags","typeLabel":"string[]"},"has_utm":{"type":"boolean","description":"Indicates if UTM parameters are used.","uniqueKey":"has_utm","typeLabel":"boolean"},"utm_source":{"type":"string","maxLength":200,"description":"UTM source for tracking.","uniqueKey":"utm_source","typeLabel":"string"},"utm_medium":{"type":"string","maxLength":200,"description":"UTM medium for tracking.","uniqueKey":"utm_medium","typeLabel":"string"},"utm_campaign":{"type":"string","maxLength":200,"description":"UTM campaign for tracking.","uniqueKey":"utm_campaign","typeLabel":"string"},"utm_term":{"type":"string","maxLength":200,"description":"UTM term for paid search.","uniqueKey":"utm_term","typeLabel":"string"},"utm_content":{"type":"string","maxLength":200,"description":"UTM content for differentiating ads.","uniqueKey":"utm_content","typeLabel":"string"},"has_opengraph":{"type":"boolean","description":"Indicates if OpenGraph metadata is included.","uniqueKey":"has_opengraph","typeLabel":"boolean"},"meta_title":{"type":"string","maxLength":150,"description":"Meta title for the link, up to 150 characters.","uniqueKey":"meta_title","typeLabel":"string"},"meta_description":{"type":"string","maxLength":250,"description":"Meta description for the link, up to 250 characters.","uniqueKey":"meta_description","typeLabel":"string"},"meta_image":{"type":"string","description":"URL of the image to use for the link's metadata.","uniqueKey":"meta_image","typeLabel":"string"},"has_android_targeting":{"type":"boolean","description":"Indicates if there is a target URL for Android.","uniqueKey":"has_android_targeting","typeLabel":"boolean"},"android_target_url":{"type":"string","description":"Target URL for Android devices.","uniqueKey":"android_target_url","typeLabel":"string"},"has_ios_targeting":{"type":"boolean","description":"Indicates if there is a target URL for iOS.","uniqueKey":"has_ios_targeting","typeLabel":"boolean"},"ios_target_url":{"type":"string","description":"Target URL for iOS devices.","uniqueKey":"ios_target_url","typeLabel":"string"},"has_windows_targeting":{"type":"boolean","description":"Indicates if there is a target URL for Windows.","uniqueKey":"has_windows_targeting","typeLabel":"boolean"},"windows_target_url":{"type":"string","description":"Target URL for Windows devices.","uniqueKey":"windows_target_url","typeLabel":"string"},"has_linux_targeting":{"type":"boolean","description":"Indicates if there is a target URL for Linux.","uniqueKey":"has_linux_targeting","typeLabel":"boolean"},"linux_target_url":{"type":"string","description":"Target URL for Linux devices.","uniqueKey":"linux_target_url","typeLabel":"string"},"has_geo_targeting":{"type":"boolean","description":"Indicates if geo-targeting is used.","uniqueKey":"has_geo_targeting","typeLabel":"boolean"},"geo_targets":{"type":"array","items":{"type":"object","properties":{"country_id":{"type":"string","description":"Two-letter country code (ISO 3166-1 alpha-2).","enum":["AD","AE","AF","AG","AI","AL","AM","AO","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","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","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","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","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"isRequired":true,"uniqueKey":"geo_targets.items.[INDEX].country_id","typeLabel":"enum\u003cstring>"},"target_url":{"type":"string","format":"uri","description":"Target URL for the specified country.","isRequired":true,"uniqueKey":"geo_targets.items.[INDEX].target_url","typeLabel":"string\u003curi>"}},"required":["country_id","target_url"],"uniqueKey":"geo_targets.items.[INDEX]","typeLabel":"object"},"description":"Array of geo-targeting rules.","uniqueKey":"geo_targets","typeLabel":"object[]"},"has_cloaking":{"type":"boolean","description":"Indicates if cloaking is enabled.","uniqueKey":"has_cloaking","typeLabel":"boolean"},"has_password":{"type":"boolean","description":"Indicates if a password is required to access the link.","uniqueKey":"has_password","typeLabel":"boolean"},"password":{"type":"string","description":"Password required to access the link.","uniqueKey":"password","typeLabel":"string"},"password_logo":{"type":"string","description":"URL of the logo to display on the password prompt.","uniqueKey":"password_logo","typeLabel":"string"},"has_expiration":{"type":"boolean","description":"Indicates if the link has an expiration date or expiration clicks.","uniqueKey":"has_expiration","typeLabel":"boolean"},"expiration":{"type":"string","format":"date-time","description":"Expiration date for the link in ISO 8601 format.","uniqueKey":"expiration","typeLabel":"string\u003cdate-time>"},"expiration_clicks":{"type":"string","description":"Maximum number of clicks before the link expires.","uniqueKey":"expiration_clicks","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"long_url":"\u003cstring>","domain":"3c90c3cc-0d44-4b50-8888-8dd25736052a","favicon":"\u003cstring>","title":"\u003cstring>","custom_link":"\u003cstring>","tags":["\u003cstring>"],"has_utm":true,"utm_source":"\u003cstring>","utm_medium":"\u003cstring>","utm_campaign":"\u003cstring>","utm_term":"\u003cstring>","utm_content":"\u003cstring>","has_opengraph":true,"meta_title":"\u003cstring>","meta_description":"\u003cstring>","meta_image":"\u003cstring>","has_android_targeting":true,"android_target_url":"\u003cstring>","has_ios_targeting":true,"ios_target_url":"\u003cstring>","has_windows_targeting":true,"windows_target_url":"\u003cstring>","has_linux_targeting":true,"linux_target_url":"\u003cstring>","has_geo_targeting":true,"geo_targets":[{"target_url":"\u003cstring>"}],"has_cloaking":true,"has_password":true,"password":"\u003cstring>","password_logo":"\u003cstring>","has_expiration":true,"expiration":"2023-11-07T05:31:56Z","expiration_clicks":"\u003cstring>"}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"8a653eb9-0472-4c71-84dc-11a5ba33836c":{"description":"Bitsy Link success response","content":{"application/json":{"schema":{"required":["status","data"],"type":"object","properties":{"status":{"type":"string","enum":["success"],"description":"Indicates the status of the request.","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier for the created link.","uniqueKey":"data.id","typeLabel":"string\u003cuuid>"},"title":{"type":"string","description":"The title of the link.","uniqueKey":"data.title","typeLabel":"string"},"long_url":{"type":"string","format":"uri","description":"The original long URL that the shortened link points to.","uniqueKey":"data.long_url","typeLabel":"string\u003curi>"},"bitsy_url":{"type":"string","description":"The shortened URL generated for the link.","uniqueKey":"data.bitsy_url","typeLabel":"string"},"custom_url":{"type":"string","description":"A custom URL if provided; otherwise, null.","uniqueKey":"data.custom_url","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the link was created.","uniqueKey":"data.created_at","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"success","data":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","title":"\u003cstring>","long_url":"\u003cstring>","bitsy_url":"\u003cstring>","custom_url":"\u003cstring>","created_at":"2023-11-07T05:31:56Z"}}}},"exampleType":"generated"}},"exampleType":"generated"},"31714cd5-9f59-4247-b64b-f7a01b1fa37c":{"description":"Default Client Error","content":{"application/json":{"schema":{"required":["status","message"],"type":"object","properties":{"status":{"type":"string","enum":["failure"],"description":"Indicates the status of the error.","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A message providing additional details about the default error.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"failure","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"f40550ec-90dc-4df1-b7bd-d82412aed288":{"description":"Authorization Error","content":{"application/json":{"schema":{"required":["status","message"],"type":"object","properties":{"status":{"type":"string","enum":["failure"],"description":"Indicates the status of the authorization.","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A message providing additional details about the authorization error.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"failure","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"9651267d-e0b2-4500-89bd-565e4ba1800b":{"description":"Permission Error","content":{"application/json":{"schema":{"required":["status","message"],"type":"object","properties":{"status":{"type":"string","enum":["failure"],"description":"Indicates the status of the authorization.","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A message providing additional details about the authorization error.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"failure","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"40cf6057-c678-4d64-a621-972ae06206f7":{"description":"Request Validation Error","content":{"application/json":{"schema":{"required":["status","message","errors"],"type":"object","properties":{"status":{"type":"string","enum":["failure"],"description":"Indicates the status of the validation.","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A message providing additional details about the validation error.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"errors":{"type":"object","properties":{"formErrors":{"type":"array","items":{"type":"string","uniqueKey":"errors.formErrors.items.[INDEX]","typeLabel":"string"},"description":"List of form-level errors.","uniqueKey":"errors.formErrors","typeLabel":"string[]"},"fieldErrors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"errors.fieldErrors.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.fieldErrors.additionalProperties","typeLabel":"string[]"},"description":"Object containing field-specific errors, where keys are field names and values are arrays of error messages.","uniqueKey":"errors.fieldErrors","typeLabel":"object"}},"description":"Detailed error information regarding validation failures.","isRequired":true,"uniqueKey":"errors","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"failure","message":"\u003cstring>","errors":{"formErrors":["\u003cstring>"],"fieldErrors":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"b09c9e1e-d265-429d-bbbc-e0f51f6d83c1":{"description":"Server Error","content":{"application/json":{"schema":{"required":["status","message"],"type":"object","properties":{"status":{"type":"string","enum":["error"],"description":"Indicates the status of the error.","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A message providing additional details about the default error.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"error","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"bb5b9219-4d3f-4165-adc4-fc162a0cbe7e":{"bearerAuth":{"type":"http","scheme":"bearer","scopes":[]}}},"servers":{"d323a5b0-56e3-4738-b7eb-81e14653b668":{"url":"https://api.bsy.sh/v1"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"bitsy","siteName":"Bitsy Documentation","title":"Create Bitsy Link - Bitsy Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-07T03:56:30.188Z","originalFileLocation":"api-reference/bitsy-link/create-link.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=\"dark\"}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=\"Create a new Bitsy Link\">\u003cmeta data-mint-head name=\"application-name\" content=\"Bitsy Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/bitsy/9p9mzU9TX37yqIMX/_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/bitsy/9p9mzU9TX37yqIMX/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/bitsy/9p9mzU9TX37yqIMX/_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/bitsy/9p9mzU9TX37yqIMX/_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/bitsy/9p9mzU9TX37yqIMX/_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/bitsy/9p9mzU9TX37yqIMX/_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/bitsy/9p9mzU9TX37yqIMX/_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/bitsy/9p9mzU9TX37yqIMX/_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/bitsy/9p9mzU9TX37yqIMX/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create Bitsy Link - Bitsy Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a new Bitsy Link\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Bitsy Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.bsy.sh/api-reference/bitsy-link/create-link\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://bitsy.mintlify.app/_mintlify/api/og/v2?division=Bitsy+Link\u0026amp;title=Create+Bitsy+Link\u0026amp;description=Create+a+new+Bitsy+Link\u0026amp;theme=d6baa7ff9fcfb826899d9bf2\u0026amp;signature=e6afda1b4e7134a40ce6bfc43cd2ae3a203dac10d574f85f43e3657538c7694d\">\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=\"Create Bitsy Link - Bitsy Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a new Bitsy Link\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://bitsy.mintlify.app/_mintlify/api/og/v2?division=Bitsy+Link\u0026amp;title=Create+Bitsy+Link\u0026amp;description=Create+a+new+Bitsy+Link\u0026amp;theme=d6baa7ff9fcfb826899d9bf2\u0026amp;signature=e6afda1b4e7134a40ce6bfc43cd2ae3a203dac10d574f85f43e3657538c7694d\">\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/bitsy/9p9mzU9TX37yqIMX/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Bitsy Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6F94CD\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.bsy.sh/api-reference/bitsy-link/create-link\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/bitsy-link/create-link.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.bsy.sh/#organization\",\"name\":\"Bitsy Documentation\",\"url\":\"https://docs.bsy.sh\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/bitsy/9K8FdriBrgvMAmLv/logo/bitsy_logo.png?fit=max\u0026auto=format\u0026n=9K8FdriBrgvMAmLv\u0026q=85\u0026s=7df7d878082ad64fbd4209e320b40b67\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.bsy.sh#website\",\"name\":\"Bitsy Documentation\",\"url\":\"https://docs.bsy.sh\",\"publisher\":{\"@id\":\"https://docs.bsy.sh/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.bsy.sh/api-reference/bitsy-link/create-link#webpage\",\"url\":\"https://docs.bsy.sh/api-reference/bitsy-link/create-link\",\"name\":\"Create Bitsy Link\",\"description\":\"Create a new Bitsy Link\",\"dateModified\":\"2026-01-07T03:56:30.188Z\",\"isPartOf\":{\"@id\":\"https://docs.bsy.sh#website\"},\"breadcrumb\":{\"@id\":\"https://docs.bsy.sh/api-reference/bitsy-link/create-link#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.bsy.sh/api-reference/bitsy-link/create-link#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Bitsy Documentation\",\"item\":\"https://docs.bsy.sh\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create Bitsy Link\",\"item\":\"https://docs.bsy.sh/api-reference/bitsy-link/create-link\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.bsy.sh/api-reference/bitsy-link/create-link#apireference\",\"headline\":\"Create Bitsy Link\",\"name\":\"Create Bitsy Link\",\"description\":\"Create a new Bitsy Link\",\"url\":\"https://docs.bsy.sh/api-reference/bitsy-link/create-link\",\"mainEntityOfPage\":{\"@id\":\"https://docs.bsy.sh/api-reference/bitsy-link/create-link#webpage\"},\"dateModified\":\"2026-01-07T03:56:30.188Z\",\"publisher\":{\"@id\":\"https://docs.bsy.sh/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.bsy.sh#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Bitsy Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Bitsy Documentation","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","icon":"webhook","href":"/api-reference/introduction"},{"title":"API Keys","icon":"key","href":"/api-reference/api-keys"},{"title":"Errors","description":"Troubleshoot problems with this comprehensive breakdown of all error codes.","icon":"bug","href":"/api-reference/errors"}]},{"group":"Bitsy Link","pages":[{"title":"Create Bitsy Link","openapi":"POST /link/create","href":"/api-reference/bitsy-link/create-link"},{"title":"Retrieve a Bitsy Link","openapi":"GET /link","description":"Retrieve a Bitsy Link by ID","href":"/api-reference/bitsy-link/retrieve-link"},{"title":"Retrieve all Bitsy Links","openapi":"GET /links","href":"/api-reference/bitsy-link/retrieve-links"},{"title":"Retrieve a Bitsy Link Analytics","openapi":"GET /link/stats","href":"/api-reference/bitsy-link/retrieve-link-analytics"},{"title":"Update Bitsy Link","openapi":"PUT /link/update","href":"/api-reference/bitsy-link/update-link"},{"title":"Delete Bitsy Link","openapi":"DELETE /link/delete","href":"/api-reference/bitsy-link/delete-link"}]}]}]},"basePath":"","title":"Create Bitsy Link - Bitsy Documentation","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DCDCdBVX.js","utils-ME8dDnLe.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-0e84ACsd.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-wgRBj-ia.js","snippetPresets-C11Sgb-o.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-C0lapOpP.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ZeRQV8fF.js","shallow-BupWh095.js","getApiPlaygroundDisplay-BnYQO2Ss.js","CodeSnippet-RKKOc8c_.js","CodeSnippets-Drf_m8wS.js","Page-Bevw23-4.js","getPastedJson-u6QiPzNZ.js","icon-Bb-CBSxO.js","MethodPill-F7l5AI7V.js","DuplicateIcon-IiAXkdSg.js","createIcon-FliI8EBc.js","DynamicMarkdown-B62XqCSI.js","SectionHeading-Dj31pT03.js","axios-vUo_bRtp.js","Markdown-BOgQCTwD.js","clsx-BIWXJmsZ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DKZWslLH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-UDqbR6xh.js"]}