SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester

Add a custom domain and get the DNS records to create

Only after the first publish. Give the person the dns_records to add at their registrar, then call verify. 400 domains_unavailable in the sandbox.

POSThttps://app.softsolz.uk/api/v1/services/site-builder/projects/{id}/domains

Recent Requests

Kept only in this browser
TimeStatusTook
Send a request with Try it to see it here.

Path Params

idstringrequired

Headers

Authorizationstringrequired

Bearer token: Bearer sk_live_... (or sk_test_... for sandbox). A login token will not work here.

Idempotency-Keystring

Optional idempotency key for safe retries.

Body Params

domainstringrequired

Hostname such as www.example.com or example.com.

Response

Response Body

idintegerDomain id.
domainstringHostname.
statusstringpending until DNS is verified.
dns_recordsarray of objectsRecords to create at the registrar: { type, name, value }.
last_checked_atstring | nullLast verification attempt.
verified_atstring | nullWhen DNS verified.
created_atstringAdded at.

Request

curl --request POST \
--url https://app.softsolz.uk/api/v1/services/site-builder/projects/{id}/domains \
--header 'Authorization: Bearer sk_live_your_key' \
--header 'Content-Type: application/json' \
--data '{
"domain": "www.northwindbakery.co.uk"
}'

Credentials

Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.

Response · 201

{
"data": {
"id": 3,
"domain": "www.northwindbakery.co.uk",
"status": "pending",
"dns_records": [
{
"type": "CNAME",
"name": "www",
"value": "cname.vercel-dns.com"
}
],
"last_checked_at": "2026-09-17T09:30:00.000Z",
"verified_at": "2026-09-17T09:30:00.000Z",
"created_at": "2026-09-17T09:30:00.000Z"
}
}