> ## Documentation Index > Fetch the complete documentation index at: https://learn.biq.li/llms.txt > Use this file to discover all available pages before exploring further. # Update a biolink > Surgically update a bio page's public URL and access settings. 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. ```bash theme={null} 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](/docs/api-reference/biolinks/create): | 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`. | 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: ```json theme={null} { "domain_id": "biq_dom_01M14C6KQ6SG2GKMCV7HQ9A1QT", "alias": "acme-official" } ``` Enable password protection: ```json theme={null} { "password": "preview-2026" } ``` Remove password protection and expiration: ```json theme={null} { "password": null, "expires_at": null } ``` Disable the page: ```json theme={null} { "active": false } ``` ## Successful response Success returns `200 OK` with the same complete resource format as [Retrieve a biolink](/docs/api-reference/biolinks/get). The response contains the new `short_url` after an alias or domain change. ```json theme={null} { "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" } ``` This endpoint does not update widgets, appearance, layout, content ordering, or the links displayed on the page. ## 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](/docs/api-reference/authentication). Errors use the standard envelope and request IDs described in [Errors](/docs/api-reference/errors), and requests are subject to [Rate limits](/docs/api-reference/rate-limits). ## OpenAPI ````yaml PATCH /v1/bio/{bio} openapi: 3.1.0 info: title: Biqli API version: 1.0.0 description: Workspace-scoped REST API for Biqli. servers: - url: https://biq.li/api security: - bearerAuth: [] paths: /v1/bio/{bio}: parameters: - $ref: '#/components/parameters/BiolinkId' patch: tags: - Biolinks summary: Update a biolink description: >- Updates only supplied page-level fields. Omitted fields are preserved. Requires biolinks.update. operationId: bio.update requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BiolinkPatch' responses: '200': description: Updated biolink. content: application/json: schema: $ref: '#/components/schemas/BiolinkResponse' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' '422': $ref: '#/components/responses/UnprocessableEntity' '429': $ref: '#/components/responses/RateLimited' '500': $ref: '#/components/responses/InternalError' components: parameters: BiolinkId: name: bio in: path required: true schema: type: string pattern: ^biq_bio_[0-9A-HJKMNP-TV-Z]{26}$ schemas: BiolinkPatch: allOf: - $ref: '#/components/schemas/BiolinkFields' - type: object minProperties: 1 BiolinkResponse: type: object required: - biolink - status properties: biolink: $ref: '#/components/schemas/Biolink' status: type: string const: success BiolinkFields: type: object additionalProperties: false properties: name: type: string minLength: 3 maxLength: 250 external_id: type: - string - 'null' minLength: 1 maxLength: 255 description: type: - string - 'null' maxLength: 250 alias: type: string domain_id: type: - string - 'null' pattern: ^biq_dom_[0-9A-HJKMNP-TV-Z]{26}$ active: type: boolean password: type: - string - 'null' maxLength: 250 writeOnly: true activates_at: type: - string - 'null' format: date-time expires_at: type: - string - 'null' format: date-time allow_search_engine_indexing: type: boolean Biolink: type: object additionalProperties: false description: >- Stable page-level settings and aggregate counts. Frontend-owned content, widgets, layout, and appearance are omitted. required: - id - external_id - name - description - short_url - alias - domain_id - active - has_password - activates_at - expires_at - allow_search_engine_indexing - links_count - clicks_count - clicked_at - created_at - updated_at properties: id: type: string pattern: ^biq_bio_[0-9A-HJKMNP-TV-Z]{26}$ external_id: type: - string - 'null' name: type: string description: type: - string - 'null' short_url: type: string format: uri alias: type: string domain_id: type: - string - 'null' pattern: ^biq_dom_[0-9A-HJKMNP-TV-Z]{26}$ active: type: boolean has_password: type: boolean activates_at: type: - string - 'null' format: date-time expires_at: type: - string - 'null' format: date-time allow_search_engine_indexing: type: boolean links_count: type: integer minimum: 0 clicks_count: type: integer minimum: 0 clicked_at: type: - string - 'null' format: date-time created_at: type: - string - 'null' format: date-time updated_at: type: - string - 'null' format: date-time ApiError: type: object required: - error - request_id properties: error: type: object required: - code - message properties: code: type: string enum: - invalid_token - insufficient_scope - upgrade_required - quota_exceeded - resource_not_found - domain_taken - alias_taken - external_id_taken - folder_name_taken - tag_name_taken - pixel_name_taken - biolink_name_taken - method_not_allowed - url_blocked - dns_verification_failed - validation_error - rate_limit_exceeded - internal_server_error message: type: string details: type: object additionalProperties: true request_id: type: string description: Request identifier to include when contacting support. responses: Unauthorized: $ref: '#/components/responses/ApiErrorResponse' description: The workspace API key is missing, invalid, or revoked. Forbidden: $ref: '#/components/responses/ApiErrorResponse' description: >- The key lacks a required scope, the workspace must upgrade, or its quota is exhausted. NotFound: $ref: '#/components/responses/ApiErrorResponse' description: >- The requested resource or referenced public ID is unavailable in the key's workspace. Conflict: $ref: '#/components/responses/ApiErrorResponse' description: >- A unique alias, external ID, custom domain, or workspace resource name is already in use. UnprocessableEntity: $ref: '#/components/responses/ApiErrorResponse' description: >- The payload is invalid, a destination was blocked, or domain DNS verification is not ready. RateLimited: description: The workspace exceeded its plan's API rate limit. headers: RateLimit-Policy: description: Current IETF HTTPAPI quota policy as a structured field. schema: type: string example: '"workspace-api";q=1000;w=60' RateLimit: description: Current IETF HTTPAPI service limit as a structured field. schema: type: string example: '"workspace-api";r=0;t=17' Retry-After: description: Seconds to wait before retrying the request. schema: type: integer minimum: 0 example: 17 X-RateLimit-Limit: description: Legacy maximum request count for the current window. schema: type: integer minimum: 1 example: 1000 X-RateLimit-Remaining: description: Legacy remaining request count. schema: type: integer minimum: 0 example: 0 X-RateLimit-Reset: description: Legacy reset time as a UTC Unix timestamp. schema: type: integer format: int64 example: 1788126519 X-Biq-Request-Id: description: Request identifier for support and tracing. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ApiError' InternalError: $ref: '#/components/responses/ApiErrorResponse' description: The request failed unexpectedly. ApiErrorResponse: description: API error. headers: X-Biq-Request-Id: description: Request identifier for support and tracing. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ApiError' securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: Workspace API key description: A workspace API key beginning with biqli_. ````