Skip to main content
PATCH
/
api
/
v1
/
hub
/
shop
/
{shopId}
/
domains
/
{domainId}
Update Domain Settings
curl --request PATCH \
  --url https://api.getscale.ng/api/v1/hub/shop/{shopId}/domains/{domainId} \
  --header 'Content-Type: application/json' \
  --header 'X-Shop-API-Key: <x-shop-api-key>' \
  --data '
{
  "isActive": true,
  "isPrimary": true
}
'
{
  "status": "success",
  "message": "Domain settings updated successfully"
}
Modifies settings for custom domains, such as marking a domain as the primary checkout host or toggling active routing states.

​
Authorizations

​
X-Shop-API-Key
string
required
Your Secret API Key (sk_live_... or sk_test_...) generated from the Developer dashboard. Must be kept secret.

​
Path Parameters

​
shopId
string
required
The unique UUID of the shop.
​
domainId
number
required
The unique ID of the domain record.

​
Request Body (JSON)

​
isActive
boolean
Toggle whether traffic is routed to this domain.
​
isPrimary
boolean
Set as the primary root address of the storefront.
{
  "status": "success",
  "message": "Domain settings updated successfully"
}