POST
/
v1
/
workspaces
/
{workspace_id}
/
links
curl --request POST \
  --url https://api.ziplink.click/v1/workspaces/{workspace_id}/links \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "alias": "conf2024",
  "domain_id": "ab782971-4d79-47ab-8685-77cf5a34b2bb",
  "expired_redirect_url": "https://example.com/2024-conference-dubai",
  "expires_at": "2023-11-07T05:31:56Z",
  "has_analytics": false,
  "has_qr_code": false,
  "title": "Marketing homepage",
  "url": "https://example.com/2024-conference-dubai"
}'
{
  "id": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
workspace_id
string
required

ID of the workspace.

Example:

"ab782971-4d79-47ab-8685-77cf5a34b2bb"

Query Parameters

​
title
string

Name of the link.

Example:

"Marketing homepage"

​
domain-id
string

ID of the domain.

Example:

"ab782971-4d79-47ab-8685-77cf5a34b2bb"

​
status
enum<string>

Status of the link.

Available options:
active,
deleted
Example:

"active"

​
expires-after
string

Optional expiration date and time.

​
expires-before
string

Optional expiration date and time.

​
has-analytics
boolean

Whether analytics are enabled for the link or not.

​
has-qr-code
boolean

Whether QR code is enabled for the link or not.

​
created-before
string

The creation date that will be used to query results until.

​
created-after
string

The creation date that will be used to query results from.

​
offset
integer
default:0

Number of resources to skip.

Required range: x >= 0
​
limit
integer
default:100

Number of resources to return.

Required range: 1 <= x <= 1000

Body

application/json
​
url
string
required

Long URL to be shortened.

Maximum length: 2000
Example:

"https://example.com/2024-conference-dubai"

​
alias
string | null

Shortened alias of the link.

Required string length: 3 - 36
Example:

"conf2024"

​
domain_id
string

ID of the domain.

Example:

"ab782971-4d79-47ab-8685-77cf5a34b2bb"

​
expired_redirect_url
string | null

Optional URL to redirect after expiration.

Maximum length: 2000
Example:

"https://example.com/2024-conference-dubai"

​
expires_at
string | null

Optional expiration date and time.

​
has_analytics
boolean
default:false

Whether analytics are enabled for the link or not.

​
has_qr_code
boolean
default:false

Whether QR codes are generated for the link or not.

​
title
string | null

Name of the link.

Required string length: 3 - 255
Example:

"Marketing homepage"

Response

201
application/json
Example response
​
id
string
required

ID of the newly created resource.