# Check a custom domain's DNS

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

- API version: v1
- Operation ID: `v1_public_setting_custom_domain_check_setup`
- 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-check-setup/
- Authentication: `Authorization: Bearer YOUR_API_KEY`

Checks that the domain has a CNAME record pointing to `domain.yoprint.com`, using public DNS. Subdomains of `yoprintmerch.com` (and of `yoprint.com`) always pass.

A success is remembered, so later checks of the same domain pass without a lookup. Send `refresh: true` to look again.

The response has no data when the record is right.

## Permission

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

## Side effects

- Makes a DNS lookup through public resolvers.

## 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`.
- `refresh` (boolean, optional): Ignore a remembered success and look the DNS up again. Default `false`.

### Example request

```bash
curl -X PUT 'https://secure.yoprint.com/v1/api/store/your-team/setting/custom_domain/check_setup' \
  -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",
    "refresh": true
  }'
```

## Response

`200` Successful response.

Fields:

- `data` (null, required)
- `status` (integer, required)
- `success` (boolean, required)

Example response:

```json
{
  "data": null,
  "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: No CNAME record points to `domain.yoprint.com` yet, or the lookup failed: `error.code` `domain_not_setup`. Fix: Add the record at your DNS provider and try again later; DNS changes can take a while to spread.
  - When: `custom_domain` is missing, or `refresh` is not a boolean (`validation_failed`). Fix: Send the host as a string.

## Notes

- Setting the domain doesn't check DNS. Check it before or after, so customers can reach the portal on it.

## Related

- [Set the custom domain](https://developer.yoprint.com/reference/company-settings/v1-setting-custom-domain-update.md): `PUT /v1/api/store/{team_slug}/setting/custom_domain/update`
- [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`