POST
https://api.dub.co
/
links
curl --request POST \
  --url https://api.dub.co/links \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "domain": "<string>",
  "key": "<string>",
  "prefix": "<string>",
  "url": "<string>",
  "archived": false,
  "expiresAt": "2023-11-07T05:31:56Z",
  "password": "<string>",
  "proxy": false,
  "title": "<string>",
  "description": "<string>",
  "image": "<string>",
  "rewrite": false,
  "ios": "<string>",
  "android": "<string>",
  "geo": {},
  "publicStats": false,
  "tagId": "<string>",
  "tagIds": "<string>",
  "comments": "<string>"
}'
{
  "id": "<string>",
  "domain": "<string>",
  "key": "<string>",
  "url": "<string>",
  "archived": false,
  "expiresAt": "<string>",
  "password": "<string>",
  "proxy": false,
  "title": "<string>",
  "description": "<string>",
  "image": "<string>",
  "rewrite": false,
  "ios": "<string>",
  "android": "<string>",
  "geo": {},
  "publicStats": false,
  "tagId": "<string>",
  "tags": [
    {
      "id": "<string>",
      "name": "<string>",
      "color": "red"
    }
  ],
  "comments": "<string>",
  "shortLink": "<string>",
  "qrCode": "<string>",
  "utm_source": "<string>",
  "utm_medium": "<string>",
  "utm_campaign": "<string>",
  "utm_term": "<string>",
  "utm_content": "<string>",
  "userId": "<string>",
  "workspaceId": "<string>",
  "clicks": 0,
  "lastClicked": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "projectId": "<string>"
}

Authorizations

Authorization
string
header
required

Default authentication mechanism

Query Parameters

workspaceId
string
required

The ID of the workspace to create the link for.

Body

application/json

Response

200
application/json

The created link

The response is of type object.