ユーザー属性の更新

POST リクエストを送信することで、ユーザー属性はいつでも変更できます。

curl -v -X POST \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "Content-Type: application/vnd.kii.UserUpdateRequest+json" \
  "https://api-jp.kii.com/api/apps/{APP_ID}/users/me" \
  -d '{"friends": 401, "age": 28}'

REST API でユーザー属性を更新する際は、既定フィールドとカスタムフィールドで動きが異なるため、注意が必要です。既存の既定フィールドを更新対象として指定しない場合はそのまま Kii Cloud 上に保持されますが、既存のカスタムフィールドを更新対象として指定しない場合は、そのフィールドは削除されます。

  • POST リクエストにて新規のキーと値のペアを指定した場合、このキーと値のペアが追加される
  • POST リクエストにて既存のフィールドのキーと値のペアを指定した場合、このキーと値のペアが上書きされる
  • POST リクエストにて既存のフィールドを指定しなかった場合は、このキーと値のペアが削除される

上の POST リクエストを例に取ると、リスエストで指定されていなかった "followers" と "status" は削除され、指定されていた既存フィールドの "friends" は新しい値に更新されます。また新たに指定された "age" フィールドがユーザー属性として追加されます。

ユーザー属性の更新が成功すると、Kii Cloud は次のようなレスポンスで更新時間(UNIX 時間、ミリ秒、UTC)を返します。

< HTTP/1.1 200 OK
< Server: Apache-Coyote/1.1
< Access-Control-Allow-Origin: *
< Content-Type: application/vnd.kii.UserDataRetrievalResponse+json
< Content-Length: 34
< Date: Tue, 26 Jun 2012 15:43:05 GMT
<
{
  "modifiedAt" : 1340725385432
}

ユーザー属性の変更は、基本的にログイン中のユーザー本人に対してのみ実行できます。詳しくは ユーザー属性 をご覧ください。

なお、認証がオンの状態でメールアドレスや電話番号を変更した場合は認証処理が実行されます。新たに設定したメールアドレスや電話番号によるログインは、この認証処理が完了するまで有効になりません。詳しくは メールアドレス認証 および 電話番号(SMS)認証 を参照してください。