Create social link
Creates Social Link using the API key’s account.
POST
/api/v1/social/linkssocial: 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
| Name | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Optional | Unique identifier. |
platform | string | Required | Platform. Allowed values: "discord", "tiktok", "instagram", "x", "bluesky", "youtube", "twitch", "steam", "xbox", "playstation", "nintendo", "github", "reddit", "pinterest", "roblox", "vrchat", "anilist", "myanimelist", "letterboxd", "spotify", "custom". |
displayName | string | Required | Display name. Minimum length: 1. Maximum length: 120. |
handle | string | null | Optional | Handle. Maximum length: 120. |
url | string (uri) | null | Optional | Url. |
description | string | null | Optional | Description of the resource. Maximum length: 280. |
badge | string | null | Optional | Badge. Maximum length: 32. |
accentColor | string | null | Optional | Accent Color. Maximum length: 32. |
avatarUrl | string (uri) | null | Optional | Resolved avatar URL, or null when unavailable. Maximum length: 2048. |
visibility | string | Required | Visibility. Allowed values: "public", "logged_in", "friends_only", "mutuals_only", "private". |
featured | boolean | Optional | Featured. Default: false. |
sortOrder | integer | Optional | Sort Order. Minimum: 0. Maximum: 2147483647. |
Response schema
201
Created.
| Name | Type | Required | Description |
|---|---|---|---|
linkId | string | Required | Link Id. |
Errors
400· JSON errorInvalid JSON body.
401· JSON errorMissing or invalid API key. Use Authorization: Bearer <token>.
403· JSON errorRequires social: 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.
503· JSON errorPostgreSQL is not configured (DATABASE_URL).
Request example
Set FLORALITY_KEY in your environment. These examples use demo identifiers.
curl --request POST 'https://floralitys.com/api/v1/social/links' \
--header "Authorization: Bearer $FLORALITY_KEY" \
--header "Content-Type: application/json" \
--data '{
"platform": "discord",
"displayName": "River",
"visibility": "public"
}'Responses
Created.
{
"linkId": "11111111-1111-4111-8111-111111111111"
}Example values are illustrative demo data.