Update store domains

PUT https://app.ecwid.com/api/v3/{storeId}/domains

Required access scopes

Your app must have the following access scopes to make this request: update_store_profile, buy_domains

Path params

All path params are required.

Param
Type
Description

storeId

number

Ecwid store ID.

Headers

The Authorization header is required.

Header
Format
Description

Authorization

Bearer secret_ab***cd

Access token of the application.

Request JSON

A JSON object with the following fields:

Field
Type
Description

instantSiteDomain

Details for the currently enabled store domain.

purchasedDomains

array of objects purchasedDomains

List with details for each domain bought for the store.

instantSiteDomain

Field
Type
Description

ecwidSubdomain

string

Subdomain of the default Instant Site URL.

thirdPartyVendorDomain

string

Custom domain specified in the Control Panel settings. Has the same value as the customDomain in the Instant Site Info.

purchasedDomains

Field
Type
Description

connectedToInstantSite

boolean

Shows if this domain is connected to Instant Site. Available values: true, false

primaryDomain

boolean

Shows if this domain is the main one. Available values: true, false

autorenew

boolean

Shows if automatic renewal charge is enabled. Available values: true, false

Response JSON

A JSON object with the following fields:

Field
Type
Description

updateCount

number

The number of updated items that defines if the request was successful. One of: 1 if the item was updated, 0 if the item was not updated.

Last updated

Was this helpful?