Change Folder Name

    Changes a specified folder's name.

    Caution

    • The name of a system folder (whose folderSN is smaller than 100) cannot be changed.
    • To change a child folder’s name in a hierarchical structure, you should specify a new child folder name including the parent folder name. For example, if you want to change the name of ChildFolder in the following structure, you should set the request parameter, folderName to "ParentFolder/newChildFolder.”
      ParentFolder
       ChildFolder
      

    API Type

    Service API

    Request URL

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

    HTTP Method

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

    Request

    Parameter Type Required Description
    folderSN String Y Folder serial number
    folderName String Y New folder name.
    A folder name can be up to 20 characters in length; if it is longer than that, only the first 20 characters are stored.

    Request Example

    https://apis.worksmobile.com/r/{API ID}/mail/v2/modifyFolder?folderSN=1004&folderName=sample
    

    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
    403 SYSTEM_FOLDER System folder cannot be changed.
    404 NOT_EXIST_FOLDERSN FOLDERSN does not exist.
    409 DUPLICATE_FOLDERNAME The folder name already exists.
    500 SYSTEM_ERROR Internal server error
    Error Example
    {
        "code": "SYSTEM_FOLDER",
        "domain": "mail",
        "message": "System folders cannot be changed."
    }