メール既読/未読

    特定のメールを既読、または未読にします。

    注意

    • mailSNList パラメータで複数のメールを指定した際、一部のメールが存在しない場合でも成功 (200) が返ります。
    • status パラメータに read または unread 以外の値を指定した場合、全て unread で処理されます。

    API の種類

    サービス API

    Request URL

    https://apis.worksmobile.com/r/{API ID}/mail/v2/setReadStatus

    HTTP Method

    PUT(Content-Type: application/x-www-form-urlencoded; charset=UTF-8)

    Request

    パラメータ タイプ 必須 説明
    mailSNList String Y メールリスト。メールのシリアルナンバー(mailSN)をセミコロン(;)でつなげた値。
    例) 46554;46548;46550
    status String Y 既読/未読設定
    ● read: 既読
    ● unread: 未読

    Request Example

    https://apis.worksmobile.com/r/{API ID}/mail/v2/setReadStatus?mailSNList=123&status=read
    

    Response

    呼び出しに成功すると HTTP Status コード 200 のみを返します。レスポンス内容は含みません。

    Error

    呼び出しに失敗すると、HTTP Status と以下のエラー情報を返します。

    プロパティ タイプ 説明
    code String Error Code
    message String Error Message
    HTTP Status Error Code 説明
    400 INVALID_PARAMETER リクエスト値が不適切
    500 SYSTEM_ERROR 内部サーバーエラー
    Error Example
    {
        "code": "INVALID_PARAMETER",
        "domain": "mail",
        "message": "Invalid parameter, Please check mailSNList or status"
    }