Skip to main content
PATCH
Update a 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.

Mutable fields

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:
To disable it and clear the stored URL:
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. Repeating the same PATCH is safe and leaves the domain in the same state.

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

domain
string
required

Public custom-domain ID. Numeric IDs and hosts are not accepted.

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

Body

application/json
use_default_redirect
boolean
default_redirect_url
string<uri> | null
Maximum string length: 255
use_not_found_redirect
boolean
not_found_redirect_url
string<uri> | null
Maximum string length: 255
use_expired_redirect
boolean
expired_redirect_url
string<uri> | null
Maximum string length: 255

Response

Domain updated successfully.

domain
object
required
status
string
required
Allowed value: "success"