Sign in

v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
Team Users

Add a team user

This function creates and adds a new team user.

Note:

This action may result in team users gaining access to team owner level privileges.

get/Team/add_team_user

Query parameters

email1string required
Example:teamuser@example.com

The contact email for the new team user.

userstring required
Example:teamuser

The username of the team user. Follows cPanel standards.

activation_emailinteger
Example:1

Send an email to the team user that allows them to set their own password.

  • 1 - Enabled.

Note:

  • You must pass either the password or activation_email parameter.
email2string
Example:teamuser-backup@example.com

The secondary email for the new team user.

integer
OR
string

The epoch time on which the team user account expires, or the offset from the current time, in days. Integers are treated as Unix Epoch Time unless followed by 'days'.

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. Maximum of 100 characters.

passwordstring
Example:securepassword

The password to set for the new team user.

Note:

  • You must pass either the password or activation_email parameter.
rolesstring
Example:email,database

A comma-separated list of roles assigned to the new team user. Current roles include admin, database, email, web.

Note:

  • This parameter is named roles, not role. This function rejects the role parameter with an error.
  • A team user with no roles cannot use any features. To assign roles after you create the team user, use the set_roles or add_roles functions.
services.email.enabled0 | 1
Example:1

Whether to create 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 an email subaccount.
  • 0 - Do Not create an email subaccount.
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 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 an FTP subaccount.
  • 0 - Do Not create an FTP subaccount.
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 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 a Web Disk subaccount.
  • 0 - Do Not create a Web Disk subaccount.
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).

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": "add_team_user",
  "module": "Team",
  "result": {
    "data": 1674575562,
    "metadata": {
      "transformed": 1
    },
    "status": 1
  }
}