Revoke a reusable invitation link
DELETE https://chat.zulip.org/api/v1/invites/multiuse/{invite_id}
Revoke a reusable invitation link.
A user can only revoke invitations that they can
manage.
Changes: Prior to Zulip 8.0 (feature level 209), only organization
administrators were able to create and revoke reusable invitation links.
Usage examples
#!/usr/bin/env python3
import zulip
# Pass the path to your zuliprc file here.
client = zulip.Client(config_file="~/zuliprc")
# Revoke reusable invitation link.
result = client.call_endpoint(url=f"/invites/multiuse/{invite_id}", method="DELETE")
print(result)
curl -sSX DELETE https://chat.zulip.org/api/v1/invites/multiuse/1 \
-u BOT_EMAIL_ADDRESS:BOT_API_KEY
Parameters
invite_id integer required in path
Example: 1
The ID of the reusable invitation link to be revoked.
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"
}
A typical failed JSON response for an invalid invitation link ID:
{
"code": "BAD_REQUEST",
"msg": "No such invitation",
"result": "error"
}
A typical failed JSON response for when the invitation link has already
been revoked:
{
"code": "BAD_REQUEST",
"msg": "Invitation has already been revoked",
"result": "error"
}