Choose or change your username

The first time, this also creates your personal org with the same name. Renames are limited to once every 30 days; the old name redirects.

PUT /me/username

Choose or change your username

cURL

curl --request PUT \
  --url https://patch.gg/api/v1/me/username \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "username": "<string>"
}
'

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "email": "<string>",
  "username": "<string>",
  "birthdate": "<string>",
  "role": "user",
  "orgs": [
    {
      "slug": "<string>",
      "name": "<string>",
      "kind": "personal",
      "role": "<string>"
    }
  ],
  "auth": {
    "via": "session",
    "scopes": [
      "read"
    ]
  }
}

Authorizations

Authorization · string · header · required

An API key (pch_...) or the token from pch login.

Body

application/json

username · string · required

Required string length: 1 - 64

Response

200

application/json

Updated

id · string<uuid> · required

name · string · required

email · string · required

username · string | null · required

birthdate · string | null · required

YYYY-MM-DD, once given; only you see it

role · enum<string> · required

Available options: user, staff

orgs · object[] · required

Show child attributes

auth · object · required

Show child attributes