Update an allowed domain

This endpoint is only available to organization owners.

PATCH https://chat.zulip.org/api/v1/realm/domains/{domain}

Update whether subdomains are allowed in user account email addresses for the specified domain.

Changes: Prior to Zulip 6.0 (feature level 143), organization administrators who were not owners could access this endpoint.

Usage examples

The -u line implements HTTP Basic authentication. See the Authorization header documentation for how to get those credentials for Zulip users and bots.

curl -sSX PATCH https://chat.zulip.org/api/v1/realm/domains/example.com \
    -u EMAIL_ADDRESS:API_KEY \
    --data-urlencode allow_subdomains=true

Parameters

domain string required in path

Example: "example.com"

The domain to update.


allow_subdomains boolean required

Example: true

Whether subdomains are allowed for this domain.


Response

Example response(s)

Changes: As of Zulip 7.0 (feature level 167), if any parameters sent in the request are not supported by this endpoint, a successful JSON response will include an ignored_parameters_unsupported array.

A typical successful JSON response may look like:

{
    "msg": "",
    "result": "success"
}