Company

Check whether a custom domain is free

Tells you whether a domain could be used as the company's custom portal domain, without claiming it.

POST

https://api.portal.magicdoor.com/company-app/companies/custom-url/validate

Authorization

Authorizationstringrequired

Bearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.

Body

application/json

domainstring

The domain to check, for example portal.pineridge.example.

Response

200 · Whether the domain is available.

isValidboolean

True when the domain is free and well-formed, false when it is not.

401 · The access token is missing, expired, or not valid for this company.

Request

curl --request POST \
  --url 'https://api.portal.magicdoor.com/company-app/companies/custom-url/validate' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "domain": "portal.pineridge.example"
}'

Body

{
  "domain": "portal.pineridge.example"
}

Response

{
  "isValid": true
}