Sign in

v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
Team Users

Edit a team user

This function modifies a team user.

get/Team/edit_team_user

Query parameters

userstring required
Example:teamUser

The username of the team user.

add_rolestring
Example:database

The role or roles to add to the team user.

email1string
Example:teamuser@example.com

The primary contact email address to set for the team user.

email2string
Example:teamuser@example.com

The secondary contact email address to set for the team user.

expire_reasonstring
Example:teamUser gave a two week notice.

The reason for expiration.

notesstring
Example:This is a note about teamUser

Notes about the new team user. This field should not contain private information.

passwordstring
Example:securepassword

The password to set for the team user.

remove_rolestring
Example:database

The role or roles to remove from the team user.

services.email.enabled0 | 1
Example:1

Whether to create or remove an email subaccount for the team user. A subaccount is always created for a team user, but it does not have any associated service subaccounts by default.

  • 1 - Create and associate an email subaccount.
  • 0 - Remove any associated email subaccounts.
services.email.quotastring
Example:500

The maximum amount of disk space, in megabytes (MB), allocated to the team user's email account.

  • 0 or unlimited - The subaccount has unlimited disk space.

This value defaults to the defined system value.

Note:

This value cannot be larger than the system's maximum email quota.

services.ftp.enabled0 | 1
Example:1

Whether to create or remove an FTP subaccount for the team user. A subaccount is always created for a team user, but it does not have any associated service subaccounts by default.

  • 1 - Create and associate an FTP subaccount.
  • 0 - Remove any associated FTP subaccounts.
services.ftp.homedirstring path
Example:/Teamusername

The team user's FTP home directory, relative to the cPanel account's home directory.

Note:

  • This parameter is required if you enabled the services.ftp.homedir parameter.
  • The directory must exist.
services.webdisk.enabled0 | 1
Example:1

Whether to create or remove a Web Disk subaccount for the team user. A subaccount is always created for a team user, but it does not have any associated service subaccounts by default.

  • 1 - Create and associate a Web Disk subaccount.
  • 0 - Remove any associated Web Disk subaccounts.
services.webdisk.enabledigest0 | 1

Whether to enable the Web Disk Digest Authentication.

  • 1 - Enabled.
  • 0 - Disabled.

Note:

  • Only enable Digest Authentication for clients that require additional compatibility support on certain versions of Windows® operating systems. This compatibility support is only required on servers that use a self-signed certificate for the cpsrvd and cpdavd daemons.
  • We recommend that you do not use Digest Authentication.
services.webdisk.homedirstring path
Example:/Teamusername

The team user's Web Disk home directory, relative to the cPanel account's home directory.

Note:

This parameter is required if you enable the services.webdisk.enabled parameter.

services.webdisk.permsstring
Example:rw

The team user's file permissions for its Web Disk home directory.

  • ro - Read-only permissions.
  • rw - Read and write permissions.

Note:

The services.webdisk.homedir parameter determines the team user's Web Disk home directory.

services.webdisk.private0 | 1
Example:1

Whether to set the directory's permissions to public or private.

  • 1 - Private (0700).
  • 0 - Public (0755).
integer
OR
string

The epoch time the team user account expires on or the offset in days.

set_rolestring
Example:email

The role or roles to set for the team user.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "edit_team_user",
  "module": "Team",
  "result": {
    "metadata": {
      "transformed": 1
    },
    "status": 1
  }
}