PATCH
/
v1
/
workspaces
/
{workspace_id}
/
links
/
{link_id}
curl --request PATCH \
  --url https://api.ziplink.click/v1/workspaces/{workspace_id}/links/{link_id} \
  --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,
  "status": "active",
  "title": "Marketing homepage",
  "url": "https://example.com/2024-conference-dubai"
}'
{
  "alias": "conf2024",
  "created_at": "2023-11-07T05:31:56Z",
  "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,
  "id": "ab782971-4d79-47ab-8685-77cf5a34b2bb",
  "is_reported": false,
  "qr_code_id": "ab782971-4d79-47ab-8685-77cf5a34b2bb",
  "qr_code_url": "https://example.com/2024-conference-dubai",
  "short_url": "https://zipl.ink/conf2024",
  "status": "active",
  "title": "Marketing homepage",
  "updated_at": "2023-11-07T05:31:56Z",
  "url": "https://example.com/2024-conference-dubai",
  "workspace_id": "ab782971-4d79-47ab-8685-77cf5a34b2bb"
}

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"

​
link_id
string
required

ID of the link.

Example:

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

Body

application/json
​
alias
string | null

Shortened alias of the link.

Required string length: 3 - 36
Example:

"conf2024"

​
domain_id
string | null

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.

​
status
enum<string>

Status of the link.

Available options:
active,
deleted
Example:

"active"

​
title
string | null

Name of the link.

Required string length: 3 - 255
Example:

"Marketing homepage"

​
url
string

Long URL to be shortened.

Maximum length: 2000
Example:

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

Response

200
application/json
OK

A link in the system.

​
alias
string
required

Alias of the link.

Required string length: 3 - 36
Example:

"conf2024"

​
created_at
string
required

Date when the link was created.

​
expired_redirect_url
string | null
required

Optional URL to redirect after expiration.

Maximum length: 2000
Example:

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

​
expires_at
string | null
required

Optional expiration date and time.

​
has_analytics
boolean
default:false
required

Whether analytics are enabled for the link or not.

​
has_qr_code
boolean
default:false
required

Whether QR codes are generated for the link or not.

​
id
string
required

Globally unique identifier of the link.

Example:

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

​
is_reported
boolean
default:false
required

Whether the link was flagged potentially harmful or not.

​
short_url
string
required

Short URL that is redirected.

Maximum length: 2000
Example:

"https://zipl.ink/conf2024"

​
status
enum<string>
required

Status of the link.

Available options:
active,
deleted
Example:

"active"

​
title
string | null
required

Name of the link.

Required string length: 3 - 255
Example:

"Marketing homepage"

​
updated_at
string | null
required

Date when the link was updated.

​
url
string
required

Long URL to be shortened.

Maximum length: 2000
Example:

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

​
workspace_id
string
required

Globally unique identifier of the the workspace the link belongs to.

Example:

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

​
domain_id
string

Globally unique identifier of the the domain the link belongs to.

Example:

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

​
qr_code_id
string

Globally unique identifier of the QR code.

Example:

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

​
qr_code_url
string | null

URL pointing to the QR code of the

Maximum length: 2000
Example:

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