How to edit an FTP account's Path using the API

Question

How can I edit the "Path" of an FTP account?

Environment

• All cPanel & WHM versions.
• cPanel Interface

Resolution

• The Path of an FTP account can be changed using the UAPI
• The UAPI command is:

  uapi --user=$cpanel_username Ftp set_homedir user='$ftp_account_username' homedir=$new_directory/

   

• For Example:

  uapi --user=cptechs Ftp set_homedir user='ftptest1@cptechs.tld' homedir=testingdirectory/

  
  Please note, the new "homedir" is relative to your cPanel account's home directory. Please be sure to use relative paths instead of full paths for this command.

Additional Resources

cPanel API Documentation - Update FTP account's home directory