From f2a71a333b13ba05bedfdd14bd9e9ae2e44d74e9 Mon Sep 17 00:00:00 2001 From: Grey Himmel Date: Thu, 8 Aug 2019 11:40:13 -0400 Subject: [PATCH] Document member DELETE route Add API documentation to the new DELETE route for members --- docs/3-api-documentation.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/docs/3-api-documentation.md b/docs/3-api-documentation.md index 3f8a5ec4..8644eac5 100644 --- a/docs/3-api-documentation.md +++ b/docs/3-api-documentation.md @@ -326,6 +326,17 @@ Edits a member's information. Missing fields will be set to `null`. Will return } ``` +### DELETE /m/\ +**Requires authentication.** + +Deletes a member from the database. Be careful as there is no confirmation and the member will be deleted immediately. Member must (obviously) belong to your own system. + +#### Example request + DELETE https://api.pluralkit.me/v1/m/qwert + +#### Example response +(`204 No Content`) + ### GET /a/\ Queries a system by its linked Discord account ID (17/18-digit numeric snowflake). Returns `404 Not Found` if the account doesn't have a system linked. @@ -389,4 +400,4 @@ Looks up a proxied message by its message ID. Returns `404 Not Found` if the mes * 2019-07-10 **(v1)** * First specified version * (prehistory) - * Initial release \ No newline at end of file + * Initial release