add delete user docs

botisimo · Nov 23, 2022 · c02cb6a · c02cb6a
1 parent 4ee5ef3
commit c02cb6a
Showing 1 changed file with 26 additions and 0 deletions.
diff --git a/docs/loyalty/admin-documentation/user.rst b/docs/loyalty/admin-documentation/user.rst
@@ -3,6 +3,7 @@ User API
 
 - `Get User`_
 - `Add Points`_
+- `Delete User`_
 
 Get User
 --------
@@ -108,3 +109,28 @@ Field                              Type     Description
 ================================== ======== =================================================================================
 success                            boolean  always true
 ================================== ======== =================================================================================
+
+Delete User
+-----------
+
+Delete a user
+
+- **DELETE** /user/:id
+
+Request
+
+.. code-block:: js
+
+   const response = await axios.delete('https://botisimo.com/api/v1/loyalty/admin/user/1', {
+      headers: {
+         'client-id': 'xxxxx-xxxxx-xxxxx-xxxxx',
+      },
+   });
+
+Response
+
+================================== ======== =================================================================================
+Field                              Type     Description
+================================== ======== =================================================================================
+success                            boolean  always true
+================================== ======== =================================================================================