addOrganizationDomain

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

Adds a custom hostname for the portal. The name must be a valid hostname that is not reserved, not on the platform's own domain and not registered by any organization. It starts as pending until its setup completes. 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 AddOrganizationDomain($input: AddOrganizationDomainInput!) {
  addOrganizationDomain(input: $input) {
    id
    status
    createdAt
    hostname
    isPrimary
    kind
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation AddOrganizationDomain($input: AddOrganizationDomainInput!) {\n  addOrganizationDomain(input: $input) {\n    id\n    status\n    createdAt\n    hostname\n    isPrimary\n    kind\n  }\n}",
  "variables": {
    "input": {
      "hostname": "string"
    }
  }
}
EOF

Variables:

{
  "input": {
    "hostname": "string"
  }
}

Response:

{
  "data": {
    "addOrganizationDomain": {
      "id": "id",
      "status": "ACTIVE",
      "createdAt": "2025-01-15T00:00:00Z",
      "hostname": "string",
      "isPrimary": true,
      "kind": "CUSTOM"
    }
  }
}

addOrganizationDomain(
  input: AddOrganizationDomainInput!
): OrganizationDomain!

Arguments

addOrganizationDomain.input ● AddOrganizationDomainInput! non-null input

The hostname to add.

Type

OrganizationDomain object

A host name the organization's portal answers on.