> ## 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 domain

> Surgically update redirect behavior for a custom domain.

Partially update one domain's fallback redirect behavior. Only supplied fields
change. The host and DNS identity are intentionally immutable; connect a new
domain instead of renaming an existing claim.

## Authentication, permission, and plan

Requires **Custom domains: Write** (`custom_domains.update`) and the workspace
plan feature for custom-domain redirect settings.

```bash theme={null}
curl --request PATCH \
  --url https://biq.li/api/v1/domain/biq_dom_01M18D4A8QRJY5G6K3N2W7X9TZ \
  --header 'Authorization: Bearer biqli_your_workspace_api_key' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "use_default_redirect": true,
    "default_redirect_url": "https://example.com"
  }'
```

## Mutable fields

| Field                    | Type                | Behavior                                                            |
| ------------------------ | ------------------- | ------------------------------------------------------------------- |
| `use_default_redirect`   | boolean             | Redirect requests for the bare custom domain.                       |
| `default_redirect_url`   | HTTP(S) URL or null | Destination for the bare-domain redirect.                           |
| `use_not_found_redirect` | boolean             | Redirect unknown aliases instead of showing the not-found response. |
| `not_found_redirect_url` | HTTP(S) URL or null | Destination for unknown aliases.                                    |
| `use_expired_redirect`   | boolean             | Redirect expired links to a domain-level destination.               |
| `expired_redirect_url`   | HTTP(S) URL or null | Destination for expired links.                                      |

Sending a non-null URL without its `use_...` flag automatically enables that
redirect. Sending `null` without the flag disables it. Enabling a redirect
without an existing or supplied URL returns `422 validation_error`.

To disable a redirect while preserving its URL for later:

```json theme={null}
{"use_not_found_redirect": false}
```

To disable it and clear the stored URL:

```json theme={null}
{
  "use_not_found_redirect": false,
  "not_found_redirect_url": null
}
```

All URLs must use HTTP or HTTPS and be at most 255 characters. The endpoint
requires at least one supported field and rejects unknown fields such as
`host`, `global`, numeric resource IDs, favicon internals, and workspace IDs.

## Response

A successful update returns `200 OK` with the same complete domain resource as
[Retrieve a domain](/docs/api-reference/domains/get). Repeating the same PATCH is
safe and leaves the domain in the same state.

| HTTP status | Error code           | Meaning                                                 |
| ----------- | -------------------- | ------------------------------------------------------- |
| `403`       | `insufficient_scope` | The key or user cannot update this workspace domain.    |
| `403`       | `upgrade_required`   | The plan does not include redirect settings.            |
| `404`       | `resource_not_found` | The public ID is malformed or unavailable here.         |
| `422`       | `validation_error`   | A URL, boolean, field, or field combination is invalid. |

## 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/domain/{domain}
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/domain/{domain}:
    patch:
      tags:
        - Domains
      summary: Update a domain
      description: >-
        Partially updates domain redirect settings. The host is immutable.
        Requires custom_domains.update and the redirect-settings plan feature.
      operationId: domain.update
      parameters:
        - $ref: '#/components/parameters/DomainId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDomainRequest'
      responses:
        '200':
          description: Domain updated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    DomainId:
      name: domain
      in: path
      required: true
      description: Public custom-domain ID. Numeric IDs and hosts are not accepted.
      schema:
        type: string
        pattern: ^biq_dom_[0-9A-HJKMNP-TV-Z]{26}$
  schemas:
    UpdateDomainRequest:
      type: object
      additionalProperties: false
      minProperties: 1
      properties:
        use_default_redirect:
          type: boolean
        default_redirect_url:
          type:
            - string
            - 'null'
          format: uri
          maxLength: 255
        use_not_found_redirect:
          type: boolean
        not_found_redirect_url:
          type:
            - string
            - 'null'
          format: uri
          maxLength: 255
        use_expired_redirect:
          type: boolean
        expired_redirect_url:
          type:
            - string
            - 'null'
          format: uri
          maxLength: 255
    DomainResponse:
      type: object
      additionalProperties: false
      required:
        - domain
        - status
      properties:
        domain:
          $ref: '#/components/schemas/Domain'
        status:
          type: string
          const: success
    Domain:
      type: object
      additionalProperties: false
      required:
        - id
        - host
        - url
        - status
        - dns_status
        - ssl_status
        - dns_verified
        - active
        - is_subdomain
        - links_count
        - claim_expires_at
        - dns_last_checked_at
        - dns_verified_at
        - ssl_last_checked_at
        - use_default_redirect
        - default_redirect_url
        - use_not_found_redirect
        - not_found_redirect_url
        - use_expired_redirect
        - expired_redirect_url
        - created_at
        - updated_at
      properties:
        id:
          type: string
          pattern: ^biq_dom_[0-9A-HJKMNP-TV-Z]{26}$
        host:
          type: string
          examples:
            - go.example.com
        url:
          type: string
          format: uri
        status:
          type: string
          enum:
            - pending_dns
            - verifying_dns
            - dns_failed
            - provisioning_ssl
            - ssl_failed
            - active
        dns_status:
          type: string
          enum:
            - pending
            - verifying
            - verified
            - failed
        ssl_status:
          type: string
          enum:
            - pending
            - processing
            - active
            - failed
        dns_verified:
          type: boolean
        active:
          type: boolean
        is_subdomain:
          type: boolean
        links_count:
          type: integer
          minimum: 0
          description: Links using this domain in the API key's workspace only.
        claim_expires_at:
          type:
            - string
            - 'null'
          format: date-time
        dns_last_checked_at:
          type:
            - string
            - 'null'
          format: date-time
        dns_verified_at:
          type:
            - string
            - 'null'
          format: date-time
        ssl_last_checked_at:
          type:
            - string
            - 'null'
          format: date-time
        use_default_redirect:
          type: boolean
        default_redirect_url:
          type:
            - string
            - 'null'
          format: uri
        use_not_found_redirect:
          type: boolean
        not_found_redirect_url:
          type:
            - string
            - 'null'
          format: uri
        use_expired_redirect:
          type: boolean
        expired_redirect_url:
          type:
            - string
            - 'null'
          format: uri
        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.
    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_.

````