Test welcome bot custom message

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

Sends a test Welcome Bot message with custom text to the acting administrator. This allows administrators to preview how the welcome message will appear when received by new users upon joining the organization.

Changes: New in Zulip 11.0 (feature level 416).

Usage examples

#!/usr/bin/env python

import zulip

# The user for this zuliprc file must be an organization administrator
client = zulip.Client(config_file="~/zuliprc-admin")

# Send a test welcome bot custom message with the provided text.
request = {"welcome_message_custom_text": "Custom Welcome Message Text"}
result = client.call_endpoint(
    "/realm/test_welcome_bot_custom_message", method="POST", request=request
)
print(result)

curl -sSX POST https://chat.zulip.org/api/v1/realm/test_welcome_bot_custom_message \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY \
    --data-urlencode 'welcome_message_custom_text=Welcome to Zulip! We'"'"'re excited to have you on board.'

Parameters

Response

Return values

• message_id: integer

  The message_id of the test welcome bot custom message.

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:

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