Skip to main content
PATCH
Update a biolink
Update selected page-level fields without replacing the whole biolink. The key needs Biolinks: Write with the 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.

Supported fields

The update endpoint accepts the same page-level fields as Create a biolink: Changing 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:
Enable password protection:
Remove password protection and expiration:
Disable the page:

Successful response

Success returns 200 OK with the same complete resource format as Retrieve a biolink. The response contains the new short_url after an alias or domain change.
This endpoint does not update widgets, appearance, layout, content ordering, or the links displayed on the page.

Errors

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

bio
string
required
Pattern: ^biq_bio_[0-9A-HJKMNP-TV-Z]{26}$

Body

application/json
name
string
Required string length: 3 - 250
external_id
string | null
Required string length: 1 - 255
description
string | null
Maximum string length: 250
alias
string
domain_id
string | null
Pattern: ^biq_dom_[0-9A-HJKMNP-TV-Z]{26}$
active
boolean
password
string | null
write-only
Maximum string length: 250
activates_at
string<date-time> | null
expires_at
string<date-time> | null
allow_search_engine_indexing
boolean

Response

Updated biolink.

Stable page-level settings and aggregate counts. Frontend-owned content, widgets, layout, and appearance are omitted.

status
string
required
Allowed value: "success"