Skip to main content
API reference sections

Schema

NewProfile

POST /v1/profiles.

Type object

Shape

FieldTypeDescription
namerequiredstring
localestring or null

BCP 47. Absent means undetermined - not English: the absence of an answer is not an answer.

It is the person's locale, not the language a client happens to be drawing in: a client with no Korean strings showing English to a ko-KR person still sends ko-KR, or the profile records something untrue and stays wrong on the day Korean arrives.

Default null

purposestring or null

Free text - "work", "school". Deliberately not an enum: it is theirs.

Default null

avatarstring or null

A token, <kind>:<value> - color:purple today, blob:<hash> when a person can upload a picture. Passed through unread.

Default null

iconstring or null

Default null

colorstring or null

Default null

Example
{
  "name": "string",
  "locale": "string",
  "purpose": "string",
  "avatar": "string",
  "icon": "string",
  "color": "string"
}

The contract has no example values, so example bodies are generated from each schema: every field is shown with a placeholder of its type.

Used by

Generated from contract version 1. Last updated .

Privacy choices

Choose which optional tools Koru may use on this site. Your choice is saved in a cookie in this browser for 12 months. Privacy policy

Privacy choices

Keep you signed in, protect forms and remember your language and this choice.

Always on

PostHog and Google Analytics 4 measure page views and actions such as downloads, using cookies or local storage.

PostHog records how pages are used, with form inputs masked and private pages excluded. Needs Analytics.

Ahrefs Web Analytics measures visits and where they come from, and Google Ads measures whether our ads led to a visit or download.