Create friend request by username
Creates Friend Request By Username using the API key’s account.
POST
/api/v1/friends/request-by-usernamefriends: read_write1,000 requests/minute/key · all plansActive API keys: Free 1, Pro 5, Pro+ 5. The request rate is the same on every plan.
Parameters
No path or query parameters.
Request body
application/json · required
Unknown properties are rejected.
| Name | Type | Required | Description |
|---|---|---|---|
username | string | Required | Username. Minimum length: 1. Maximum length: 256. |
Response schema
201
Created.
| Name | Type | Required | Description |
|---|---|---|---|
friendUserId | string | Required | Friend User Id. |
username | string | Required | Username. |
Errors
400· JSON errorInvalid JSON body.
401· JSON errorMissing or invalid API key. Use Authorization: Bearer <token>.
403· JSON errorRequires friends: read_write; ownership or feature restrictions may also deny access.
404· JSON errorRequest failed (NOT_FOUND).
409· JSON errorRequest failed (CONFLICT).
429· JSON errorAPI rate limit exceeded (1000 requests per minute). Retry shortly.
Request example
Set FLORALITY_KEY in your environment. These examples use demo identifiers.
curl --request POST 'https://floralitys.com/api/v1/friends/request-by-username' \
--header "Authorization: Bearer $FLORALITY_KEY" \
--header "Content-Type: application/json" \
--data '{
"username": "River"
}'Responses
Created.
{
"friendUserId": "11111111-1111-4111-8111-111111111111",
"username": "River"
}Example values are illustrative demo data.