Start Email Migration

    Starts to migrate email messages of a specific account.

    Caution

    • Email messages of up to 20 accounts for each tenantId can be migrated at the same time.

    API Type

    Server API

    Request URL

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

    HTTP Method

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

    Request

    Parameter Type Required Description
    targetMemberEmail String Y Email address to save the EML file to

    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",
        "message": "Migration count exceeded.",
        "domain": "mail"
    }