API EndpointsRelationshipsCreate Follow

Create Follow Relationship

Endpoint

URL: /:projectId/follows/

Method: POST

Authentication Required: Yes (Access Token in Authorization Header)


Description

This endpoint allows an authenticated user to follow another user within a specified project. If the follow relationship already exists, an error is returned. A user cannot follow themselves.


Request

Path Parameters

ParameterTypeRequiredDescription
projectIdstringYesThe project ID associated with the request.

Headers

HeaderTypeRequiredDescription
AuthorizationstringYesBearer token for authentication.

Body Parameters

ParameterTypeRequiredDescription
followedIdstringYesThe ID of the user to follow.

Example Request

POST /12345/follows/
Content-Type: application/json
Authorization: Bearer <ACCESS_TOKEN>
 
{
  "followedId": "67890"
}

Response

Success Response (201 Created)

{
  "message": "Follow relationship created successfully."
}

Error Responses

Self-Follow Attempt (400 Bad Request)

{
  "error": "A user cannot follow themselves."
}

User Not Found (404 Not Found)

{
  "error": "One or both users involved in the follow do not exist."
}

Follow Already Exists (409 Conflict)

{
  "error": "Follow relationship already exists."
}

Server Error (500 Internal Server Error)

{
  "error": "Internal server error."
}

Notes

  • This endpoint requires authentication.
  • A user cannot follow themselves.
  • If a follow relationship already exists, the request will return a 409 Conflict error.
  • A notification is triggered for the followed user upon a successful follow.