Update a biolink
curl --request PATCH \
--url https://biq.li/api/v1/bio/{bio} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"external_id": "<string>",
"description": "<string>",
"alias": "<string>",
"domain_id": "<string>",
"active": true,
"password": "<string>",
"activates_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"allow_search_engine_indexing": true
}
'import requests
url = "https://biq.li/api/v1/bio/{bio}"
payload = {
"name": "<string>",
"external_id": "<string>",
"description": "<string>",
"alias": "<string>",
"domain_id": "<string>",
"active": True,
"password": "<string>",
"activates_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"allow_search_engine_indexing": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
external_id: '<string>',
description: '<string>',
alias: '<string>',
domain_id: '<string>',
active: true,
password: '<string>',
activates_at: '2023-11-07T05:31:56Z',
expires_at: '2023-11-07T05:31:56Z',
allow_search_engine_indexing: true
})
};
fetch('https://biq.li/api/v1/bio/{bio}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://biq.li/api/v1/bio/{bio}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'external_id' => '<string>',
'description' => '<string>',
'alias' => '<string>',
'domain_id' => '<string>',
'active' => true,
'password' => '<string>',
'activates_at' => '2023-11-07T05:31:56Z',
'expires_at' => '2023-11-07T05:31:56Z',
'allow_search_engine_indexing' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://biq.li/api/v1/bio/{bio}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"external_id\": \"<string>\",\n \"description\": \"<string>\",\n \"alias\": \"<string>\",\n \"domain_id\": \"<string>\",\n \"active\": true,\n \"password\": \"<string>\",\n \"activates_at\": \"2023-11-07T05:31:56Z\",\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"allow_search_engine_indexing\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://biq.li/api/v1/bio/{bio}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"external_id\": \"<string>\",\n \"description\": \"<string>\",\n \"alias\": \"<string>\",\n \"domain_id\": \"<string>\",\n \"active\": true,\n \"password\": \"<string>\",\n \"activates_at\": \"2023-11-07T05:31:56Z\",\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"allow_search_engine_indexing\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://biq.li/api/v1/bio/{bio}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"external_id\": \"<string>\",\n \"description\": \"<string>\",\n \"alias\": \"<string>\",\n \"domain_id\": \"<string>\",\n \"active\": true,\n \"password\": \"<string>\",\n \"activates_at\": \"2023-11-07T05:31:56Z\",\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"allow_search_engine_indexing\": true\n}"
response = http.request(request)
puts response.read_body{
"biolink": {
"id": "<string>",
"external_id": "<string>",
"name": "<string>",
"description": "<string>",
"short_url": "<string>",
"alias": "<string>",
"domain_id": "<string>",
"active": true,
"has_password": true,
"activates_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"allow_search_engine_indexing": true,
"links_count": 1,
"clicks_count": 1,
"clicked_at": "2023-11-07T05:31:56Z",
"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>"
}Biolinks
Update a biolink
Surgically update a bio page’s public URL and access settings.
PATCH
/
v1
/
bio
/
{bio}
Update a biolink
curl --request PATCH \
--url https://biq.li/api/v1/bio/{bio} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"external_id": "<string>",
"description": "<string>",
"alias": "<string>",
"domain_id": "<string>",
"active": true,
"password": "<string>",
"activates_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"allow_search_engine_indexing": true
}
'import requests
url = "https://biq.li/api/v1/bio/{bio}"
payload = {
"name": "<string>",
"external_id": "<string>",
"description": "<string>",
"alias": "<string>",
"domain_id": "<string>",
"active": True,
"password": "<string>",
"activates_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"allow_search_engine_indexing": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
external_id: '<string>',
description: '<string>',
alias: '<string>',
domain_id: '<string>',
active: true,
password: '<string>',
activates_at: '2023-11-07T05:31:56Z',
expires_at: '2023-11-07T05:31:56Z',
allow_search_engine_indexing: true
})
};
fetch('https://biq.li/api/v1/bio/{bio}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://biq.li/api/v1/bio/{bio}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'external_id' => '<string>',
'description' => '<string>',
'alias' => '<string>',
'domain_id' => '<string>',
'active' => true,
'password' => '<string>',
'activates_at' => '2023-11-07T05:31:56Z',
'expires_at' => '2023-11-07T05:31:56Z',
'allow_search_engine_indexing' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://biq.li/api/v1/bio/{bio}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"external_id\": \"<string>\",\n \"description\": \"<string>\",\n \"alias\": \"<string>\",\n \"domain_id\": \"<string>\",\n \"active\": true,\n \"password\": \"<string>\",\n \"activates_at\": \"2023-11-07T05:31:56Z\",\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"allow_search_engine_indexing\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://biq.li/api/v1/bio/{bio}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"external_id\": \"<string>\",\n \"description\": \"<string>\",\n \"alias\": \"<string>\",\n \"domain_id\": \"<string>\",\n \"active\": true,\n \"password\": \"<string>\",\n \"activates_at\": \"2023-11-07T05:31:56Z\",\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"allow_search_engine_indexing\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://biq.li/api/v1/bio/{bio}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"external_id\": \"<string>\",\n \"description\": \"<string>\",\n \"alias\": \"<string>\",\n \"domain_id\": \"<string>\",\n \"active\": true,\n \"password\": \"<string>\",\n \"activates_at\": \"2023-11-07T05:31:56Z\",\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"allow_search_engine_indexing\": true\n}"
response = http.request(request)
puts response.read_body{
"biolink": {
"id": "<string>",
"external_id": "<string>",
"name": "<string>",
"description": "<string>",
"short_url": "<string>",
"alias": "<string>",
"domain_id": "<string>",
"active": true,
"has_password": true,
"activates_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"allow_search_engine_indexing": true,
"links_count": 1,
"clicks_count": 1,
"clicked_at": "2023-11-07T05:31:56Z",
"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 selected page-level fields without replacing the whole biolink. The key
needs Biolinks: Write with the
Changing
Enable password protection:
Remove password protection and expiration:
Disable the page:
This endpoint does not update widgets, appearance, layout, content ordering, or
the links displayed on the page.
biolinks.update permission. An update
containing domain_id also needs Custom domains: Read
(custom_domains.view).
PATCH behavior
Send only the fields you want to change. Omitted fields keep their current values. The endpoint rejects an empty object and unknown fields.curl --request PATCH \
--url https://biq.li/api/v1/bio/biq_bio_01M19R8Q6G4S2PT7VNZ5K0W3CX \
--header 'Authorization: Bearer biqli_your_workspace_api_key' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"alias": "acme-official",
"active": true
}'
Supported fields
The update endpoint accepts the same page-level fields as Create a biolink:| Field | Clearing behavior |
|---|---|
name | Cannot be null or empty. |
external_id | Send null to remove it. |
description | Send null to remove it. |
alias | Cannot be null. Send a new valid alias to change the path. |
domain_id | Send null to move the page to the default Biqli domain. |
active | Send false to disable the page. |
password | Send null or an empty string to remove password protection. |
activates_at | Send null to remove scheduled activation. |
expires_at | Send null to remove scheduled expiration. |
allow_search_engine_indexing | Send true or false. |
domain_id without sending alias keeps the current alias and checks
whether it is available on the new domain. The update is atomic: a conflict or
validation failure leaves the existing biolink unchanged.
Common updates
Change the public URL:{
"domain_id": "biq_dom_01M14C6KQ6SG2GKMCV7HQ9A1QT",
"alias": "acme-official"
}
{
"password": "preview-2026"
}
{
"password": null,
"expires_at": null
}
{
"active": false
}
Successful response
Success returns200 OK with the same complete resource format as
Retrieve a biolink. The response contains the
new short_url after an alias or domain change.
{
"biolink": {
"id": "biq_bio_01M19R8Q6G4S2PT7VNZ5K0W3CX",
"external_id": "creator-page-1842",
"name": "Acme profile",
"description": "Official links for Acme.",
"short_url": "https://go.example.com/acme-official",
"alias": "acme-official",
"domain_id": "biq_dom_01M14C6KQ6SG2GKMCV7HQ9A1QT",
"active": true,
"has_password": true,
"activates_at": null,
"expires_at": null,
"allow_search_engine_indexing": false,
"links_count": 4,
"clicks_count": 238,
"clicked_at": "2026-08-30T12:15:31+00:00",
"created_at": "2026-08-30T11:42:19+00:00",
"updated_at": "2026-08-30T13:09:44+00:00"
},
"status": "success"
}
Errors
| HTTP status | Error code | Meaning |
|---|---|---|
401 | invalid_token | The API key is missing, invalid, or revoked. |
403 | insufficient_scope | The key lacks biolinks.update, lacks custom_domains.view when selecting a domain, or its user cannot update the page. |
404 | resource_not_found | The biolink or selected domain is unavailable in this workspace. |
409 | alias_taken | The alias is already used on the selected domain. |
409 | external_id_taken | The external ID is already used in the workspace. |
409 | biolink_name_taken | Another biolink already uses the name. |
409 | folder_name_taken | A folder already uses the name. |
422 | validation_error | The body is empty, invalid, or contains unsupported fields. |
429 | rate_limit_exceeded | The workspace exceeded its API request limit. |
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
A workspace API key beginning with biqli_.
Path Parameters
Pattern:
^biq_bio_[0-9A-HJKMNP-TV-Z]{26}$Body
application/json
Required string length:
3 - 250Required string length:
1 - 255Maximum string length:
250Pattern:
^biq_dom_[0-9A-HJKMNP-TV-Z]{26}$Maximum string length:
250
