liz/PluralKit
liz/PluralKit
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Document member DELETE route

Browse Source 
Add API documentation to the new DELETE route for members
This commit is contained in:
Grey Himmel 2019-08-08 11:40:13 -04:00 committed by Astrid
parent 13fe0b7ef9
commit f2a71a333b
1 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/3-api-documentation.md
View File

@ -326,6 +326,17 @@ Edits a member's information. Missing fields will be set to `null`. Will return
} }
``` ```
### DELETE /m/\<id>
**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/\<id> ### GET /a/\<id>
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. 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)** * 2019-07-10 **(v1)**
* First specified version * First specified version
* (prehistory) * (prehistory)
* Initial release * Initial release