API Explorer

Test and explore the Chars.gg API endpoints

Send friend request

Send a friend request to another user

Endpoint Details

Send friend request

POST /v1/users/{id}/friend-request

Path Parameters

The UUID of the entity

Headers

Request Body

Response Examples

201 - Friend request sent successfully
Schema: {
  "$ref": "#/components/schemas/FriendshipDto"
}
400 - Invalid request
Schema: {
  "$ref": "#/components/schemas/ValidationErrorResponseDto"
}
401 - Authentication required
Schema: {
  "$ref": "#/components/schemas/ValidationErrorResponseDto"
}
404 - User not found
Schema: {
  "$ref": "#/components/schemas/EntityNodeFoundResponseDto"
}
409 - Friendship already exists or request already sent
Schema: {
  "$ref": "#/components/schemas/ConflictErrorResponseDto"
}