API EndpointsUsersfollowsCreate Follow

Follow User

Endpoint

URL: /:projectId/users/:userId/follow

Method: POST

Authentication Required: Yes


Description

Create a follow relationship between the authenticated user and another user.


Request

Path Parameters

ParameterTypeRequiredDescription
userIdstringYesID of the user to follow.

Headers

HeaderTypeRequiredDescription
AuthorizationstringYesBearer token for authentication.

Body Parameters

None

Example Request

POST /proj1234/users/abcd123/follow
Authorization: Bearer <ACCESS_TOKEN>

Response

Success Response (201 Created)

(No response body)

Error Responses

Self-Follow Attempt (400 Bad Request)

{
  "error": "A user cannot follow themselves.",
  "code": "follow/self-follow"
}

User Not Found (404 Not Found)

{
  "error": "One or both users involved in the follow do not exist.",
  "code": "follow/user-not-found"
}

Already Following (409 Conflict)

{
  "error": "Follow relationship already exists.",
  "code": "follow/already-exists"
}

Server Error (500 Internal Server Error)

{
  "error": "Internal server error.",
  "code": "follow/server-error",
  "details": "<Error message>"
}

Notes

  • This endpoint creates a Follow relationship in the database.
  • A notification of type new-follow is triggered after the follow is created.
  • Users cannot follow themselves.
  • Duplicate follow requests are blocked with a 409 status.