Add routes to (un)block a user

diaspora · Mar 20, 2020 · b9e2a7d · b9e2a7d
1 parent f1bdd57
commit b9e2a7d
Showing 1 changed file with 46 additions and 0 deletions.
diff --git a/_routes/users.md b/_routes/users.md
@@ -293,3 +293,49 @@ GET /api/v1/users/:person_guid/photos
 | Status code | Error reason                               |
 | ----------- | ------------------------------------------ |
 | 404         | User with provided guid could not be found |
+
+## Block a user
+
+Required API scope: `contacts:modify`.
+
+### Request
+
+~~~
+POST /api/v1/users/:person_guid/block
+~~~
+
+### Response
+
+~~~
+Status: 201 Created
+~~~
+
+### Errors
+
+| Status code | Error reason                               |
+| ----------- | ------------------------------------------ |
+| 404         | User with provided guid could not be found |
+| 409         | Block already exists                       |
+
+## Unblock a user
+
+Required API scope: `contacts:modify`.
+
+### Request
+
+~~~
+DELETE /api/v1/users/:person_guid/block
+~~~
+
+### Response
+
+~~~
+Status: 204 No Content
+~~~
+
+### Errors
+
+| Status code | Error reason                               |
+| ----------- | ------------------------------------------ |
+| 404         | User with provided guid could not be found |
+| 410         | Block doesn't exist                        |