API Explorer
Log in/Sign upHelp Center

Create a New Link

post
https://api.rebrandly.com/v1/links

Creates a new branded short link in the specified workspace.

Authorization:

  • Requires valid apikey header
  • Requires Workspace header to specify the workspace

Validation:

  • destination must be a valid URL
  • domainId must reference a verified domain shared with the workspace
  • slashtag must be unique for the domain (auto-generated if not provided)
  • slashtag length must comply with domain settings

Features:

  • links.notes feature allows description field
  • Link TTL is calculated based on workspace features
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
uri
required

Target URL where the short link redirects

string

Public ID of the domain to use (must be verified and shared with workspace)

domain
object

Alternative way to specify domain (legacy)

string
^[a-zA-Z0-9_-]+$

Custom path component (auto-generated if not provided, must be unique)

string
length ≤ 255

Human-readable title for the link

string

Link description (requires links.notes feature)

Headers
Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?
// Bulk plan CTA banner: requested by Alison to promote the high-volume pricing plan. Injected in Footer HTML per ReadMe convention, but renderd at the top of the viewport via the fixed-position CSS above.
Sending 250K+ links a year? You qualify for a better rate. See high-volume pricing