Skip to main content
Bots are not allowed on the Settings API. Both GET /api/settings/get and POST /api/settings/set reject bot Authorization headers with 400 Not Authorized. To edit a bot’s profile (display name, avatar, description), use the bot management endpoints instead — see Bots API.
The Settings API gives you full control over your Clody profile and privacy preferences. Use GET /api/settings/get to read your current configuration, and POST /api/settings/set to update any combination of fields in a single request. You must be logged in with a verified email address to use either endpoint.

GET /api/settings/get

Returns your complete profile and settings object.

Response

200 OK:
string
Your unique login username. This value is read-only and cannot be changed via the Settings API.
string
Your public display name. Defaults to your username on registration.
string | null
URL of your current avatar image, or null if you haven’t set one.
string
Your profile bio (up to 300 characters). Empty string if not set.
string
Your current short status or quote (up to 100 characters). Empty string if not set.
string
Your accent color as a hex string (e.g. "#a78bfa"). Empty string if not set.
object
Your privacy and preference toggles.

Error codes


POST /api/settings/set

Updates any combination of your profile fields. All fields are optional — only the keys you include are modified. Fields you omit remain unchanged.
You can update multiple fields in a single request. There is no need to send unchanged fields; the server performs a partial update.

Request body

string
Your new public display name. Must be a non-empty string — if you send an empty string or omit this field, the display name is left unchanged.
string
Your profile bio. Maximum 300 characters. Send an empty string to clear it.
string
A short status message or quote shown on your profile. Maximum 100 characters. Send an empty string to clear it.
string
Your profile accent color. Must be a valid CSS hex color in #RGB (3-digit) or #RRGGBB (6-digit) format, e.g. "#a78bfa" or "#f0f". Send an empty string to clear it.
object
A settings object whose keys replace your stored settings. Currently supports:
  • accepts_friend_requests (boolean) — Set to false to make your profile private and block incoming friend requests. Set back to true to restore visibility.
You can also update a single field without touching the rest:

Response

200 OK"Success".

Error codes

Setting accepts_friend_requests to false immediately hides your profile from all users who are not already your friends. They will receive a 403 when calling POST /api/users/get with your username or ID.