Documentation

Update an own domain

PATCH/v1/domains/{domain}Domains

Changes where the bare domain sends visitors.

Parameters

Parameter	Type	Required	Description
`domain`	string, in the path	required	The domain's id or its hostname.

Request body

JSON, sent with Content-Type: application/json.

Field	Type	Required	Description
`root_url`	string, null	required	A new root URL, or null to answer 404 on the bare domain.

Example request

curl -s -X PATCH "https://snip.link/v1/domains/go.example.com" \
  -H "Authorization: Bearer $SNIP_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Example response

{
  "domain": {
    "id": "dom_3c1f0a9e2b7d4c55",
    "hostname": "go.example.com",
    "status": "active",
    "detail": null,
    "cname_target": "customers.snip.link",
    "root_url": "https://example.com",
    "links": 42,
    "created_at": "2026-10-20T12:00:00.000Z"
  }
}

Response fields

Field	Type	Description
`domain`	Domain
`domain.id`	string	Stable id. Every domain route accepts it, or the hostname.
`domain.hostname`	string	The domain links live on, without a scheme.
`domain.status`	pending \| active \| failed	`pending` until the CNAME points at us and the certificate is issued, `active` once links on it answer, `failed` when verification gave up.
`domain.detail`	string, null	What a pending domain is waiting for, or why it failed. Null once active.
`domain.cname_target`	string	The DNS record to add at your DNS provider: a CNAME from the hostname to this target (customers.snip.link).
`domain.root_url`	string, null	Where the bare domain (https://go.example.com/) sends visitors. Null answers 404.
`domain.links`	integer	Links on this domain.
`domain.created_at`	string

Errors

Status	Meaning
400	The body or query is invalid. `details` names each field.
401	The API key is missing, malformed or revoked.
404	No domain by that id or hostname in this account.
429	Either the key exceeded its requests-per-second limit (honor Retry-After), or a daily or plan quota is used up (`details.reason`).

Back to the guide