Links

/v1/links

Create a new link

post/v1/links

Request

  • Base URL
    https://api.rebrandly.com
  • URL
    https://api.rebrandly.com/v1/links
  • Auth
    API key in header apikey

Headers

workspacestring

Which workspace id to be used to create links. No workspace specified will select default workspace, but we recommend your integration is workspaces-aware.

Request body

destinationstring required

The destination URL you want your branded short link to point to. Example: https://google.com

slashtagstring

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.

titlestring

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.

Response

200

idstring
titlestring
slashtagstring
destinationstring
createdAtstring
updatedAtstring
shortUrlstring

Example response

{
  "id": "fffa4cc5b6ee45d6g7897b06ac2d16af",
  "title": "What is Rebrandly",
  "slashtag": "video",
  "destination": "https://www.youtube.com/watch?v=3VmtibKpmXI",
  "createdAt": "2016-07-13T10:54:12.000Z",
  "updatedAt": "2016-07-13T10:54:12.000Z",
  "shortUrl": "rebrand.ly/video",
  "domain": {
    "id": "8f104cc5b6ee4a4ba7897b06ac2ddcfb",
    "fullName": "rebrand.ly"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.