Remove a code playground

DELETE https://ik1-133-73042.vs.sakura.ne.jp/api/v1/realm/playgrounds/{playground_id}

Remove a code playground previously configured for an organization.

Changes: New in Zulip 4.0 (feature level 49).

Usage examples

#!/usr/bin/env python3

import zulip

# Pass the path to your zuliprc file here.
client = zulip.Client(config_file="~/zuliprc")

# Remove the playground with ID 1
result = client.call_endpoint(url="/realm/playgrounds/1", method="DELETE")
print(result)

curl -sSX DELETE https://ik1-133-73042.vs.sakura.ne.jp/api/v1/realm/playgrounds/1 \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY

Parameters

playground_id integer required in path

Example: 1

The ID of the playground that you want to remove.


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"
}