Skip to content
YoPrintDevelopers

Set the custom domain

Open .md

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

v1Operation ID v1_public_setting_custom_domain_update

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_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.

  • dataobjectrequired
    Child fields (25)
    • custom_domainstring | nullrequired

      The host your customer portal is served on, or null.

    • idstringrequired
    • namestringrequired
    • payment_gatewayarray of objectsrequired

      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.

    • planobjectrequired

      The team's YoPrint plan.

      Child fields (4)
      • activebooleanrequired

        Whether the plan is active now.

      • detailobjectrequired

        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).

        Child fields (7)
        • activeboolean
        • archiveboolean
        • expire_atstring (date-time) | null
        • idstring
        • namestring | null

          With a subscription, always default; otherwise the trial or free plan's name.

        • need_to_select_planboolean

          True when the team must choose a plan before it can go on.

        • statusstring | null
      • featuresobjectrequired

        What the plan allows: features, limits and integrations, keyed by name.

      • typestringrequired

        paid with a subscription; otherwise trial or free.

        • One of: "paid", "trial", "free"
    • slugstringrequired

      The {team_slug} in every path.

    • timezonestringrequired
    • channel_idinteger

      The team's number, used by YoPrint's live-update channel.

    • customer_portal_bgstring | null

      The customer portal background image, or null.

    • dimensionstring | null

      Length unit: m, cm, mm or in.

    • emailstring | null
    • favicon_urlstring | null

      The customer portal favicon (the icon in the browser tab), or null when none is uploaded.

    • ga_idstring

      An analytics id: YxPx and the team's number (channel_id).

    • logo_urlstring | null
    • onboard_statusstring | null
    • phonestring | null
    • phone_countrystring | null
    • plan_regionstring | null
    • printavo_importer_availableboolean
    • printavo_importer_enabledboolean
    • seededboolean
    • tax_numberstring | null
    • trial_expires_atstring (date-time)
    • websitestring | null
    • weightstring | null

      Weight unit: kg, g, lbs or oz.

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

AI agents: read /llms.txt; add .md to any page URL for its Markdown. Guides and concepts in one file: /llms-full.txt.

Download the OpenAPI specSupport: support@yoprint.comyoprint.com