Follow user api

This API endpoint allows the authenticated user to follow another user by sending a POST request with the target user's username.

System will return not found error if target user is not found.

Path Parameters

username string required

target user's username

Query Parameters

client_auth_token string required

Client API token

Header Parameters

access-token string required

user access token

client string required

client access token

expiry string required
timestamp of access token expiry date
Example: 1537100004
token-type string required
Default value: Bearer
token type
Example: Bearer
uid string required
user uid
Example: user@quranreflect.com

Responses

• 200
• 401
• 404

---

Successful response

Response Headers

application/json

Schema

Example (from schema)

default

already following

Example

---

Schema

followed boolean

{
  "followed": true
}

{
  "followed": true
}

{
  "success": false,
  "followed": true,
  "message": "@user is already followed by you."
}

{
  "success": true
}

Unauthorized response, api will respond with this 401 eithr user is not logged in or do not have permission to perform some action. Like creating a post in a room, but user is not member of room.

System will also return 401 if api token is missing or invlaid.

application/json

Schema

Example (from schema)

not logged in

missing or invalid api key

---

Schema

errors string[]
status integer

Default value: 401

success boolean

Default value: false

{
  "errors": [
    "string"
  ],
  "status": 401,
  "success": false
}

{
  "errors": [
    "You need to sign in or sign up before continuing."
  ],
  "success": false
}

{
  "message": "You don't have permission!",
  "status": 401,
  "success": false
}

Not Found

application/json

Schema

Example (from schema)

Not found

---

Schema

success boolean
message string

{
  "success": true,
  "message": "string"
}

{
  "success": false,
  "message": "Invalid User"
}

Loading...