removeOrganizationDomain

Requires at least one of the permissions settings:organization:update or settings:tenant:update.

Removes a custom hostname and releases it. The platform hostname cannot be removed. Returns true on success. Needs settings:organization:update, or settings:tenant:update.

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

mutation RemoveOrganizationDomain($id: ID!) {
  removeOrganizationDomain(id: $id)
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation RemoveOrganizationDomain($id: ID!) {\n  removeOrganizationDomain(id: $id)\n}",
  "variables": {
    "id": "id"
  }
}
EOF

Variables:

{
  "id": "id"
}

Response:

{
  "data": {
    "removeOrganizationDomain": true
  }
}

removeOrganizationDomain(
  id: ID!
): Boolean!

Arguments

removeOrganizationDomain.id ● ID! non-null scalar

The ID of the domain.

Type

Boolean scalar

The Boolean scalar type represents true or false.