excited.liveexcited.live
API reference

Settings

Profile settings.

Get settings

GET /api/v1/settings

Defaults (\{ profileName: "", gender: "female" }) for a user who never saved.

Responses

  • 200 — The settings. UserSettings
  • 401 — Missing or invalid credential (session token or API key; only when auth is configured). Error
curl "$API_URL/api/v1/settings" \
  -H "Authorization: Bearer $TOKEN"

Save settings

PUT /api/v1/settings

Echoes the request body; reads back normalised to the three stored columns.

Request body (application/json)

Type: UserSettings

Responses

  • 200 — Saved. object
  • 401 — Missing or invalid credential (session token or API key; only when auth is configured). Error
curl -X PUT "$API_URL/api/v1/settings" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

Schemas

UserSettings

Per-user profile settings.

FieldTypeRequiredDescription
profileNamestringyes
birthdaystringnoYYYY-MM-DD; absent (not null) when unset.
genderstringyes

Error

FieldTypeRequiredDescription
errorstringyes