Update a link

curl --request PATCH \
  --url https://biq.li/api/v1/link/{link} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "password": "new-private-password"
}
'

{
  "link": {
    "id": "<string>",
    "external_id": "<string>",
    "short_url": "<string>",
    "long_url": "<string>",
    "name": "<string>",
    "domain_id": "<string>",
    "alias": "<string>",
    "active": true,
    "has_password": true,
    "activates_at": "2023-11-07T05:31:56Z",
    "expires_at": "2023-11-07T05:31:56Z",
    "exp_clicks_rule": {
      "key": 2,
      "value": "<string>"
    },
    "utm": "<string>",
    "geo_rules": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "device_rules": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "platform_rules": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "folder_ids": [
      "<string>"
    ],
    "pixel_ids": [
      "<string>"
    ],
    "tag_ids": [
      "<string>"
    ],
    "conversion_tracking_enabled": true,
    "allow_search_engine_indexing": true,
    "proxy": true,
    "title": "<string>",
    "description": "<string>",
    "image": "<string>",
    "qr_code": {
      "url": "<string>",
      "format": "svg",
      "logo": "app"
    },
    "clicks_count": 1,
    "leads_count": 1,
    "sales_count": 1,
    "revenue": 1,
    "revenue_currency": "USD",
    "clicked_at": "2023-11-07T05:31:56Z",
    "safety_status": "clear",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "status": "success"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

PATCH

link

{link}

curl --request PATCH \
  --url https://biq.li/api/v1/link/{link} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "password": "new-private-password"
}
'

{
  "link": {
    "id": "<string>",
    "external_id": "<string>",
    "short_url": "<string>",
    "long_url": "<string>",
    "name": "<string>",
    "domain_id": "<string>",
    "alias": "<string>",
    "active": true,
    "has_password": true,
    "activates_at": "2023-11-07T05:31:56Z",
    "expires_at": "2023-11-07T05:31:56Z",
    "exp_clicks_rule": {
      "key": 2,
      "value": "<string>"
    },
    "utm": "<string>",
    "geo_rules": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "device_rules": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "platform_rules": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "folder_ids": [
      "<string>"
    ],
    "pixel_ids": [
      "<string>"
    ],
    "tag_ids": [
      "<string>"
    ],
    "conversion_tracking_enabled": true,
    "allow_search_engine_indexing": true,
    "proxy": true,
    "title": "<string>",
    "description": "<string>",
    "image": "<string>",
    "qr_code": {
      "url": "<string>",
      "format": "svg",
      "logo": "app"
    },
    "clicks_count": 1,
    "leads_count": 1,
    "sales_count": 1,
    "revenue": 1,
    "revenue_currency": "USD",
    "clicked_at": "2023-11-07T05:31:56Z",
    "safety_status": "clear",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "status": "success"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

Update only the fields you send. Omitted fields keep their current values, so you can make surgical changes without resending the complete link.

The public API uses PATCH. The Biqli dashboard’s internal PUT request is not part of this API contract.

Authentication and permissions

The key needs Links: Write (links.update). If you attach a non-empty list of existing workspace resources, it also needs the matching read permission.

Request field	Additional API key permission
`domain_id`	Custom domains: Read (`custom_domains.view`)
`folder_ids`	Folders: Read (`link_groups.view`)
`pixel_ids`	Tracking pixels: Read (`tracking_pixels.view`)
`tag_ids`	Tags: Read (`tags.view`)

Update one field

curl --request PATCH \
  --url https://biq.li/api/v1/link/biq_lnk_01M14D2M8VFKYQCE7Z3A6HRXWP \
  --header 'Authorization: Bearer biqli_your_workspace_api_key' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "password": "new-private-password"
  }'

This changes only the password. Send null to remove nullable values such as a password, external ID, custom alias, schedule, UTM string, or click-expiration rule.

Writable fields

PATCH accepts every mutable create field except create_qr_code and qr_logo. QR generation is a creation-only option.

Group	Fields
Identity and destination	`long_url`, `name`, `external_id`, `domain_id`, `alias`, `active`
Access and expiration	`password`, `activates_at`, `expires_at`, `exp_clicks_rule`
Redirect behavior	`utm`, `geo_rules`, `device_rules`, `platform_rules`
Attachments	`folder_ids`, `pixel_ids`, `tag_ids`
Tracking and indexing	`conversion_tracking_enabled`, `allow_search_engine_indexing`
Social preview	`proxy`, `title`, `description`, `image`

The types, limits, URL safety checks, plan restrictions, and public-ID formats are identical to Create a link.

Replacement and clearing rules

Sending an array replaces that complete array. Send [] to detach all folders, pixels, or tags, or to remove every rule in one targeting category.
Omitting an array leaves its current values unchanged.
Sending domain_id: null switches the link to the default Biqli domain.
Sending proxy: false disables the custom preview and clears its title, description, and image.
When proxy remains enabled, omitted preview fields keep their current values.
Sending exp_clicks_rule: null removes click-based expiration.
The API never accepts internal numeric IDs or workspace IDs.

When changing alias or domain_id, Biqli validates the effective alias and domain together. The link’s own current alias is excluded from the uniqueness check.

Update several settings

{
  "long_url": "https://example.com/autumn-product",
  "external_id": "campaign-link-1842",
  "alias": "autumn-product",
  "expires_at": "2026-12-01T08:00:00Z",
  "geo_rules": [],
  "folder_ids": [
    "biq_fld_01M14C93RJD7W46PFJX9B1TVYH"
  ],
  "proxy": true,
  "title": "Autumn sale"
}

Changing any destination, including dynamic-routing destinations, runs the same synchronous and asynchronous safety checks as creation. A destination needing a deeper check can set safety_status to pending; the short URL will not redirect until that check clears.

Response

A successful update returns 200 OK and the complete current link resource, including untouched configuration and current aggregate performance data.

{
  "link": {
    "id": "biq_lnk_01M14D2M8VFKYQCE7Z3A6HRXWP",
    "external_id": "campaign-link-1842",
    "short_url": "https://biq.li/autumn-product",
    "long_url": "https://example.com/autumn-product",
    "name": "Summer campaign",
    "domain_id": null,
    "alias": "autumn-product",
    "active": true,
    "has_password": true,
    "activates_at": null,
    "expires_at": "2026-12-01T08:00:00+00:00",
    "exp_clicks_rule": null,
    "utm": null,
    "geo_rules": [],
    "device_rules": [],
    "platform_rules": [],
    "folder_ids": ["biq_fld_01M14C93RJD7W46PFJX9B1TVYH"],
    "pixel_ids": [],
    "tag_ids": [],
    "conversion_tracking_enabled": true,
    "allow_search_engine_indexing": false,
    "proxy": true,
    "title": "Autumn sale",
    "description": "Explore the summer collection.",
    "image": "https://cdn.example.com/previews/summer.jpg",
    "qr_code": null,
    "clicks_count": 2841,
    "leads_count": 93,
    "sales_count": 27,
    "revenue": 4148.5,
    "revenue_currency": "USD",
    "clicked_at": "2026-08-29T10:42:11+00:00",
    "safety_status": "clear",
    "created_at": "2026-08-28T16:42:19+00:00",
    "updated_at": "2026-08-29T11:03:44+00:00"
  },
  "status": "success"
}

An empty object is a valid no-op and returns the current resource.

Errors

HTTP status	Error code	Meaning
`401`	`invalid_token`	The API key is missing, invalid, malformed, or revoked.
`403`	`insufficient_scope`	The key lacks `links.update`, an attachment read permission, or workspace access.
`403`	`upgrade_required`	The workspace plan does not include a requested feature.
`404`	`resource_not_found`	The link or an attached public resource is unavailable in this workspace.
`409`	`alias_taken`	The effective alias is already used on the effective domain.
`409`	`external_id_taken`	The external ID is already used in the workspace.
`422`	`url_blocked`	A supplied destination failed a synchronous safety check.
`422`	`validation_error`	A field is invalid, unknown, or inconsistent with another field.
`429`	`rate_limit_exceeded`	The workspace exceeded its API request limit.
`500`	`internal_server_error`	An unexpected server error occurred.

The API rejects unknown fields and returns validation details keyed by field.

Shared API behavior

Authentication is workspace-scoped; see Authentication. Errors use the standard envelope and request IDs described in Errors, and requests are subject to Rate limits.

Authorizations

Authorization

string

header

required

A workspace API key beginning with biqli_.

Path Parameters

link

string

required

Public link ID.

Pattern: ^biq_lnk_[0-9A-HJKMNP-TV-Z]{26}$

Body

application/json

A partial link update. Omitted properties keep their current values.

long_url

any

name

any

external_id

any

domain_id

any

alias

any

active

any

password

any

activates_at

any

expires_at

any

exp_clicks_rule

any

utm

any

geo_rules

any

device_rules

any

platform_rules

any

folder_ids

any

pixel_ids

any

tag_ids

any

conversion_tracking_enabled

any

allow_search_engine_indexing

any

proxy

any

title

any

description

any

image

any

Response

Link updated successfully.

link

object

required

Show child attributes

status

string

required

Allowed value: "success"

GETTING STARTED

OAUTH 2.0

OFFICIAL AUTOMATION APIS

SDKs

MOBILE ATTRIBUTION

BIQLI LINKS API

Update a link

Authentication and permissions

Update one field

Writable fields

Replacement and clearing rules

Update several settings

Response

Errors

Shared API behavior

Authorizations

Path Parameters

Body

Response

​Authentication and permissions

​Update one field

​Writable fields

​Replacement and clearing rules

​Update several settings

​Response

​Errors

​Shared API behavior

Authorizations

Path Parameters

Body

Response

Authentication and permissions

Update one field

Writable fields

Replacement and clearing rules

Update several settings

Response

Errors

Shared API behavior