Delete a draft

Note: The Zulip web application implementation of this feature is pending. For information about the current state of this API and the feature's development, reach out in our development community.

DELETE https://your-org.collaborychat.com/api/v1/drafts/{draft_id}

Delete a single draft from the server. The deletion will be automatically synchronized to other clients via a drafts event.

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 DELETE https://your-org.collaborychat.com/api/v1/drafts/1 \
    -u EMAIL_ADDRESS:API_KEY

Parameters

draft_id integer required in path

Example: 1

The ID of the draft you want to delete.


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 when no draft exists with the provided ID:

{
    "code": "BAD_REQUEST",
    "msg": "Draft does not exist",
    "result": "error"
}