---
title: "Register a portal domain"
method: POST
path: "/v1/account/domains/portal"
tags: ["Account"]
---

# Register a portal domain

`POST /v1/account/domains/portal`

## Request

- Base URL: `https://api.briefgate.dev`
- URL: `https://api.briefgate.dev/v1/account/domains/portal`
- Auth: HTTP bearer

Register the hostname clients open the portal on. The customer points it at `cname_target` with a CNAME; the certificate is issued once that resolves.

## Request body

- object
  - `domain` string, required

## Response `201`

Registered, pending CNAME verification

- object
  - `domain` string
  - `verified` boolean
  - `cname_target` string

## Other responses

- `400`: Invalid request — malformed body or query parameters
- `401`: Missing or invalid API key
- `402`: The account's plan does not include this — `plan_required` — or a quota is exhausted
- `409`: Domain already claimed by another account

---

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