プロフィール写真アップロード

    メンバーのプロフィール写真をアップロードします。

    APIの種類

    サーバーAPI

    Request URL

    • サービス: https://apis.worksmobile.com/r/{API ID}/organization/v2/domains/{domainId}/users/{externalKey}/photo
    • テスト: https://sandbox-apis.worksmobile.com/r/{API ID}/organization/v2/domains/{domainId}/users/{externalKey}/photo

    HTTP Method

    POST

    Path Parameters

    パラメーター タイプ 上限 必須 説明
    domainId Integer Y ドメイン ID
    externalKey String 100 字 Y メンバーの External Key

    Request Parameters

    パラメーター タイプ 上限 必須 説明
    photo String 写真データー (Base64 Url Safe Encoding)。
    JPG/PNG 形式。
    このパラメーター空の値の場合、該当メンバーのプロフィール写真を削除します。

    Request Example

    POST https://apis.worksmobile.com/r/apiid/organization/v2/domains/123/users/EX123/photo
    
    {
        "photo": "Base64 url Safe Encoding photo data"
    }
    

    Response

    API 呼び出しに成功すると HTTP 200 コードを返します。

    Error code

    呼び出しに失敗するとエラーコードとエラーメッセージを返します。
    エラーコードは組織連携REST APIエラーコードを参照してください。