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

    Change Folder Name

    Changes a specified folder's name.

    API Type

    Service API

    Request URL

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

    HTTP Method

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

    Request

    Parameter Type Required Description
    folderSN String Y Folder serial number
    folderName String Y Folder name to change

    Request Example

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

    Response

    It returns the value of the "data" property which contains the results when the API call succeeds.

    Property 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 A serial number of the folder whose name is changed.

    Response Example

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

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

    Error Code Error Message Description
    500 FOLDER_EXCEED_MAX_COUNT The maximum number of folders exceeded.
    999 SYSTEM_ERROR Internal error