API

ユーザー名を選ぶ

その人のユーザー名と、それに伴う無料アドレスを確定する。

PUTapi.openemail.uk/account/username

実際の呼び出しをワークスペースに対して実行します。

PUT /account/username

その人のユーザー名と、それに伴う無料アドレスを確定する。

account:write が必要。username は、小文字にして空白をドットに変えたあとで、小文字、数字、連続しないドットからなる 3 文字以上 30 文字以下でなければならない。確定したユーザー名を返す。

curl

curl -X PUT "$OE/account/username" -H "$AUTH" -H "Content-Type: application/json" \  -d '{ "username": "ada.lovelace" }'

レスポンス

{  "object": "username",  "username": "ada.lovelace",  "chosen": true,  "address": "[email protected]"}

一度選ぶと二度と変わらないため、2 回目の選択は 409 username_locked になる。先に GET /account/username/availability で確認する。

別のアカウントが使っているユーザー名は 409 username_taken になる。短すぎる、長すぎる、予約済み、または上の形式で書かれていないものは username に対する 422 invalid_parameter になり、メッセージでどれに当たるかが示される。