Skip to main content
POST
/
api
/
v1
/
hub
/
shop
/
{shopId}
/
domains
Add Domain
curl --request POST \
  --url https://api.getscale.ng/api/v1/hub/shop/{shopId}/domains \
  --header 'Content-Type: application/json' \
  --header 'X-Shop-API-Key: <x-shop-api-key>' \
  --data '
{
  "domain": "<string>",
  "type": "<string>"
}
'
{
  "status": "success",
  "message": "Domain added successfully",
  "data": {
    "id": 2,
    "domain": "myshop.com",
    "type": "custom",
    "isPrimary": false,
    "isActive": false
  }
}
Registers a new subdomain (ending with .getscale.ng) or a fully qualified custom domain.

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

​
Request Body (JSON)

​
domain
string
required
Subdomain or custom domain name (e.g. myshop.com or custom.getscale.ng).
​
type
string
required
subdomain or custom.
{
  "status": "success",
  "message": "Domain added successfully",
  "data": {
    "id": 2,
    "domain": "myshop.com",
    "type": "custom",
    "isPrimary": false,
    "isActive": false
  }
}