Check a custom domain is allowed

PUT/v1/api/store/{team_slug}/setting/custom_domain/check

v1Operation ID v1_public_setting_custom_domain_check

Runs the same checks as "Set the custom domain" without saving anything. It does not look at DNS; use "Check a custom domain's DNS" for that. When the domain is allowed, the answer is 200 with data: null.

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.

Path parameters

• team_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team

Request body

application/json, required.

• custom_domainstringrequired

  The host, without https://: shop.example.com.

Response

200Successful response.

• datanullrequired
• statusintegerrequired
• successbooleanrequired

Errors

• 401The API key is missing or wrong (unauthenticated).

• 403You 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.

• 404Not 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.

• 422The 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

• PUTSet the custom domain/v1/api/store/{team_slug}/setting/custom_domain/update
• PUTCheck a custom domain's DNS/v1/api/store/{team_slug}/setting/custom_domain/check_setup

Example request

curl

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

Example response 200

Response

{
  "data": null,
  "status": 200,
  "success": true
}