---
title: "CreateCustomDomain"
description: "Add a custom domain"
canonical: "https://pgbeam.com/docs/go-sdk/projects/createCustomDomain"
last-updated: "2026-09-14T19:37:21.000Z"
---

# CreateCustomDomain

> Add a custom domain

URL: https://pgbeam.com/docs/go-sdk/projects/createCustomDomain

Registers a new custom domain for the project. Returns DNS verification instructions. Requires a Scale or Enterprise plan.

## Usage

## Parameters

Parameter

Type

Required

Description

ctx

`context.Context`

Yes

Request context

projectID

`string`

Yes

Unique project identifier (prefixed, e.g. prj\_xxx).

req

`pgbeam.CreateCustomDomainRequest`

Yes

Request body

req.Domain

`string`

Yes

The custom domain name to add (e.g., db.example.com).

## Response

`(*pgbeam.CustomDomain, error)`: custom domain created.

## Example

## Errors

Status

Description

400

The request was rejected. `code` is `INVALID_INPUT`, and `errors` names the offending fields when the failure was a validation one.

401

Missing or invalid authentication. `code` is `UNAUTHORIZED`.

403

Custom domains require a Scale or Enterprise plan.

404

The resource does not exist, or the caller is not entitled to know that it does. `code` is `NOT_FOUND`.

409

The request conflicts with the current state. `code` distinguishes the cases: `RESOURCE_EXISTS` for a name or value already in use, `INVALID_STATE` for a resource that is no longer in a state that allows the operation, and `IDEMPOTENCY_KEY_REUSED` for a retry whose body does not match the request the key was first used for.

413

The request body exceeds the 2 MB limit. `code` is `PAYLOAD_TOO_LARGE`.

415

The request body is not JSON, or carries a body without declaring a Content-Type. `code` is `UNSUPPORTED_MEDIA_TYPE`.

429

Rate limited. `code` is `RATE_LIMITED`.

500

The request failed for a reason on our side. `code` is `INTERNAL_ERROR`. Quote `request_id` when reporting it.