Add an allowed domain

POST https://chat.zulip.org/api/v1/realm/domains

Add a domain to the set of allowed domains configured in the organization for user account email addresses.

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

Usage examples

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

Parameters

Response

Return values

• new_domain: (integer | string)[]

  An array containing the ID of the newly added domain and the submitted domain name string.

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": "",
    "new_domain": [
        1,
        "example.com"
    ],
    "result": "success"
}