Document the endpoint for deleting an org

2018-06-14 15:28:54 -04:00
parent 56628996b7
commit 2765afc830
1 changed files with 21 additions and 0 deletions
@@ -331,6 +331,27 @@ Content-Type: application/json
 {"message":"Organization updated"}
 ```

+## Delete Organisation
+
+`DELETE /api/orgs/:orgId`
+
+**Example Request**:
+
+```http
+DELETE /api/orgs/1 HTTP/1.1
+Accept: application/json
+Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
+```
+
+**Example Response**:
+
+```http
+HTTP/1.1 200
+Content-Type: application/json
+
+{"message":"Organization deleted"}
+```
+
 ## Get Users in Organisation

 `GET /api/orgs/:orgId/users`