# Set the custom domain

```http
PUT https://secure.yoprint.com/v1/api/store/{team_slug}/setting/custom_domain/update
```

- API version: v1
- Operation ID: `v1_public_setting_custom_domain_update`
- Section: Team settings › [Company settings](https://developer.yoprint.com/reference/company-settings.md)
- Web page: https://developer.yoprint.com/reference/company-settings/v1-setting-custom-domain-update/
- Authentication: `Authorization: Bearer YOUR_API_KEY`

Sets the domain your customer portal is served on, for example `shop.example.com` or a subdomain of `yoprintmerch.com`.

Point the domain to YoPrint with a CNAME record to `domain.yoprint.com`, then confirm with "Check a custom domain's DNS". This call does not check DNS.

Returns your company details with the new `custom_domain`.

## Permission

Needs the Manage Settings permission. The team owner always has it.

## Business rules

- It must be a valid domain name.
- Subdomains of `yoprint.com` are no longer allowed; use a subdomain of `yoprintmerch.com` instead.
- YoPrint's own domains and hosts are refused.
- Without the custom domain feature in your plan, only subdomains of `yoprintmerch.com` are allowed (`plan_limitation`).
- A domain another team uses is refused.

## Side effects

- Customer portal links use the new domain from now on.

## Path parameters

- `team_slug` (string, required): Your team slug, shown as Team ID next to your API key in Profile. Example `your-team`.

## Request body

Content type `application/json`, required.

Fields:

- `custom_domain` (string, required): The host, without `https://`: `shop.example.com`.

### Example request

```bash
curl -X PUT 'https://secure.yoprint.com/v1/api/store/your-team/setting/custom_domain/update' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'X-Yoprint-Decimal-Format: exact-v1' \
  -H 'Content-Type: application/json' \
  -d '{
    "custom_domain": "shop.example.com"
  }'
```

## Response

`200` Successful response.

Fields:

- `data` (object, required)
  - `custom_domain` (string | null, required): The host your customer portal is served on, or null.
  - `id` (string, required)
  - `name` (string, required)
  - `payment_gateway` (array of objects, required): The payment gateways your customers can pay through, with only their public identifiers (for example a Stripe publishable key). Empty when the plan has no payment integration.
  - `plan` (object, required): The team's YoPrint plan.
    - `active` (boolean, required): Whether the plan is active now.
    - `detail` (object, required): With a subscription: `name`, `status`, `active` and `need_to_select_plan`. On a trial or free plan: `id`, `name`, `archive`, `need_to_select_plan`, and on a trial `expire_at` and `status` (`active` or `expired`).
      - `active` (boolean, optional)
      - `archive` (boolean, optional)
      - `expire_at` (string (date-time) | null, optional)
      - `id` (string, optional)
      - `name` (string | null, optional): With a subscription, always `default`; otherwise the trial or free plan's name.
      - `need_to_select_plan` (boolean, optional): True when the team must choose a plan before it can go on.
      - `status` (string | null, optional)
    - `features` (object, required): What the plan allows: features, limits and integrations, keyed by name.
    - `type` (string, required): `paid` with a subscription; otherwise `trial` or `free`. One of: `"paid"`, `"trial"`, `"free"`.
  - `slug` (string, required): The `{team_slug}` in every path.
  - `timezone` (string, required)
  - `channel_id` (integer, optional): The team's number, used by YoPrint's live-update channel.
  - `customer_portal_bg` (string | null, optional): The customer portal background image, or null.
  - `dimension` (string | null, optional): Length unit: `m`, `cm`, `mm` or `in`.
  - `email` (string | null, optional)
  - `favicon_url` (string | null, optional): The customer portal favicon (the icon in the browser tab), or null when none is uploaded.
  - `ga_id` (string, optional): An analytics id: `YxPx` and the team's number (`channel_id`).
  - `logo_url` (string | null, optional)
  - `onboard_status` (string | null, optional)
  - `phone` (string | null, optional)
  - `phone_country` (string | null, optional)
  - `plan_region` (string | null, optional)
  - `printavo_importer_available` (boolean, optional)
  - `printavo_importer_enabled` (boolean, optional)
  - `seeded` (boolean, optional)
  - `tax_number` (string | null, optional)
  - `trial_expires_at` (string (date-time), optional)
  - `website` (string | null, optional)
  - `weight` (string | null, optional): Weight unit: `kg`, `g`, `lbs` or `oz`.
- `status` (integer, required)
- `success` (boolean, required)

Example response:

```json
{
  "data": {
    "channel_id": 1001,
    "custom_domain": "shop.example.com",
    "customer_portal_bg": null,
    "dimension": "in",
    "email": "alex@example.com",
    "favicon_url": null,
    "ga_id": "YxPx1001",
    "id": "OutVLW14xRJYLp",
    "logo_url": "https://example.com/logo.png",
    "name": "Northwind Apparel",
    "onboard_status": null,
    "payment_gateway": [],
    "phone": "+1 201 555 0123",
    "phone_country": "US",
    "plan": {
      "active": true,
      "detail": {
        "active": true,
        "name": "default",
        "need_to_select_plan": false,
        "status": "active"
      },
      "features": {
        "customer_portal": true,
        "user_limit": 5
      },
      "type": "paid"
    },
    "plan_region": "US",
    "printavo_importer_available": false,
    "printavo_importer_enabled": false,
    "seeded": true,
    "slug": "your-team",
    "tax_number": null,
    "timezone": "America/New_York",
    "trial_expires_at": "2026-01-15T00:00:00+00:00",
    "website": "https://example.com",
    "weight": "lbs"
  },
  "status": 200,
  "success": true
}
```

## Errors

- `401` The API key is missing or wrong (`unauthenticated`).
- `403` You are not allowed to do this. `api_access_not_in_plan`: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only `{"message": "Insufficient Permission"}`. Other refusals use the error envelope, with `unauthorized` or `user_is_not_authorized`.
  - When: Your role lacks Manage Settings. The body is `{"message": "Insufficient Permission"}`, without the error envelope. Fix: Use the key of a member whose role has Manage Settings, or the owner's.
- `404` Not found. `page_not_found`: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. `code: null`, with a message that starts "No query results for": there is no record with that id.
- `422` The request was refused and changed nothing. `validation_failed` lists what to fix in `error.fields`; other codes name a business rule, explained in `error.message`. A few checks answer with only `{"message": "..."}`. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer `connect_timeout` ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.
  - When: `custom_domain` is missing or not a string (`validation_failed`). Fix: Send the host as a string. The domain can't be cleared through this call.
  - When: The domain is not valid (`domain_invalid`), not allowed (`domain_validation`), in use by another team (`domain_validation`), or beyond your plan (`plan_limitation`). Fix: Read `error.message`, then choose another domain or upgrade the plan.

## Related

- [Check a custom domain is allowed](https://developer.yoprint.com/reference/company-settings/v1-setting-custom-domain-check.md): `PUT /v1/api/store/{team_slug}/setting/custom_domain/check`
- [Check a custom domain's DNS](https://developer.yoprint.com/reference/company-settings/v1-setting-custom-domain-check-setup.md): `PUT /v1/api/store/{team_slug}/setting/custom_domain/check_setup`
- [Get your company details](https://developer.yoprint.com/reference/company-settings/v1-setting-detail-show.md): `GET /v1/api/store/{team_slug}/setting/detail`