SetWebstoreCustomDomainRequestDto

Represents a request to attach a custom domain to a webstore.

domainstringRequired

The domain to serve the webstore from, without a scheme (e.g., store.example.com).

verification_typeenumRequired

Specifies how ownership of a webstore's custom domain is proven. The only officially supported method is the 'http' method.

Possible enum values

invalid
No verification type specified. This value is typically used as a default or uninitialized state.
http
Ownership is proven by serving a token file over HTTP from the domain. This is the RECOMMENDED way to prove ownership, and is used by the dashboard.
txt
Ownership is proven by publishing a DNS TXT record on the domain.
email
Ownership is proven by following a link sent to an administrative address on the domain.
cname
Ownership is proven by publishing a DNS CNAME record on the domain.

Example

{
  "domain": "string",
  "verification_type": "invalid"
}