---
updatedAt: 2026-06-21T19:39:10.000Z
agentTools:
  projectIndex: https://developers.rebrandly.com/llms.txt
---

# /v1/links

Create a new link

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Rebrandly Legacy",
    "description": "Transform your long URLs into short branded links",
    "termsOfService": "https://rebrandly.com/terms-conditions",
    "version": "1.0.0",
    "contact": {
      "url": "https://developers.rebrandly.com"
    }
  },
  "servers": [
    {
      "url": "https://api.rebrandly.com"
    }
  ],
  "components": {
    "schemas": {
      "LinkCreationRequest": {
        "type": "object",
        "required": [
          "destination"
        ],
        "properties": {
          "destination": {
            "type": "string",
            "description": "The destination URL you want your branded short link to point to. Example: https://google.com"
          },
          "slashtag": {
            "type": "string",
            "description": "The keyword portion of your branded short link. A random one (as short as possible according to the branded domain you use) will be auto-generated if you do not specify one."
          },
          "domain": {
            "type": "object",
            "description": "A reference to the Branded Domain resource for this branded short link. Specify either domain id or domain fullName or both. Make sure the domain is already active/verified and shared in this workspace.",
            "properties": {
              "id": {
                "type": "string",
                "description": "Branded domain's unique identifier"
              },
              "fullName": {
                "type": "string",
                "description": "Branded domain's FQDN"
              }
            }
          },
          "title": {
            "type": "string",
            "description": "A title you assign to the branded short link in order to remember what's behind it. A random title will be assigned to the link if you do not specify one."
          }
        }
      },
      "Link": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "fffa4cc5b6ee45d6g7897b06ac2d16af"
          },
          "title": {
            "type": "string",
            "example": "What is Rebrandly"
          },
          "slashtag": {
            "type": "string",
            "example": "video"
          },
          "destination": {
            "type": "string",
            "example": "https://www.youtube.com/watch?v=3VmtibKpmXI"
          },
          "createdAt": {
            "type": "string",
            "example": "2016-07-13T10:54:12.000Z"
          },
          "updatedAt": {
            "type": "string",
            "example": "2016-07-13T10:54:12.000Z"
          },
          "shortUrl": {
            "type": "string",
            "example": "rebrand.ly/video"
          },
          "domain": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "example": "8f104cc5b6ee4a4ba7897b06ac2ddcfb"
              },
              "fullName": {
                "type": "string",
                "example": "rebrand.ly"
              }
            }
          }
        }
      },
      "NotFound": {
        "type": "object",
        "properties": {
          "property": {
            "type": "string",
            "example": "domain.id"
          },
          "message": {
            "type": "string",
            "example": "Not found"
          },
          "code": {
            "type": "string",
            "example": "NotFound"
          }
        }
      },
      "AlreadyExists": {
        "type": "object",
        "properties": {
          "property": {
            "type": "string",
            "example": "slashtag"
          },
          "message": {
            "type": "string",
            "example": "Already exists"
          },
          "code": {
            "type": "string",
            "example": "AlreadyExists"
          }
        }
      }
    },
    "securitySchemes": {
      "viaApikey": {
        "type": "apiKey",
        "in": "header",
        "name": "apikey"
      }
    }
  },
  "security": [
    {
      "viaApikey": []
    }
  ],
  "paths": {
    "/v1/links": {
      "post": {
        "summary": "/v1/links",
        "description": "Create a new link",
        "operationId": "createLink",
        "parameters": [
          {
            "name": "workspace",
            "in": "header",
            "description": "Which workspace id to be used to create links. No workspace specified will select default workspace, but we recommend your integration is workspaces-aware.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/LinkCreationRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Link"
                }
              }
            }
          },
          "403": {
            "description": "403",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AlreadyExists"
                }
              }
            }
          },
          "404": {
            "description": "404",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NotFound"
                }
              }
            }
          }
        },
        "deprecated": false,
        "tags": [
          "Links"
        ]
      }
    }
  },
  "x-readme": {
    "explorer-enabled": false,
    "proxy-enabled": false,
    "samples-enabled": true
  }
}
```