This API will soon be deprecated. Please use another API.

    Display Read/Unread Messages

    Displays the specific message as read or unread.

    API Type

    Service API

    Request URL

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

    HTTP Method

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

    Request

    Parameter Type Required Description
    mailSNList String Y A value that contains a list of serial numbers for messages to be marked as read/unread; each number is separated by a semicolon (;).
    In Thread View, "c" should be added before the serial number upon request if the "threadCount" value is greater than 1.
    Example) 46554;46548;c46550
    status String Y Indicates whether a message has been read or not.
    ● read: Read
    ● unread: Not read

    Request Example

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

    Response

    It indicates whether the request was successful or not, and returns the "data" value having an empty string.

    Parameter Type Required Description
    message String Y Indicates whether successful or not
    ● Success: "success"
    ● Failure: Error code
    code String Y Code that indicates whether successful or not.
    ● Success: "000"
    ● Failure: Any integer excluding "000"
    data Integer N null

    Response Example

    {"message":"success","data":"","code":"000"}
    

    It returns an error code and message when the API call fails (refer to Response Common).

    Error Code Error Message Description
    100 mailSNList or status parameter is null The value of mailSNList or status does not exist.
    999 SYSTEM_ERROR Internal error