Mark Messages as Read/Unread

    Marks the specified messages as read or unread.

    Caution

    • The mailSNList parameter can have multiple serial numbers (mailSN) with a semicolon (;) as a delimiter. The API request returns success even if some of the specified mailSNs do not exist.
    • The status parameter can only have “read” or “unread”; values other than these two will be ignored and “unmark” will be used instead.

    API Type

    Service 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

    Parameter Type Required Description
    mailSNList String Y Serial numbers (mailSN) of the messages to mark as read or unread, using a semicolon (;) as a delimiter.
    Example) 46554;46548;46550
    status String Y Indicates whether to mark a message as read.
    ● read: Read
    ● unread: Unread

    Request Example

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

    Response

    It returns HTTP status 200 with no response when the API call is successful.

    Error

    It returns an error code and message with HTTP status when the API call fails.

    Property Type Description
    code String Error code
    message String Error message
    HTTP status Error code Description
    400 INVALID_PARAMETER Invalid request parameters
    500 SYSTEM_ERROR Internal server error
    Error Example
    {
        "code": "INVALID_PARAMETER",
        "domain": "mail",
        "message": "Invalid parameter, Please check mailSNList or status"
    }