isSubdomainAvailable

Public: no authentication required.

Tells whether a subdomain is well formed and not yet taken by an organization. Needs no sign-in.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query IsSubdomainAvailable($subdomain: String!) {
  isSubdomainAvailable(subdomain: $subdomain)
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query IsSubdomainAvailable($subdomain: String!) {\n  isSubdomainAvailable(subdomain: $subdomain)\n}",
  "variables": {
    "subdomain": "string"
  }
}
EOF

Variables:

{
  "subdomain": "string"
}

Response:

{
  "data": {
    "isSubdomainAvailable": true
  }
}

isSubdomainAvailable(
  subdomain: String!
): Boolean!

Arguments

isSubdomainAvailable.subdomain ● String! non-null scalar

The subdomain to check.

Type

Boolean scalar

The Boolean scalar type represents true or false.