---
title: "Put Help Site Domain"
method: PUT
path: "/api/v1/help-site/domain"
tags: ["authed"]
---

# Put Help Site Domain

`PUT /api/v1/help-site/domain`

## Request

- Base URL: `https://api.teaflask.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.teaflask.com/api/v1/help-site/domain`
- Auth: none declared

## Request body

- ClaimDocsDomainRequest
  - `hostname` string, required

## Response `200`

Successful Response

- HelpSiteDomainStatusResponse: The domain rows' whole working set. hostname None is the empty state (no custom domain), never a 404. The two CNAME records the customer owes: the ACM validation record (which must STAY in place for certificate renewals) and hostname → cname_target.
  - `hostname` string, nullable, required
  - `status` 'pending_dns' | 'validating' | 'issuing' | 'active' | 'failed', required: A claimed docs hostname's walk to serving: the customer still owes the DNS records (pending_dns), ACM saw the validation record and is verifying (validating), the certificate issued and the CloudFront distribution is deploying (issuing), the edge answers (active), or provisioning gave up (failed). Terminal states are active and failed; everything else converges under the provisioning workflow.
  - `validation_record_name` string, nullable, required
  - `validation_record_value` string, nullable, required
  - `cname_target` string, nullable, required
  - `verified_at` string, date-time, nullable, required
  - `last_checked_at` string, date-time, nullable, required

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not found
- `405`: Method not allowed
- `422`: Validation error
- `500`: Internal server error

## Changes

- **2026-11-03** `c6ac9fd6657f`: 6 info
  - removed the `STEEP_LEARNING_DISABLED` enum value from the `error/code` response property for the response status `401`
  - removed the `STEEP_LEARNING_DISABLED` enum value from the `error/code` response property for the response status `403`
  - removed the `STEEP_LEARNING_DISABLED` enum value from the `error/code` response property for the response status `404`
  - removed the `STEEP_LEARNING_DISABLED` enum value from the `error/code` response property for the response status `405`
  - …2 more

[Operation history](https://skmtc.dev/teaflask/apis/teaflask-api/changes/api/v1/help-site/domain/put.md)

---

[API](https://skmtc.dev/teaflask/apis/teaflask-api.md) - [All operations](https://skmtc.dev/teaflask/apis/teaflask-api/llms.txt) - [OpenAPI document](https://skmtc.dev/teaflask/apis/teaflask-api/revisions/c6ac9fd6657f?raw)