Delete a draft

DELETE https://shipyard.zulipchat.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

curl -sSX DELETE https://shipyard.zulipchat.com/api/v1/drafts/1 \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY

Parameters

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