Company

Check whether a sub URL is free

Tells you whether a slug could be claimed as the company's sub URL, without claiming it.

POST

https://api.portal.magicdoor.com/company-app/companies/sub-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

urlstringrequired

The slug to check, 3 to 150 characters. Lower-case letters and digits, then letters, digits, hyphens or underscores.

Response

200 · Whether the slug is available.

isValidboolean

True when the slug 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/sub-url/validate' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "pine-ridge"
}'

Body

{
  "url": "pine-ridge"
}

Response

{
  "isValid": true
}