Get Folder Name

    Gets a specified folder's name.

    Caution

    • If the specified folderSN does not exist, the API request returns success with empty folderName.

    API Type

    Service API

    Request URL

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

    HTTP Method

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

    Request

    Parameter Type Required Description
    folderSN String Y Folder serial number

    Request Example

    https://apis.worksmobile.com/r/{API ID}/mail/v2/getFolder?folderSN=0
    

    Response

    It returns HTTP status 200 with response data in JSON format if the API call is successful.

    Property Type Required Description
    folderName String Y Folder name.
    folderSN String Y Folder serial number

    Response Example

    {"folderName":"Inbox","folderSN":0}
    

    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",
        "message": "Invalid parameter, Please check folderSN",
        "domain": "mail"
    }