api/docs/user/follow.md

31 lines
1.0 KiB
Markdown

# `/user/follow` - POST
Let the authenticated account follow the user.
## Urlencoded Parameters
You have to set one parameter.
Setting none or two parameters will result in a _400 Bad Request_ Response.
| Parameter | Description |
|-----------|--------------------------------------------------------------------|
| name | The username of the user on which the operation will be performed. |
| id | The userid of the user on which the operation will be performed. |
## HTTP Headers
| Header | Content |
|---------------|--------------------|
| Authorization | `Bearer {token}` |
## Responses
### 200 - Success
Successfully followed the user.
### 208 - Already Reported
You already follow the user.
### 400 - Error: Bad Request
The request was malformed.
### 401 - Error: Unauthorized
The provided auth token doesn't allow you to perform this operation.
### 403 - Error: Forbidden
Blocked for security reasons.
### 404 - Error: Not Found
The user wasn't found.