---
title: "Set Custom Domain"
method: PUT
path: "/api/branding/custom-domain"
tags: ["branding"]
---

# Set Custom Domain

`PUT /api/branding/custom-domain`

## Request

- Base URL: `https://zsign.io` (the document declares no server; this is the origin it was published from)
- URL: `https://zsign.io/api/branding/custom-domain`
- Auth: HTTP bearer

Set or update custom domain.

## Request body

- CustomDomainUpdate
  - `domain` string, required

## Response `200`

Successful Response

- BrandingResponse
  - `id` string, uuid, required
  - `user_id` string, uuid, required
  - `company_name` string, nullable, required
  - `logo_url` string, nullable, required
  - `primary_color` string, required
  - `custom_domain` string, nullable, required
  - `custom_domain_verified` boolean, required
  - `custom_domain_verified_at` string, date-time, nullable, required
  - `custom_domain_render_registered` boolean
  - `custom_domain_target` string, nullable
  - `custom_domain_a_record` string, nullable
  - `badge_removed` boolean
  - `embed_origins` string[]
  - `white_label` WhiteLabelStatus
    - `active` boolean, required
    - `status` string, nullable
    - `current_period_end` string, date-time, nullable
    - `price_cents` integer, required
    - `monthly_credits` integer, required
  - `sender_domain` string, nullable
  - `sender_domain_verified` boolean
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required

## Other responses

- `422`: Validation Error

---

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